Add type hint to allure.step parameters (fixes #828)#838
Closed
darsor wants to merge 1 commit intoallure-framework:masterfrom
Closed
Add type hint to allure.step parameters (fixes #828)#838darsor wants to merge 1 commit intoallure-framework:masterfrom
darsor wants to merge 1 commit intoallure-framework:masterfrom
Conversation
|
|
|
it seems something is wrong withing CI build pipeline, not the PR. could please someone take a look? this PR might help a lot of people :) |
f0be248 to
07c7b40
Compare
delatrie
requested changes
Mar 26, 2025
Contributor
delatrie
left a comment
There was a problem hiding this comment.
Hi, @darsor ! Thank you for contributing in allure-python!
Let's better use @typing.overload:
@overload
def step(title: str) -> StepContext:
...
@overload
def step(title: _TFunc) -> _TFunc:
...This will require moving StepContext above step.
And it also makes sense to disable type checking when returning the wrapper in StepContext.__call__ for those of us who enable pyright when working on the repo :)
return impl # type: ignore
Contributor
|
Turns out #830 implements this in a more correct way. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Current versions of Pyright flag errors on functions decorated with
@allure.step, as reported in #828. Adding type hints toallure.stepfixes this issue.Tests pass on Python 3.7 and Python 3.13.
Checklist