Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Static Type Checking via mypy - PEP 561 support #78

Closed
seanhess opened this issue Mar 3, 2023 · 3 comments
Closed

Static Type Checking via mypy - PEP 561 support #78

seanhess opened this issue Mar 3, 2023 · 3 comments
Labels
question Further information is requested

Comments

@seanhess
Copy link

seanhess commented Mar 3, 2023

Proposed changes

I'm new to python so excuse me if I'm missing something obvious.

You've carefully added type hints to the SDK, amazing. When I add a static type checker to my project, like mypy, it can't seem to find them. According to mypy's documentation, packages are supposed to declare their compatibility with a py.typed file in the package directory. See here: https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages

Context

Static type checking dramatically reduces developer errors. You've already created types, adding compatibility to PEP 561 would allow us to use static checkers

Possible Implementation

See above

Other information

Am I missing anything? Another way to run a static type checker perhaps?

@jpvajda
Copy link
Contributor

jpvajda commented Nov 17, 2023

👋 This is probably better posted in our Community Forum as it doesn't sound like an issue with the SDK. if it's still an issue for you feel free to post there and a Community member can assist.

@jpvajda jpvajda closed this as completed Nov 17, 2023
@jpvajda jpvajda added the question Further information is requested label Nov 17, 2023
@npip99
Copy link

npip99 commented Apr 25, 2024

Any update on this? Not sure why it wouldn't be a GitHub issue here, seems similar to e.g. a form of documentation (#304)

@davidvonthenen
Copy link
Contributor

davidvonthenen commented Apr 25, 2024

I'm actually looking into something for our CI system actually this week (a bunch of different things actually). I'm evaluating a bunch of different options at the moment and this is one of them.

It's going to take some time so I don't have an ETA on it, but I'm hoping by the end of June at the latest. Most likely it'll be sooner.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

5 participants
@seanhess @jpvajda @npip99 @davidvonthenen and others