Reference

Top-level package for envi.

envi.get(name, cast, required=True, default=None, validate=<function <lambda>>, **kwargs)

Get name from env.

Parameters:

• name (str) – The variable name
• cast (callable) – The function who cast the variable
• required (bool) – Default True
• default (any) – if required default is ignored
• validate (callable) – The function who validates the variable

Returns:

variable

Return type:

same as cast return

Raises:

• ValueError – if cast is not a callable
• AttributeError – if required and name are both undefined

envi.mk_shortcut(cast)

ciao.

envi.get_bool(name, is_ok=None, **kwargs)

Get bool from env.

Parameters:

• name (str) – The variable name
• is_ok (list(str)) – truthy string list
• kwargs – see get()

Returns:

variable

Return type:

bool

envi.get_str(name, *, cast=<class 'str'>, required=True, default=None, validate=<function <lambda>>, **kwargs)

Get str from env.

Parameters:

• name (str) – The variable name
• kwargs – see get()

Returns:

variable

Return type:

str

envi.get_int(name, *, cast=<class 'int'>, required=True, default=None, validate=<function <lambda>>, **kwargs)

Get int from env.

Parameters:

• name (str) – The variable name
• kwargs – see get()

Returns:

variable

Return type:

int

envi.get_float(name, *, cast=<class 'float'>, required=True, default=None, validate=<function <lambda>>, **kwargs)

Get float from env.

Parameters:

• name (str) – The variable name
• kwargs – see get()

Returns:

variable

Return type:

float

class envi.manager.EnviType(extractor, cast, required, default, validate, is_ok=None)

Used to configure a subclass of EnviManager, defines how an environment variable should be retrieved, casted and validated.

__init__(extractor, cast, required, default, validate, is_ok=None)

Initializer :param callable extractor: function to be used to extract the variable from the environment. It should be one of the functions defined in envi. :param callable cast: casting function, see envi.get() :param bool required: required flag, see envi.get() :param any default: default value, see envi.get() :param callable validate: validating function, see envi.get() :param list(str) is_ok: truthy string list, see envi.get_bool()

classmethod bool(is_ok=None, required=True, default=None, validate=<function EnviType.<lambda>>)

Utility initializer for boolean environmental variables.

Parameters:

• is_ok (list(str)) – is_ok: truthy string list, see envi.get_bool()
• required (bool) – required flag, see envi.get()
• default (any) – default value, see envi.get()
• validate (callable) – validating function, see envi.get()

Returns:

An EnviType instance describing how to retrieve the environment variable

Return type:

EnviType

classmethod float(required=True, default=None, validate=<function EnviType.<lambda>>)

Utility initializer for float environmental variables.

Parameters:

• required (bool) – required flag, see envi.get()
• default (any) – default value, see envi.get()
• validate (callable) – validating function, see envi.get()

Returns:

An EnviType instance describing how to retrieve the environment variable

Return type:

EnviType

classmethod generic(cast, required=True, default=None, validate=<function EnviType.<lambda>>)

Utility initializer for generic environment variable types, needs the casting function to be specified

Parameters:

• cast (callable) – casting function, see envi.get()
• required (bool) – required flag, see envi.get()
• default (any) – default value, see envi.get()
• validate (callable) – validating function, see envi.get()

Returns:

An EnviType instance describing how to retrieve the environment variable

Return type:

EnviType

classmethod integer(required=True, default=None, validate=<function EnviType.<lambda>>)

Utility initializer for int environmental variables.

Parameters:

• required (bool) – required flag, see envi.get()
• default (any) – default value, see envi.get()
• validate (callable) – validating function, see envi.get()

Returns:

An EnviType instance describing how to retrieve the environment variable

Return type:

EnviType

classmethod string(required=True, default=None, validate=<function EnviType.<lambda>>)

Utility initializer for string environmental variables.

Parameters:

• required (bool) – required flag, see envi.get()
• default (any) – default value, see envi.get()
• validate (callable) – validating function, see envi.get()

Returns:

An EnviType instance describing how to retrieve the environment variable

Return type:

EnviType

class envi.manager.EnviManager

Singleton class that will retrieve and hold the values of environment variables when EnviManager.configure() is called. The environment variable names should be declared as class attributes of type EnviType.

classmethod configure()

Should be called before trying to retrieve the value of environment variables. It will instantiate the singleton instance, and for every class attribute of type EnviType it will extract the environment variable with the name of the attribute itself, and the value retrieved will be stored as attribute in the singleton instance.

Raises:EnviAlreadyConfigured – if called multiple times on the same class.