uds.utilities.custom_warnings

Custom warnings that are used within the project.

Module Contents

exception uds.utilities.custom_warnings.UnusedArgumentWarning[source]

Bases: Warning

Inheritance diagram of uds.utilities.custom_warnings.UnusedArgumentWarning

At least one argument (that was provided by user) will be ignored.

It is meant to be used in less strict situation than UnusedArgumentError.

Example:

A function takes two parameters: a, b

Let’s assume that parameter a must always be provided. Parameter b is used only when a == 1.

The function would warn (using this warning) when both parameters are provided but a != 1.

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

exception uds.utilities.custom_warnings.ValueWarning[source]

Bases: Warning

Inheritance diagram of uds.utilities.custom_warnings.ValueWarning

Value of the argument is out of typical range, but the package is able to handle it.

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