skcriteria.utils.decorators
module¶
Multiple decorator to use inside scikit-criteria.
- skcriteria.utils.decorators.doc_inherit(parent, warn_class=True)[source]¶
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
Notes
This decorator is a thin layer over
custom_inherit.doc_inherit decorator()
.Check: <github https://github.com/rsokl/custom_inherit>__
- exception skcriteria.utils.decorators.SKCriteriaDeprecationWarning[source]¶
Bases:
DeprecationWarning
Skcriteria deprecation warning.
- skcriteria.utils.decorators.deprecated(*, reason, version)[source]¶
Mark functions, classes and methods as deprecated.
It will result in a warning being emitted when the object is called, and the “deprecated” directive was added to the docstring.
- Parameters
reason (str) – Reason message which documents the deprecation in your library.
version (str) – Version of your project which deprecates this feature. If you follow the Semantic Versioning, the version number has the format “MAJOR.MINOR.PATCH”.
Notes
This decorator is a thin layer over
deprecated.deprecated()
.Check: <github https://pypi.org/project/Deprecated/>__