pyunitwizard.configure package#

Submodules#

pyunitwizard.configure.configure module#

pyunitwizard.configure.configure.add_constant(constant_name, value, unit)[source]#

Register a runtime constant.

Parameters:

  • constant_name (str) – Constant identifier.

  • value (float or int) – Numeric constant value.

  • unit (str) – Unit associated with the constant value.

Returns:

Constant mapping is updated in global constants registry.

Return type:

None

pyunitwizard.configure.configure.get_default_form()[source]#

Return the configured default form for quantities and units.

Returns:

Default runtime form.

Return type:

str

Examples

>>> import pyunitwizard as puw
>>> puw.configure.get_default_form()
pyunitwizard.configure.configure.get_default_parser()[source]#

Return the configured default parser.

Returns:

Default parser identifier.

Return type:

str

Examples

>>> import pyunitwizard as puw
>>> puw.configure.get_default_parser()
pyunitwizard.configure.configure.get_libraries_loaded()[source]#

Return currently loaded backend libraries.

Returns:

Loaded library identifiers.

Return type:

list of str

Examples

>>> import pyunitwizard as puw
>>> puw.configure.get_libraries_loaded()
pyunitwizard.configure.configure.get_libraries_supported()[source]#

Return backend libraries supported by this installation.

Returns:

Supported library identifiers.

Return type:

list of str

Examples

>>> import pyunitwizard as puw
>>> puw.configure.get_libraries_supported()
pyunitwizard.configure.configure.get_parsers_loaded()[source]#

Return currently loaded parsers.

Returns:

Loaded parser identifiers.

Return type:

list of str

Examples

>>> import pyunitwizard as puw
>>> puw.configure.get_parsers_loaded()
pyunitwizard.configure.configure.get_parsers_supported()[source]#

Return parser backends supported by this installation.

Returns:

Supported parser identifiers.

Return type:

list of str

Examples

>>> import pyunitwizard as puw
>>> puw.configure.get_parsers_supported()
pyunitwizard.configure.configure.get_standard_units()[source]#

Return configured standard units mapped to dimensionality definitions.

Returns:

Dictionary keyed by standard unit string with dimensionality mappings.

Return type:

dict

Examples

>>> import pyunitwizard as puw
>>> puw.configure.get_standard_units()
pyunitwizard.configure.configure.load_library(library_names)[source]#

Load one or more backend libraries into runtime configuration.

Parameters:

library_names (str or list of str) – Library name or list of library names to load.

Returns:

Loaded libraries are registered in global runtime state.

Return type:

None

Raises:

TypeError – If library_names is not a string or a list/tuple of strings.

pyunitwizard.configure.configure.reset()[source]#

Reset runtime configuration state to defaults.

Returns:

This function mutates global runtime configuration in place.

Return type:

None

Examples

>>> import pyunitwizard as puw
>>> puw.configure.reset()
pyunitwizard.configure.configure.resolve_config_module(config=None, root_package=None, env_var='PYUNITWIZARD_CONFIG')[source]#

Resolve configuration module using runtime > env > file precedence.

Parameters:

  • config (str, optional) – Explicit runtime configuration module path.

  • root_package (str, optional) – Root package name used to probe <root_package>._pyunitwizard.

  • env_var (str, default="PYUNITWIZARD_CONFIG") – Environment variable name used for config-module discovery.

Returns:

Resolved module path, or None when no candidate is found.

Return type:

str or None

pyunitwizard.configure.configure.set_default_form(form)[source]#

Set the default form for quantities and units.

Parameters:

form (str) – New default form identifier.

Returns:

Runtime default form is updated in place.

Return type:

None

pyunitwizard.configure.configure.set_default_parser(parser)[source]#

Set the default parser for string quantities.

Parameters:

parser (str) – New default parser identifier.

Returns:

Runtime default parser is updated in place.

Return type:

None

pyunitwizard.configure.configure.set_standard_units(standard_units)[source]#

Configure project standard units used by standardization helpers.

Parameters:

standard_units (list of str) – Standard unit names used as normalization references.

Returns:

Runtime standard-unit maps are rebuilt in place.

Return type:

None

Raises:

ValueError – If standard_units is neither a string nor list/tuple.

Module contents#