Package maintainers who wish to support type checking of their code MUST add a marker file named py.typed to their package supporting typing.
At the same time:
The single-file module should be refactored into a package and indicate that the package supports typing as described above.
Since the Allure API is exposed to users via the allure.py module (not via a package), it can't be affected by py.typed.
Solution
This PR refactors allure.py into a package. Now the allure-python-commons project defines two packages: allure_commons (for integrations) and allure (for test authors). Both packages include py.typed, which enables type checking.
Currently, this mainly affects type checking of functions with @allure.step applied to them (see #731).
More typing annotations will be added in the future.
Other changes
standardize quotes in allure-python-commons/setup.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
According to typing.python.org:
At the same time:
Since the Allure API is exposed to users via the allure.py module (not via a package), it can't be affected by py.typed.
Solution
This PR refactors allure.py into a package. Now the allure-python-commons project defines two packages: allure_commons (for integrations) and allure (for test authors). Both packages include py.typed, which enables type checking.
Currently, this mainly affects type checking of functions with @allure.step applied to them (see #731).
More typing annotations will be added in the future.
Other changes
Fixes #731
Supersedes #848