feat: add choices to strings to enable literal types#1580
Open
MaximSrour wants to merge 1 commit intoormar-orm:masterfrom
Open
feat: add choices to strings to enable literal types#1580MaximSrour wants to merge 1 commit intoormar-orm:masterfrom
MaximSrour wants to merge 1 commit intoormar-orm:masterfrom
Conversation
Merging this PR will degrade performance by 32.91%
Performance Changes
Comparing |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enables
ormar.Stringto preserve string literal typing whenchoicesare provided, while keeping the underlying database column assqlalchemy.String.Closes #1579.
Changes
ormar.Stringto project atyping.Literal[...]pydantic type when stringchoicesare providedString(..., choices=..., nullable=True)by wrapping the projected type inOptional[...]Stringbehavior unchanged whenchoicesare not providedString(..., choices=...)StringandString(..., choices=...)in a single sectionTesting
Built and ran targetted tests for the new changes, and ran tests against the entire suite. All passing.
Installed a local version of ORMAR into a personal repository that uses it, and tested against existing type errors.
Screenshots
Error before:

Using the new literal inference:
