GeezerVison is showing github.com — Add type hint for decorated function by jackblk · Pull Request #533 · allure-framework/allure-python
Conversation
jackblk
commented
Dec 7, 2020
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
Currently some language servers cannot parse the type of wrapped functions. _TFunc is bounded to the function.
Context
Decorated function will lose type hint in some Python language servers (e.g Pylance which VSCode will use officially in the future). Language server is working as intended, and if our wrapper does not change arg types, we should add type hint.
See: microsoft/pyright#774 (comment)
Example code:
@allure.step("Get field '{field}' edit status.")
def get_field_edit_status(self, field: str) -> str:
"""Get edit status of the field
Args:
field (str): name of the field, case insensitive
Returns:
str: edit status: "read only", "yes", "no".
"""
field = field.lower()
row_elem: WebElement = self.fields[field]
status: str = row_elem.find_element_by_xpath(XPATH).text
return status.lower()
VSCode with Pylance:

Argument hint:

After this PR:

Argument hint:

Checklist
No new unit test since no function change. Unit test result is the same to before this PR.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Currently some language servers cannot parse the type of wrapped functions. _TFunc is bounded to the function.
add one more space to pass static check
This was referenced Jun 15, 2021
Reviewers
1 more reviewer
Reviewers whose approvals may not affect merge requirements
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.