tortoise / tortoise/tortoise-orm

ForeignKey fields, PydanticMeta - include should include the submodel

Open
#992 2 comments 0 reactions 0 assignees View on GitHub

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.