xenonpy.utils package

Subpackages

• xenonpy.utils.math package
  • Submodules
  • xenonpy.utils.math.product module
    • Product
  • Module contents

Submodules

xenonpy.utils.parameter_gen module

class xenonpy.utils.parameter_gen.ParameterGenerator(seed=None, **kwargs)

Bases: object

Generator for parameter set generating.

Parameters:

• seed (Optional[int]) – Numpy random seed.

• kwargs (Union[Any, Sequence, Callable, Dict]) – Parameter candidate.

__call__(num, *, factory=None)

Call self as a function.

xenonpy.utils.useful_cls module

class xenonpy.utils.useful_cls.Singleton

Bases: type

__call__(*args, **kwargs)

Call self as a function.

class xenonpy.utils.useful_cls.Switch(value)

Bases: object

match(*args)

Indicate whether or not to enter a case suite

class xenonpy.utils.useful_cls.TimedMetaClass(name, bases, attrs)

Bases: type

This metaclass replaces each methods of its classes with a new function that is timed

class xenonpy.utils.useful_cls.Timer(time_func=<built-in function perf_counter>)

Bases: object

start(fn_name='main')

stop(fn_name='main')

property elapsed

xenonpy.utils.useful_func module

xenonpy.utils.useful_func.absolute_path(path, ignore_err=True)

Resolve path when path include ~, parent/here.

Parameters:

• path (str) – Path to expand.

• ignore_err (bool) – FileNotFoundError is raised when set to False. When True, the path will be created.

Returns:

Expanded path.

Return type:

str

xenonpy.utils.useful_func.camel_to_snake(text)

xenonpy.utils.useful_func.config(key=None, **key_vals)

Return config value with key or all config.

Parameters:

• key (str) – Keys of config item.

• key_vals (dict) – Set item’s value by key.

Returns:

The value corresponding to the key.

Return type:

str

xenonpy.utils.useful_func.get_data_loc(name)

Return user data location

xenonpy.utils.useful_func.get_dataset_url(name, version='0.1.3')

Return url with the given file name.

Parameters:

• name (str) – binary file name.

• version (str) – The version of repository. See Also: https://github.com/yoshida-lab/dataset/releases

Returns:

binary file url.

Return type:

str

xenonpy.utils.useful_func.get_sha256(fname)

Calculate file’s sha256 value

Parameters:

fname (str) – File name.

Returns:

sha256 value.

Return type:

str

xenonpy.utils.useful_func.set_env(**kwargs)

Set temp environment variable with with statement.

Examples

>>> import os
>>> with set_env(test='test env'):
>>>    print(os.getenv('test'))
test env
>>> print(os.getenv('test'))
None

Parameters:

kwargs (dict[str]) – Dict with string value.

Module contents