-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement Enum Validation #46
Merged
Merged
Conversation
This file contains 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
Hey, I'm a little hesitant on the StrEnum import as it'll lock us into Py3.11+ when this was added. Perhaps for Strs we could just use typing.Literal instead? Eg @app.route("/fruitshop/buy", methods=["POST"])
@ValidateParameters()
def buy_fruit(
fruit_name: typing.Literal["apple", "banana", "cherry"] = Json(),
):
return "Fruit bought!" |
Ge0rg3
requested changes
Jul 11, 2024
… or int rather than StrEnum or IntEnum to preserve backwards compatibility
Hey @Ge0rg3 just thought I should bump this, no rush though! |
Hey @smt5541, please can you show some sample usage for this? Thanks! |
Ge0rg3
approved these changes
Aug 12, 2024
Thanks! |
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.
🛠 Changes being made
Give examples of the changes you've made in this pull request. Include an itemized list if you can.
StrEnum
andIntEnum
subclasses.🧠 Rationale behind the change
Why did you choose to make these changes?
func
parameter to validate myEnum
parameters fromstr
orint
, but this is overhead that could easily be included in this library to reduce many similar validation functionsDoes this pull request resolve any open issues?
Yes. Closes #44
Were there any trade-offs you had to consider?
Not particularly
🧪 Testing
Have tests been added or updated for the changes introduced in this pull request?
Are the changes backwards compatible?
If the changes aren't backwards compatible, what other options were explored?
N/A
✨ Quality check
Are your changes free of any erroneous print statements, debuggers or other leftover code?
Has the README been updated to reflect the changes introduced (if applicable)?
💬 Additional comments
Feel free to add any further information below
Dependent on #45