Skip to content

motorhead.validator

Validator

Bases: BoundMethodWrapper[TOwner, [TInsertOrUpdate, ClauseOrMongoQuery | None], InsertUpdateConfig]

Validator method wrapper.

Validator methods receive an insert or update object, and execute some - potentially async - operations to make sure the inserted or updated data is valid.

Source code in motorhead/validator.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
class Validator(
    BoundMethodWrapper[TOwner, [TInsertOrUpdate, ClauseOrMongoQuery | None], InsertUpdateConfig]
):
    """
    Validator method wrapper.

    Validator methods receive an insert or update object, and execute some - potentially
    async - operations to make sure the inserted or updated data is valid.
    """

    __slots__ = ()

    exception = ValidationError

validator(config='insert-update')

Service method decorator factory that converts the decorated method into a Validator instance.

Example:

class SVC(Service):
    @validator("update")
    def check_something(self, data: InsertData | CreateData, query: ClauseOrMongoQuery | None) -> None:
        raise ValueError("Always fail.")

Parameters:

Name Type Description Default
config InsertUpdateConfig

Validatator config.

 'insert-update'
Source code in motorhead/validator.py 
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
def validator(
    config: InsertUpdateConfig = "insert-update",
) -> Callable[
    [Callable[[TOwner, TInsertOrUpdate, ClauseOrMongoQuery | None], Coroutine[None, None, None]]],
    "Validator[TOwner, TInsertOrUpdate]",
]:
    """
    Service method decorator factory that converts the decorated method into a `Validator` instance.

    Example:

    ```python
    class SVC(Service):
        @validator("update")
        def check_something(self, data: InsertData | CreateData, query: ClauseOrMongoQuery | None) -> None:
            raise ValueError("Always fail.")
    ```

    Arguments:
        config: Validatator config.
    """

    def decorator(
        func: Callable[[TOwner, TInsertOrUpdate, ClauseOrMongoQuery | None], Coroutine[None, None, None]],
        /,
    ) -> "Validator[TOwner, TInsertOrUpdate]":
        return Validator(wrapped=func, config=config)

    return decorator