gapnet.typing_tools.annotation_checkers.ValueRange

class documentation

class ValueRange(AnnotatedTypeChecker): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method check Takes any argument and raises a ValueError if it doesn't check out
Instance Variable max_inclusive Whether to include max_value as valid value or not
Instance Variable max_value Maximum allowed value. If None, maximum isn't checked
Instance Variable min_inclusive Whether to include min_value as valid value or not
Instance Variable min_value Minimum allowed value. If None, minimum isn't checked
Method _range_error_string Undocumented
def __init__(self, min_value=None, max_value=None, min_inclusive=True, max_inclusive=True): (source)

Undocumented

Parameters
min_valueUndocumented
max_valueUndocumented
min_inclusive:boolUndocumented
max_inclusive:boolUndocumented
def check(self, arg): (source)
overrides gapnet.typing_tools.annotation_checkers.AnnotatedTypeChecker.check

Takes any argument and raises a ValueError if it doesn't check out

max_inclusive = (source)

Whether to include max_value as valid value or not

max_value = (source)

Maximum allowed value. If None, maximum isn't checked

min_inclusive = (source)

Whether to include min_value as valid value or not

min_value = (source)

Minimum allowed value. If None, minimum isn't checked

def _range_error_string(self, arg): (source)

Undocumented