tortoise / tortoise/tortoise-orm
ForeignKey fields, PydanticMeta - include should include the submodel
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 516
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 9
Description
class User(Model):
id = fields.IntField(pk=True)
username = fields.CharField(max_length=30, unique=True)
status = fields.ForeignKeyField('myapp.UserStatus')
class PydanticMeta:
include= ("username", "status_id") # Working
include= ("username", "status") # ERROR
As shown in the above example, it is not possible to decide to include the status model, you can just include the status_id.
A workaround is to use exclude("id"), this will return the username and status model as desired.
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 by reproducing the User model example and trace how PydanticMeta include handles ForeignKey fields. Verify the behavior against the existing exclude("id") workaround; done means including "status" returns the related status model rather than only allowing "status_id".
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100