GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add type hint for decorated function by jackblk · Pull Request #533 · allure-framework/allure-python

Conversation

@jackblk

@jackblk jackblk commented Dec 7, 2020 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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:
image

Argument hint:
image


After this PR:
image

Argument hint:
image

Checklist

  • Sign Allure CLA
  • Provide unit tests

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.

All reactions
jackblk added 2 commits December 7, 2020 15:10
@jackblk
add type hint for decorated function
506e896
Currently some language servers cannot parse the type of wrapped functions. _TFunc is bounded to the function.
@jackblk
fix static check
d1075ea
add one more space to pass static check
sseliverstov
sseliverstov approved these changes Dec 7, 2020
View reviewed changes
@sseliverstov
sseliverstov merged commit 5923e5c into allure-framework:master Dec 7, 2020
This was referenced Jun 15, 2021
Define python_requires>=3.5 in setup.py #598
Closed
Proposal to fix python < 3.5 compatibility issues introduced in version 2.8.24 #599
Merged
beckerGil pushed a commit to beckerGil/allure-python that referenced this pull request Apr 10, 2023
@jackblk @GilBecker-Anaplan
add type hint for decorated function (via allure-framework#533)
bacaea6
IvanBuruyane pushed a commit to IvanBuruyane/allure-python that referenced this pull request Mar 19, 2024
@jackblk
add type hint for decorated function (via allure-framework#533)
752aff1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@sseliverstov sseliverstov sseliverstov approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

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.

2 participants

@jackblk @sseliverstov
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.