FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

prototype Pydantic choice support in `create_pydantic_model` by dantownsend · Pull Request #469 · piccolo-orm/piccolo · GitHub

/ piccolo Public

prototype Pydantic choice support in create_pydantic_model - #469

Open
dantownsend wants to merge 1 commit into
masterfrom
467-pydantic-choices
ConversationCommits (1)ChecksFiles changed
Open

prototype Pydantic choice support in create_pydantic_model#469
dantownsend wants to merge 1 commit into
masterfrom
467-pydantic-choices

Conversation

dantownsend commented Mar 24, 2022

Copy link
Copy Markdown
Member

Related to #467

Just a prototype at the moment.

If a Piccolo column has choices, we can use the choices Enum as the Pydantic type. For example:

class RelationshipType(str, enum.Enum):
    colleague = "colleague"
    friend = "friend"

class Person(Table):
    type = Varchar(choices=RelationshipType)

It would become this Pydantic model:

class PersonModel(BaseModel):
    type: RelationshipType

The problem is the JSON schema it generates is quite complex, and Piccolo Admin doesn't currently understand $ref values:

So the options are:

  1. Modify Piccolo Admin so it understands $ref
  2. Start work on PydanticModel class #331, which would add a new API for creating Pydantic models. create_pydantic_model will still be supported, and used by Piccolo admin for now, but we can migrate to this new API at a later date.

dantownsend added the enhancement New feature or request label Mar 24, 2022

codecov-commenter commented Mar 24, 2022 •
edited
Loading

Copy link
Copy Markdown

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 90.83%. Comparing base (52f01ae) to head (ce4f905).
⚠️ Report is 472 commits behind head on master.

Files with missing lines Patch % Lines
piccolo/utils/pydantic.py 75.00% 1 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #469      +/-   ##
==========================================
- Coverage   90.84%   90.83%   -0.02%     
==========================================
  Files         104      104              
  Lines        6913     6915       +2     
==========================================
+ Hits         6280     6281       +1     
- Misses        633      634       +1

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sinisaos reviewed Mar 26, 2022
View reviewed changes
Comment thread piccolo/utils/pydantic.py
if isinstance(column, (Decimal, Numeric)):
value_type: t.Type = pydantic.condecimal(
if column._meta.choices:
value_type: t.Type = column._meta.choices

sinisaos Mar 26, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@dantownsend Strings work well. Adding these two lines code becomes compatible with Piccolo Admin (with field propertyTitle).

# pydantic.py line 242
if column._meta.choices:
    params["title"] = column._meta.choices.__name__

In Piccolo Admin change this line to v-bind:type="property.type" and this line to class Gender(str, enum.Enum): and everything work well in admin and openapi docs.

Unfortunately ints doesn't work due to validation error.

sinisaos mentioned this pull request Dec 7, 2022
Merged
sinisaos mentioned this pull request Jan 16, 2025
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

sinisaos sinisaos left review comments

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL