Fix several typing annotations in the SDK and run mypy on snippets #9260
Conversation
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
|
Web viewer built successfully. If applicable, you should also test it:
Note: This comment is updated whenever you push a commit. |
|
Latest documentation preview deployed successfully.
Note: This comment is updated whenever you push a commit. |
teh-cmc
approved these changes
Mar 13, 2025
abey79
added a commit
that referenced
this pull request
Mar 13, 2025
Adding that `__init__.py` in #9260 made mypy happy but snippets sad. It's now explicitly ignored.
Wumpf
pushed a commit
that referenced
this pull request
Mar 14, 2025
This assert was introduced in #9260 and is apparently failing in CI. I'm really not sure why, but anyways it's replaced by a `cast` now.
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.
Related
What
Snippets, a key aspect of our documentation, were not typed checked by mypy so far... 😱 No longer. This lead to several fixes in user-facing typing annotation in the python SDK. Plus the usual load of fixes in the snippets themselves.
Note: snippets that are "not runnable" (as per
snippets.toml) must now also be mypy-ignore in ourpyproject.toml. I don't mind this added complexity a single second: make your snippets runnable! :)