Minor fix to v0.3.0 I/O models #1128
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
Adds data models that will be needed for v0.3.0 of the superstaq server --------- Co-authored-by: richrines1 <85512171+richrines1@users.noreply.github.com>
richrines1
reviewed
Dec 13, 2024
| @@ -264,13 +265,13 @@ class UserQuery(DefaultPydanticModel): | |||
| """Model for querying the database to retrieve users. Use of lists implied logical OR. Providing | |||
| multiple fields (e.g. name and email) implies logical AND.""" | |||
|
|
|||
| name: list[str] | None = pydantic.Field(None) | |||
| name: Sequence[str] | None = pydantic.Field(None) | |||
There was a problem hiding this comment.
why Sequence? i thought pydantic should convert/cast the input so generic types shouldn't be necessary
There was a problem hiding this comment.
On server side this model gets subclassed to introduce a checks for enums not exposed to the client side. Therefore the type needs to be covariant - hence Sequence. Strictly speaking not required for all fields but I thought it would be neater to apply to all.
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.
Correcting a small typing mistake and fixing naming.