feets.libs package

Submodules

feets.libs.bunch module

Container object exposing keys as attributes.

class feets.libs.bunch.Bunch(name, data)

Bases: Mapping

Container object exposing keys as attributes.

Concept based on the sklearn.utils.Bunch.

Bunch objects are sometimes used as an output for functions and methods. They extend dictionaries by enabling values to be accessed by key, bunch[“value_key”], or by an attribute, bunch.value_key.

Examples

>>> b = SKCBunch("data", {"a": 1, "b": 2})
>>> b
data({a, b})
>>> b['b']
2
>>> b.b
2
>>> b.a = 3
>>> b['a']
3
>>> b.c = 6
>>> b['c']
6

feets.libs.doctools module

Multiple decorator to use inside scikit-criteria.

feets.libs.doctools.doc_inherit(parent, warn_class=True)

Inherit the ‘parent’ docstring.

Returns a function/method decorator that, given parent, updates the docstring of the decorated function/method based on the numpy style and the corresponding attribute of parent.

Parameters:

parentUnion[str, Any]

The docstring, or object of which the docstring is utilized as the parent docstring during the docstring merge.

warn_classbool

If it is true, and the decorated is a class, it throws a warning since there are some issues with inheritance of documentation in classes.

Notes

This decorator is a thin layer over custom_inherit.doc_inherit decorator().

Check: <github https://github.com/rsokl/custom_inherit>__

Module contents

External libs.