List typing fixes #287
Merged
List typing fixes #287
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
tribble
commented
Jul 22, 2024
workos/resources/list.py
Outdated
| list_method: Callable = Field(exclude=True) | ||
| list_args: ListArgs = Field(exclude=True) | ||
| filter_params: FilterParams = Field(exclude=True) |
There was a problem hiding this comment.
I don't love passing in an entirely separate type for this, but guess what? Python type hinting doesn't support intersection between two TypedDicts. This is why we can't have nice things.
There was a problem hiding this comment.
... actually, I wonder if all of the list resource params can inherit from ListArgs and add their own specific params. I think that will work out better. Going to convert this back to drafe.
tribble
force-pushed
the
list-typing-fixes
branch
from
33a47e4
to
a956d3d
Compare
mattgd
approved these changes
Jul 23, 2024
tribble
added a commit
that referenced
this pull request
Jul 30, 2024
* Update ini to pick up more files * Remove runtime type checking for list types * Change approach to specifying list params * Fix after rebase * Formatting * Remove som unused imports and switch typed dict import to typing extensions
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.
Description
Rather than check list params at runtime, just define static types. I had to refactor the list resource a bit to accomplish this, as I moved away from using a model for the args and just used a
TypedDictDocumentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.