Skip to content

Validators

RegistryValidator

a utility for custom validation with the Registerer. you can subclass this and override the on_register method, and raise an exception if you must.

Source code in registerer/validators.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class RegistryValidator:
    """
    a utility for custom validation with the Registerer.
    you can subclass this and override the on_register method, and raise an exception if you must.

    """

    def __init__(self, validator, *, error: typing.Optional[str] = None) -> None:
        self.validator = validator
        self.error = error

    def __call__(self, item):
        """
        this function will be called when registering an item

        args:
            item (Any): the item that is being registered (the class or function)
        """
        if not self.validator(item):
            raise RegistrationError(
                self.error if self.error else f"custom validation failed when registering {item.__name__}"
            )

__call__(item)

this function will be called when registering an item

Parameters:

Name Type Description Default
item Any

the item that is being registered (the class or function)

 required
Source code in registerer/validators.py 
17
18
19
20
21
22
23
24
25
26
27
def __call__(self, item):
    """
    this function will be called when registering an item

    args:
        item (Any): the item that is being registered (the class or function)
    """
    if not self.validator(item):
        raise RegistrationError(
            self.error if self.error else f"custom validation failed when registering {item.__name__}"
        )