skshapes.input_validation.notnone_rules.generator_notnone_rule

skshapes.input_validation.notnone_rules.generator_notnone_rule(rule)

Not-None rules decorator generator.

A not-None rule decorator decorates functions that have a number of keywords arguments that are None by default and that must be provided within certain rules (for example, one and only one of these arguments must be specified)

Parameters:

rule – A function with the number of not none keywords arguments from a list that raises an error if this number does not satisfies certain condition

Returns:

A decorator that can be parametrized with a list of parameters and a boolean arguments to determine if typecheck must be applied

Return type:

Callable