pywrangler.util package

Subpackages

• pywrangler.util.testing package
  • Submodules
  • pywrangler.util.testing.datatestcase module
  • pywrangler.util.testing.mutants module
  • pywrangler.util.testing.plainframe module
  • pywrangler.util.testing.util module
  • Module contents

Submodules

pywrangler.util.dependencies module

This module contains functionality to check optional and mandatory imports. It aims to provide useful error messages if optional dependencies are missing.

pywrangler.util.dependencies.is_available(*deps) → bool

Check if given dependencies are available.

Parameters:deps (list) – List of dependencies to check. Returns:available Return type:bool

pywrangler.util.dependencies.raise_if_missing(import_name)

Checks for available import and raises with more detailed error message if not given.

Parameters:import_name (str) –

pywrangler.util.dependencies.requires(*deps) → Callable

Decorator for callables to ensure that required dependencies are met. Provides more useful error message if dependency is missing.

Parameters:deps (list) – List of dependencies to check. Returns:decorated Return type:callable

Examples

>>> @requires("dep1", "dep2")
>>> def func(a):
>>>     return a

pywrangler.util.helper module

This module contains commonly used helper functions or classes.

pywrangler.util.helper.get_param_names(func: Callable, ignore: Optional[Iterable[str]] = None) → List[str]

Retrieve all parameter names for given function.

Parameters:

• func (Callable) – Function for which parameter names should be retrieved.
• ignore (iterable, None, optional) – Parameter names to be ignored. For example, self for __init__ functions.

Returns:

param_names – List of parameter names.

Return type:

list

pywrangler.util.sanitizer module

This module contains common helper functions for sanity checks and conversions.

pywrangler.util.sanitizer.ensure_iterable(values: Any, seq_type: Type[CT_co] = <class 'list'>, retain_none: bool = False) → Union[List[Any], Tuple[Any], None]

For convenience, some parameters may accept a single value (string for a column name) or multiple values (list of strings for column names). Other functions always require a list or tuple of strings. Hence, this function ensures that the output is always an iterable of given constructor type (list or tuple) while taking care of exceptions like strings.

Parameters:

• values (Any) – Input values to be converted to tuples.
• seq_type (type) – Define return container type.
• retain_none (bool, optional) – Define behaviour if None is passed. If True, returns None. If False, returns empty

Returns:

iterable

Return type:

seq_type

pywrangler.util.types module

This module contains type definitions.

Module contents