ormar/docs/api/signals/decorators.md

decorators.signals

receiver

receiver(signal: str, senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for given signal name.

Arguments:

that should have the signal receiver registered

• signal (str): name of the signal to register to
• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

post_save

post_save(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for post_save signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

post_update

post_update(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for post_update signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

post_delete

post_delete(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for post_delete signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

pre_save

pre_save(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for pre_save signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

pre_update

pre_update(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for pre_update signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

pre_delete

pre_delete(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for pre_delete signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

pre_relation_add

pre_relation_add(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for pre_relation_add signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

post_relation_add

post_relation_add(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for post_relation_add signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

pre_relation_remove

pre_relation_remove(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for pre_relation_remove signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched

post_relation_remove

post_relation_remove(senders: Union[Type["Model"], List[Type["Model"]]]) -> Callable

Connect given function to all senders for post_relation_remove signal.

Arguments:

that should have the signal receiver registered

• senders (Union[Type["Model"], List[Type["Model"]]]): one or a list of "Model" classes

Returns:

Callable: returns the original function untouched