tortoise / tortoise/tortoise-orm
Signals not working within classes
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 516
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 9
Description
Describe the bug
You're unable to use signal decorators within classes.
To Reproduce
from tortoise.backends.base.client import BaseDBAsyncClient
from tortoise.signals import post_save
from typing import List, Optional, Type
from .models import Model
class Example:
@post_save(Model)
async def signal_post_save(
self,
sender: Type[Model],
instance: Model,
created: bool,
using_db: Optional[BaseDBAsyncClient],
update_fields: List[str],
) -> None:
print(sender, instance, using_db, created, update_fields)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the post_save decorator in tortoise.signals and trace how it handles the Example class method shown in the reproduction. Reproduce the failure with the provided Model and callback, then verify that signal decorators work within classes without breaking existing callback behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, database
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100