SG-39414 Add type annotations #393
Open
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
chadrik
force-pushed
the
typing
branch
2 times, most recently
from
cf7e8db to
ff3a639
Compare
|
I don't think these CI failures are related to my changes. |
chadrik
force-pushed
the
typing
branch
2 times, most recently
from
30eee33 to
85c0f50
Compare
There was a problem hiding this comment.
It would be cool to add a blank py.typed marker file so tools like mypy know that this package has type hints!
https://peps.python.org/pep-0561/#packaging-type-information
I believe we'd also need to update setup.py to include that in the package data.
chadrik
commented
Jun 19, 2025
|
|
||
| class BaseEntity(TypedDict, total=False): | ||
| id: int | ||
| type: str |
There was a problem hiding this comment.
I added some TypedDicts to try to fill in some of the required dictionary fields. Let me know if you see anything wrong here.
carlos-villavicencio-adsk
changed the title
chadrik
commented
Jun 19, 2025
| entity_type: str, | ||
| data: dict[str, Any], | ||
| return_fields: Optional[list] = None, | ||
| ) -> dict[str, Any]: |
There was a problem hiding this comment.
This should be changed to the BaseEntity TypedDict
|
Anything else I can do to help this along? |
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.
Resolves #307 and #233
When running
mypyagainst the code there are still some errors, but the annotations should provide some good value to users without any real downsides.