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

Improve internal and downstream type checking #121

Merged
merged 8 commits into from
Dec 7, 2022
Merged

Conversation

daneah
Copy link
Member

@daneah daneah commented Nov 23, 2022

This change is a: (check at least one)

  • Bugfix
  • Feature addition
  • Code style update
  • Refactor
  • Release activity

Is this a breaking change? (check one)

  • Yes (for type checking)
  • No

Is the:

  • Title of this pull request clear, concise, and indicative of the issue number it addresses, if any?
  • Test suite passing?
  • Code coverage maximal?
  • Changelog up to date?

What does this change address?

We added py.typed files in #111 but they would only appear in the source distribution through MANIFEST.in; include_package_data = True is required for the files to land in the binary wheel distribution.

We've also got a few things to get up to speed on regarding tooling configuration.

How does this change work?

  • Set include_package_data = True in setup.cfg.
  • Update Optional syntax to comply with PEP 484 and mypy's more strict checking of it
  • Update GitHub Actions config to use stable version of Python 3.10
  • Add Python 3.11 configurations for tools where necessary
  • Stop ignoring imports during type checking

Additional context

This can break consumers' type checking because this package would have previously needed to be ignored by mypy for lack of types; now it can be included, but consumers may find their usage does not type check.

@daneah daneah added the 🐛 bug Something isn't working label Nov 23, 2022
@daneah daneah changed the title Ensure py.typed files end up in binary wheel distribution Improve internal and downstream type checking Nov 23, 2022
@daneah daneah merged commit 4692ecb into dev Dec 7, 2022
@daneah daneah deleted the fix/typechecking branch December 7, 2022 15:22
@daneah daneah mentioned this pull request Dec 7, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants