Source code for tortoise.signals

from __future__ import annotations

from collections.abc import Callable
from enum import Enum
from typing import TypeVar

T = TypeVar("T")
FuncType = Callable[[T], T]
Signals = Enum("Signals", ["pre_save", "post_save", "pre_delete", "post_delete"])



[docs]
def post_save(*senders) -> FuncType:
    """
    Register given models post_save signal.

    :param senders: Model class
    """

    def decorator(f: T) -> T:
        for sender in senders:
            sender.register_listener(Signals.post_save, f)
        return f

    return decorator




[docs]
def pre_save(*senders) -> FuncType:
    """
    Register given models pre_save signal.

    :param senders: Model class
    """

    def decorator(f: T) -> T:
        for sender in senders:
            sender.register_listener(Signals.pre_save, f)
        return f

    return decorator




[docs]
def pre_delete(*senders) -> FuncType:
    """
    Register given models pre_delete signal.

    :param senders: Model class
    """

    def decorator(f: T) -> T:
        for sender in senders:
            sender.register_listener(Signals.pre_delete, f)
        return f

    return decorator




[docs]
def post_delete(*senders) -> FuncType:
    """
    Register given models post_delete signal.

    :param senders: Model class
    """

    def decorator(f: T) -> T:
        for sender in senders:
            sender.register_listener(Signals.post_delete, f)
        return f

    return decorator