Skip to content

Validators

Module for attribute validation using descriptor classes.

This module provides an abstract base class Validator for creating attribute validators that can be used as descriptors. It also includes a concrete implementation, Number, which validates that a given value is a number (int or float) and optionally enforces minimum and/or maximum limits.

Gains

Example class using the Number validator to validate gain values.

The attribute 'kp' is validated to ensure it is a number between 0 and 100.

Source code in opensourceleg/extras/collections/validators.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class Gains:
    """
    Example class using the Number validator to validate gain values.

    The attribute 'kp' is validated to ensure it is a number between 0 and 100.
    """

    kp = Number(0, 100)

    def __init__(self, kp_value: int) -> None:
        """
        Initialize the Gains instance.

        Args:
            kp_value (int): The gain value to be validated and assigned to 'kp'.
        """
        self.kp = kp_value

__init__(kp_value)

Initialize the Gains instance.

Parameters:

Name Type Description Default
kp_value int

The gain value to be validated and assigned to 'kp'.

 required
Source code in opensourceleg/extras/collections/validators.py 
141
142
143
144
145
146
147
148
def __init__(self, kp_value: int) -> None:
    """
    Initialize the Gains instance.

    Args:
        kp_value (int): The gain value to be validated and assigned to 'kp'.
    """
    self.kp = kp_value

Number

Bases: Validator

Validator for numerical values.

Ensures that the value is an integer or a float and optionally enforces a minimum and/or maximum limit.

Source code in opensourceleg/extras/collections/validators.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class Number(Validator):
    """
    Validator for numerical values.

    Ensures that the value is an integer or a float and optionally enforces a minimum
    and/or maximum limit.
    """

    def __init__(
        self,
        min_value: Optional[Union[int, float]] = None,
        max_value: Optional[Union[int, float]] = None,
    ) -> None:
        """
        Initialize the Number validator.

        Args:
            min_value (Optional[Union[int, float]]): The minimum acceptable value (inclusive).
                Defaults to None, meaning no lower bound.
            max_value (Optional[Union[int, float]]): The maximum acceptable value (inclusive).
                Defaults to None, meaning no upper bound.
        """
        self.min_value: Optional[Union[int, float]] = min_value
        self.max_value: Optional[Union[int, float]] = max_value

    def validate(self, value: Union[int, float]) -> None:
        """
        Validate that the value is a number and within the specified range.

        Args:
            value (Union[int, float]): The number to validate.

        Raises:
            TypeError: If the value is not an int or float.
            ValueError: If the value is less than min_value or greater than max_value.
        """
        if not isinstance(value, (int, float)):
            raise TypeError("Value must be an int or float")

        if self.min_value is not None and value < self.min_value:
            raise ValueError(f"Value must be at least {self.min_value}")

        if self.max_value is not None and value > self.max_value:
            raise ValueError(f"Value must be at most {self.max_value}")

__init__(min_value=None, max_value=None)

Initialize the Number validator.

Parameters:

Name Type Description Default
min_value Optional[Union[int, float]]

The minimum acceptable value (inclusive). Defaults to None, meaning no lower bound.

 None
max_value Optional[Union[int, float]]

The maximum acceptable value (inclusive). Defaults to None, meaning no upper bound.

 None
Source code in opensourceleg/extras/collections/validators.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def __init__(
    self,
    min_value: Optional[Union[int, float]] = None,
    max_value: Optional[Union[int, float]] = None,
) -> None:
    """
    Initialize the Number validator.

    Args:
        min_value (Optional[Union[int, float]]): The minimum acceptable value (inclusive).
            Defaults to None, meaning no lower bound.
        max_value (Optional[Union[int, float]]): The maximum acceptable value (inclusive).
            Defaults to None, meaning no upper bound.
    """
    self.min_value: Optional[Union[int, float]] = min_value
    self.max_value: Optional[Union[int, float]] = max_value

validate(value)

Validate that the value is a number and within the specified range.

Parameters:

Name Type Description Default
value Union[int, float]

The number to validate.

 required

Raises:

Type Description
TypeError

If the value is not an int or float.
ValueError

If the value is less than min_value or greater than max_value.
Source code in opensourceleg/extras/collections/validators.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def validate(self, value: Union[int, float]) -> None:
    """
    Validate that the value is a number and within the specified range.

    Args:
        value (Union[int, float]): The number to validate.

    Raises:
        TypeError: If the value is not an int or float.
        ValueError: If the value is less than min_value or greater than max_value.
    """
    if not isinstance(value, (int, float)):
        raise TypeError("Value must be an int or float")

    if self.min_value is not None and value < self.min_value:
        raise ValueError(f"Value must be at least {self.min_value}")

    if self.max_value is not None and value > self.max_value:
        raise ValueError(f"Value must be at most {self.max_value}")

Validator

Bases: ABC

Abstract base class for attribute validators.

This descriptor class implements the set_name, get, and set methods to automatically manage a private attribute name and to perform validation when setting an attribute's value. Subclasses must implement the validate() method.

