Skip to content

Add typehints for step func returning types #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
delatrie merged 1 commit into from
Mar 27, 2025
Merged

Add typehints for step func returning types #830

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions allure-python-commons/src/_allure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from functools import wraps
from typing import Any, Callable, TypeVar
from typing import Any, Callable, TypeVar, Union, overload

from allure_commons._core import plugin_manager
from allure_commons.types import LabelType, LinkType, ParameterMode
Expand Down Expand Up @@ -161,7 +161,15 @@ def manual():
return Dynamic.label(LabelType.MANUAL, True)


def step(title):
@overload
def step(title: str) -> "StepContext": ...


@overload
def step(title: _TFunc) -> _TFunc: ...


def step(title: Union[str, _TFunc]) -> Union["StepContext", _TFunc]:
if callable(title):
return StepContext(title.__name__, {})(title)
else:
Expand Down