SG-39414 Add type annotations #393
Conversation
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.
|
|
||
| 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
| 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? |
|
This is a pretty low risk change, it would be great to get it merged. |
|
Since this isn't getting any traction I'm going to push a stubs only library to pypi. When this is complete I will remove it. |
|
I'd also be very excited to get these changes in! We currently maintain our own stubs package and it would be great to be able to delete it. |
My stubs have been published to pypi, in case anyone needs them: https://pypi.org/project/types-shotgun-api3/ |
|
Can this PR get some attention please? |
3 participants
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.