feat(commons): enable typecheck for Allure API #850
Merged
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 bypy.typed
.Solution
This PR refactors
allure.py
into a package. Now theallure-python-commons
project defines two packages:allure_commons
(for integrations) andallure
(for test authors). Both packages includepy.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
allure.dynamic.parameter
'smode
Fixes #731
Supersedes #848