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

Adopt MyPy for type checking #18

Closed
evamaxfield opened this issue Nov 20, 2020 · 0 comments · Fixed by #21
Closed

Adopt MyPy for type checking #18

evamaxfield opened this issue Nov 20, 2020 · 0 comments · Fixed by #21
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Comments

@evamaxfield
Copy link
Member

Use Case

Please provide a use case to help us understand your request in context

As we add more code to the library, tests will largely ensure we aren't adding anything is breaking, but we should also check the documented types.

Solution

Please describe your ideal solution

Adopt mypy for static type checking and add to tox and CI workflows

Probably adopt Prefect's mypy base config as well.

[mypy]
ignore_missing_imports = True
disallow_untyped_defs = True
check_untyped_defs = True

There are bound to be some failures off the bat which is why we do this 🙂

Alternatives

Please describe any alternatives you've considered, even if you've dismissed them

@evamaxfield evamaxfield added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Nov 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant