behave: add given, when, then, step, use_fixture, fixture and Context

Author: hoel-bagard

stubs/behave/METADATA.toml

@@ -0,0 +1,2 @@
+version = "1.3.*"
+upstream_repository = "https://github.com/behave/behave"

stubs/behave/behave/__init__.pyi

@@ -0,0 +1,13 @@
+from behave.fixture import fixture as fixture, use_fixture as use_fixture
+from behave.step_registry import (
+    Given as Given,
+    Step as Step,
+    Then as Then,
+    When as When,
+    given as given,
+    step as step,
+    then as then,
+    when as when,
+)
+
+__all__ = ["given", "when", "then", "step", "Given", "When", "Then", "Step", "use_fixture", "fixture"]

stubs/behave/behave/fixture.pyi

@@ -0,0 +1,16 @@
+from collections.abc import Callable
+from typing import Any, Concatenate, ParamSpec, TypeVar
+
+from behave.runner import Context
+
+_T = TypeVar("_T")
+_F = TypeVar("_F", bound=Callable[..., Any])
+_P = ParamSpec("_P")
+
+def use_fixture(
+    fixture_func: Callable[Concatenate[Context, _P], _T],
+    context: Context,
+    *fixture_args: _P.args,
+    **fixture_kwargs: _P.kwargs,
+) -> _T: ...
+def fixture(func: _F | None = None, name: str | None = None, pattern: str | None = None) -> _F: ...

stubs/behave/behave/runner.pyi

@@ -0,0 +1,30 @@
+from collections.abc import Callable
+from contextlib import AbstractContextManager
+from typing import Any, ParamSpec
+
+_P = ParamSpec("_P")
+
+class Context:
+    LAYER_NAMES: list[str]
+    FAIL_ON_CLEANUP_ERRORS: bool
+
+    feature: Any
+    scenario: Any
+    tags: set[str]
+    aborted: bool
+    failed: bool
+    table: Any
+    text: str | None
+    config: Any
+    active_outline: Any
+
+    def __init__(self, runner: Any) -> None: ...
+    def abort(self, reason: str | None = None) -> None: ...
+    def use_or_assign_param(self, name: str, value: Any) -> Any: ...
+    def use_or_create_param(self, name: str, factory_func: Callable[_P, Any], *args: _P.args, **kwargs: _P.kwargs) -> Any: ...
+    def use_with_user_mode(self) -> AbstractContextManager[None]: ...
+    def execute_steps(self, steps_text: str) -> bool: ...
+    def add_cleanup(self, cleanup_func: Callable[_P, Any], *args: _P.args, **kwargs: _P.kwargs) -> None: ...
+    @property
+    def captured(self) -> Any: ...
+    def attach(self, mime_type: str, data: bytes) -> None: ...

stubs/behave/behave/step_registry.pyi

@@ -0,0 +1,17 @@
+from collections.abc import Callable
+from typing import Any, Concatenate, TypeVar
+
+from behave.runner import Context as Context
+
+_F = TypeVar("_F", bound=Callable[Concatenate[Context, ...], None])
+
+def given(pattern: str, **kwargs: Any) -> Callable[[_F], _F]: ...
+def when(pattern: str, **kwargs: Any) -> Callable[[_F], _F]: ...
+def then(pattern: str, **kwargs: Any) -> Callable[[_F], _F]: ...
+def step(pattern: str, **kwargs: Any) -> Callable[[_F], _F]: ...
+
+# Title-case aliases
+Given = given
+When = when
+Then = then
+Step = step