neuraxle.logging.warnings

Module-level documentation for neuraxle.logging.warnings. Here is an inheritance diagram, including dependencies to other base modules of Neuraxle:

Inheritance diagram of neuraxle.logging.warnings

Neuraxle’s Deprecation Warnings

Code evolves through time. When updating Neuraxle, you may find that some old arguments you were using or some classes you were using changed. Warnings will be printed using the methods here.

Functions

raise_deprecated_class(replacement_class, …)

silence_all_deprecation_warnings()

Turn off all of the neuraxle.logging.warnings for deprecations.

warn_deprecated_arg(self, arg_name, …)

warn_deprecated_class(self, …)

Classes

RaiseDeprecatedClass(replacement_class, …)

Use this class and call it’s __init__ method to raise a DeprecationWarning and point to the good class to use.


neuraxle.logging.warnings.silence_all_deprecation_warnings()[source]

Turn off all of the neuraxle.logging.warnings for deprecations.

neuraxle.logging.warnings.warn_deprecated_class(self, replacement_class: type = None, as_per_version: str = None)[source]
class neuraxle.logging.warnings.RaiseDeprecatedClass(replacement_class: type = None, since_version: str = None)[source]

Bases: object

Use this class and call it’s __init__ method to raise a DeprecationWarning and point to the good class to use.

__init__(replacement_class: type = None, since_version: str = None) → None[source]

Initialize self. See help(type(self)) for accurate signature.

neuraxle.logging.warnings.raise_deprecated_class(replacement_class: type = None, since_version: str = None)[source]
neuraxle.logging.warnings._deprecated_class_msg(self, replacement_class: type = None, since_version: str = None) → str[source]
neuraxle.logging.warnings.warn_deprecated_arg(self, arg_name, default_value, value, replacement_argument_name, replacement_class: type = None)[source]
neuraxle.logging.warnings._deact_msg_instructions() → str[source]