Source code in opensourceleg/extras/collections/validators.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
class Validator(ABC):
    """
    Abstract base class for attribute validators.

    This descriptor class implements the __set_name__, __get__, and __set__ methods to
    automatically manage a private attribute name and to perform validation when setting
    an attribute's value. Subclasses must implement the validate() method.
    """

    def __set_name__(self, owner: Any, name: str) -> None:
        """
        Automatically called to set the name of the attribute.

        This method is invoked at class creation time to assign a private name
        to the attribute being managed by the validator.

        Args:
            owner (Any): The owner class where the descriptor is defined.
            name (str): The name of the attribute.
        """
        self.private_name = f"_{name}"

    def __get__(self, instance: Any, objtype: Any = None) -> Any:
        """
        Retrieve the value of the managed attribute.

        Args:
            instance (Any): The instance from which the attribute is accessed.
            objtype (Any, optional): The type of the owner class. Defaults to None.

        Returns:
            Any: The current value of the attribute.
        """
        return getattr(instance, self.private_name)

    def __set__(self, instance: Any, value: Any) -> None:
        """
        Set the value of the managed attribute after validating it.

        The method calls the validate() function to ensure that the provided value meets
        the criteria defined by the validator. If valid, the value is stored under the
        private attribute name.

        Args:
            instance (Any): The instance on which the attribute is being set.
            value (Any): The new value to set.

        Raises:
            Any: Any exception raised by the validate() method.
        """
        self.validate(value)
        setattr(instance, self.private_name, value)

    @abstractmethod
    def validate(self, value: Any) -> None:
        """
        Validate the value being assigned to the attribute.

        Subclasses must implement this method to enforce specific validation rules.

        Args:
            value (Any): The value to validate.

        Raises:
            Exception: If the value does not meet the validation criteria.
        """
        pass

__get__(instance, objtype=None)

Retrieve the value of the managed attribute.

Parameters:

Name Type Description Default
instance Any

The instance from which the attribute is accessed.

 required
objtype Any

The type of the owner class. Defaults to None.

 None

Returns:

Name Type Description
Any Any

The current value of the attribute.
Source code in opensourceleg/extras/collections/validators.py 
36
37
38
39
40
41
42
43
44
45
46
47
def __get__(self, instance: Any, objtype: Any = None) -> Any:
    """
    Retrieve the value of the managed attribute.

    Args:
        instance (Any): The instance from which the attribute is accessed.
        objtype (Any, optional): The type of the owner class. Defaults to None.

    Returns:
        Any: The current value of the attribute.
    """
    return getattr(instance, self.private_name)

__set__(instance, value)

Set the value of the managed attribute after validating it.

The method calls the validate() function to ensure that the provided value meets the criteria defined by the validator. If valid, the value is stored under the private attribute name.

Parameters:

Name Type Description Default
instance Any

The instance on which the attribute is being set.

 required
value Any

The new value to set.

 required

Raises:

Type Description
Any

Any exception raised by the validate() method.
Source code in opensourceleg/extras/collections/validators.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def __set__(self, instance: Any, value: Any) -> None:
    """
    Set the value of the managed attribute after validating it.

    The method calls the validate() function to ensure that the provided value meets
    the criteria defined by the validator. If valid, the value is stored under the
    private attribute name.

    Args:
        instance (Any): The instance on which the attribute is being set.
        value (Any): The new value to set.

    Raises:
        Any: Any exception raised by the validate() method.
    """
    self.validate(value)
    setattr(instance, self.private_name, value)

__set_name__(owner, name)

Automatically called to set the name of the attribute.

This method is invoked at class creation time to assign a private name to the attribute being managed by the validator.

Parameters:

Name Type Description Default
owner Any

The owner class where the descriptor is defined.

 required
name str

The name of the attribute.

 required
Source code in opensourceleg/extras/collections/validators.py 
23
24
25
26
27
28
29
30
31
32
33
34
def __set_name__(self, owner: Any, name: str) -> None:
    """
    Automatically called to set the name of the attribute.

    This method is invoked at class creation time to assign a private name
    to the attribute being managed by the validator.

    Args:
        owner (Any): The owner class where the descriptor is defined.
        name (str): The name of the attribute.
    """
    self.private_name = f"_{name}"

validate(value) abstractmethod

Validate the value being assigned to the attribute.

Subclasses must implement this method to enforce specific validation rules.

Parameters:

Name Type Description Default
value Any

The value to validate.

 required

Raises:

Type Description
Exception

If the value does not meet the validation criteria.
Source code in opensourceleg/extras/collections/validators.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@abstractmethod
def validate(self, value: Any) -> None:
    """
    Validate the value being assigned to the attribute.

    Subclasses must implement this method to enforce specific validation rules.

    Args:
        value (Any): The value to validate.

    Raises:
        Exception: If the value does not meet the validation criteria.
    """
    pass