Skip to content

Adding py.typed sentinel file to support type checking#146

Open
DrPyser wants to merge 1 commit intomasterfrom
WAZO-3848-typing-marker-packaging
Open

Adding py.typed sentinel file to support type checking#146
DrPyser wants to merge 1 commit intomasterfrom
WAZO-3848-typing-marker-packaging

Conversation

@DrPyser
Copy link
Contributor

@DrPyser DrPyser commented Aug 9, 2024

https://typing.readthedocs.io/en/latest/guides/libraries.html#marking-a-package-as-providing-type-information a sentinel file must be present and distributed in package to signal to type checkers that the library provides type information that can be used; otherwise imports from this library are considered untyped.


Note

Marks the library as typed for static type checkers.

  • Adds xivo/py.typed sentinel file and includes it via package_data in setup.py
  • Minor metadata update: copyright year bumped to 2024

Written by Cursor Bugbot for commit 51f7d9b. This will update automatically on new commits. Configure here.

@DrPyser DrPyser added the mergeit label Aug 9, 2024
@DrPyser DrPyser closed this Aug 9, 2024
@DrPyser DrPyser reopened this Aug 9, 2024
@wazo-community-zuul
Copy link
Contributor

Build succeeded.
https://zuul.wazo.community/zuul/t/local/buildset/2953671192a84b7a988cf85a405ff7ba

✔️ tox-linters SUCCESS in 7m 47s
✔️ wazo-tox-py39 SUCCESS in 5m 53s
✔️ wazo-tox-integration-py39 SUCCESS in 3m 30s
✔️ debian-packaging-bullseye SUCCESS in 1m 58s

@DrPyser DrPyser marked this pull request as draft August 12, 2024 17:31
@DrPyser
Copy link
Contributor Author

DrPyser commented Aug 12, 2024

Converted to draft until affected projects can fix the resulting type check errors

@DrPyser DrPyser removed the mergeit label Sep 20, 2024
https://typing.readthedocs.io/en/latest/guides/libraries.html#marking-a-package-as-providing-type-information
a sentinel file must be present and distributed in package to signal to type checkers that the library provides type information that can be used; otherwise imports from this library are considered untyped.
@DrPyser DrPyser force-pushed the WAZO-3848-typing-marker-packaging branch from 46ec30c to 51f7d9b Compare January 9, 2026 20:56
@wazo-community-zuul
Copy link
Contributor

Build succeeded.
https://zuul.wazo.community/zuul/t/local/buildset/5bb8cf0807464ab7b42559e9371ac440

✔️ wazo-tox-py311 SUCCESS in 2m 36s
✔️ tox-linters SUCCESS in 2m 25s
✔️ wazo-tox-integration-py311 SUCCESS in 5m 57s
✔️ debian-packaging-bookworm SUCCESS in 2m 18s

@DrPyser DrPyser marked this pull request as ready for review January 9, 2026 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant