Merge branch 'master' into lowercase-keywords-error

# Conflicts:
#	tests/feature/test_steps.py

Author: jsa34

.github/workflows/main.yml

@@ -13,28 +13,28 @@ jobs:
         include:
           - python-version: "3.8"
             toxfactor: py3.8
-            ignore-typecheck-outcome: true
+            ignore-typecheck-outcome: false
             ignore-test-outcome: false
           - python-version: "3.9"
             toxfactor: py3.9
-            ignore-typecheck-outcome: true
+            ignore-typecheck-outcome: false
             ignore-test-outcome: false
           - python-version: "3.10"
             toxfactor: py3.10
-            ignore-typecheck-outcome: true
+            ignore-typecheck-outcome: false
             ignore-test-outcome: false
           - python-version: "3.11"
             toxfactor: py3.11
-            ignore-typecheck-outcome: true
+            ignore-typecheck-outcome: false
             ignore-test-outcome: false
           - python-version: "3.12"
             toxfactor: py3.12
-            ignore-typecheck-outcome: true
+            ignore-typecheck-outcome: false
             ignore-test-outcome: false
           - python-version: "3.13-dev"
             toxfactor: py3.13
-            ignore-typecheck-outcome: true
-            ignore-test-outcome: true
+            ignore-typecheck-outcome: false
+            ignore-test-outcome: false
 
     steps:
     - uses: actions/checkout@v3
@@ -47,7 +47,7 @@ jobs:
 
     - name: Install poetry
       run: |
-        python -m pip install poetry==1.8.2
+        python -m pip install poetry==1.8.3
 
     - name: Configure poetry
       run: |
@@ -88,3 +88,28 @@ jobs:
         token: ${{ secrets.CODECOV_TOKEN }}
         fail_ci_if_error: false
         verbose: true # optional (default = false)
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pytest-bdd
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    needs: test-run
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

CHANGES.rst

@@ -3,13 +3,19 @@ Changelog
 
 Unreleased
 ----------
-- Fix an issue when only the first Step would inject a fixture, while later steps would not be able to.
-- Test against the latest versions of pytest (8.2, 8.3).
-- Use `gherkin-official` parser to replace custom parsing logic.
+
+8.0.0b1
+----------
+- Use `gherkin-official` parser to replace custom parsing logic. This will make pytest-bdd more compatible with the Gherkin specification.
 - Multiline steps must now always use triple-quotes for the additional lines.
 - All feature files must now use the keyword `Feature:` to be considered valid.
 - Tags can no longer have spaces (e.g. "@tag one" "@tag two" are no longer valid).
 
+7.3.0
+----------
+- Fix an issue when only the first Step would inject a fixture, while later steps would not be able to.
+- Test against the latest versions of pytest (8.2, 8.3).
+
 7.2.0
 ----------
 - Fix compatibility issue with Python 3.13.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytest-bdd"
-version = "7.2.0"
+version = "8.0.0b1"
 description = "BDD for pytest"
 authors = ["Oleg Pidsadnyi <[email protected]>", "Anatoly Bubenkov <[email protected]>"]
 maintainers = ["Alessio Bogon <[email protected]>"]
@@ -94,6 +94,7 @@ python_version = "3.8"
 warn_return_any = true
 warn_unused_configs = true
 files = "src/pytest_bdd/**/*.py"
+disallow_untyped_defs = true
 
 [[tool.mypy.overrides]]
 module = ["parse", "parse_type"]

pytest.ini

@@ -1,4 +1,5 @@
 [pytest]
 testpaths = tests
 filterwarnings =
-    error
+    # only ignore errors from the pytest_bdd package
+    error:::(src)?\.pytest_bdd.*

src/pytest_bdd/compat.py

@@ -34,7 +34,7 @@ def inject_fixture(request: FixtureRequest, arg: str, value: Any) -> None:
         # if there was already one registered, so we need to force its value
         # to the one we want to inject.
         fixture_def = request._get_active_fixturedef(arg)
-        fixture_def.cached_result = (value, None, None)
+        fixture_def.cached_result = (value, None, None)  # type: ignore
 
 else:
 

src/pytest_bdd/exceptions.py

@@ -26,17 +26,14 @@ class NoScenariosFound(Exception):
 class GherkinParseError(Exception):
     """Base class for all Gherkin parsing errors."""
 
-    def __init__(self, message, line, line_content, filename):
+    def __init__(self, message: str, line: int, line_content: str, filename: str) -> None:
         super().__init__(message)
         self.message = message
         self.line = line
         self.line_content = line_content
         self.filename = filename
-        self.line = line
-        self.line_content = line_content
-        self.filename = filename
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.message}\nLine number: {self.line}\nLine: {self.line_content}\nFile: {self.filename}"
 
 

src/pytest_bdd/feature.py

@@ -57,7 +57,7 @@ def get_feature(base_path: str, filename: str, encoding: str = "utf-8") -> Featu
     return feature
 
 
-def get_features(paths: list[str], **kwargs) -> list[Feature]:
+def get_features(paths: list[str], encoding: str = "utf-8") -> list[Feature]:
     """Get features for given paths.
 
     :param list paths: `list` of paths (file or dirs)
@@ -71,10 +71,10 @@ def get_features(paths: list[str], **kwargs) -> list[Feature]:
             seen_names.add(path)
             if os.path.isdir(path):
                 file_paths = list(glob.iglob(os.path.join(path, "**", "*.feature"), recursive=True))
-                _features.extend(get_features(file_paths, **kwargs))
+                _features.extend(get_features(file_paths, encoding=encoding))
             else:
                 base, name = os.path.split(path)
-                feature = get_feature(base, name, **kwargs)
+                feature = get_feature(base, name, encoding=encoding)
                 _features.append(feature)
     _features.sort(key=lambda _feature: _feature.name or _feature.filename)
     return _features

src/pytest_bdd/gherkin_parser.py

@@ -309,7 +309,7 @@ def get_gherkin_document(abs_filename: str, encoding: str = "utf-8") -> GherkinD
 
 def handle_gherkin_parser_error(
     raw_error: str, line: int, line_content: str, filename: str, original_exception: Exception | None = None
-):
+) -> None:
     """Map the error message to a specific exception type and raise it."""
     # Split the raw_error into individual lines
     error_lines = raw_error.splitlines()

src/pytest_bdd/hooks.py

@@ -1,40 +1,71 @@
 from __future__ import annotations
 
+from collections.abc import Callable
+
 import pytest
+from _pytest.fixtures import FixtureRequest
+
+from pytest_bdd.parser import Feature, Scenario, Step
 
 """Pytest-bdd pytest hooks."""
 
 
-def pytest_bdd_before_scenario(request, feature, scenario):
+def pytest_bdd_before_scenario(request: FixtureRequest, feature: Feature, scenario: Scenario) -> object:
     """Called before scenario is executed."""
 
 
-def pytest_bdd_after_scenario(request, feature, scenario):
+def pytest_bdd_after_scenario(request: FixtureRequest, feature: Feature, scenario: Scenario) -> object:
     """Called after scenario is executed."""
 
 
-def pytest_bdd_before_step(request, feature, scenario, step, step_func):
+def pytest_bdd_before_step(
+    request: FixtureRequest, feature: Feature, scenario: Scenario, step: Step, step_func: Callable[..., object]
+) -> object:
     """Called before step function is set up."""
 
 
-def pytest_bdd_before_step_call(request, feature, scenario, step, step_func, step_func_args):
+def pytest_bdd_before_step_call(
+    request: FixtureRequest,
+    feature: Feature,
+    scenario: Scenario,
+    step: Step,
+    step_func: Callable[..., object],
+    step_func_args: dict[str, object],
+) -> object:
     """Called before step function is executed."""
 
 
-def pytest_bdd_after_step(request, feature, scenario, step, step_func, step_func_args):
+def pytest_bdd_after_step(
+    request: FixtureRequest,
+    feature: Feature,
+    scenario: Scenario,
+    step: Step,
+    step_func: Callable[..., object],
+    step_func_args: dict[str, object],
+) -> object:
     """Called after step function is successfully executed."""
 
 
-def pytest_bdd_step_error(request, feature, scenario, step, step_func, step_func_args, exception):
+def pytest_bdd_step_error(
+    request: FixtureRequest,
+    feature: Feature,
+    scenario: Scenario,
+    step: Step,
+    step_func: Callable[..., object],
+    step_func_args: dict[str, object],
+    exception: Exception,
+) -> object:
     """Called when step function failed to execute."""
 
 
-def pytest_bdd_step_func_lookup_error(request, feature, scenario, step, exception):
+def pytest_bdd_step_func_lookup_error(
+    request: FixtureRequest, feature: Feature, scenario: Scenario, step: Step, exception: Exception
+) -> object:
     """Called when step lookup failed."""
 
 
 @pytest.hookspec(firstresult=True)
-def pytest_bdd_apply_tag(tag, function):
+def pytest_bdd_apply_tag(tag: str, function: Callable[..., object]) -> object:
     """Apply a tag (from a ``.feature`` file) to the given scenario.
 
     The default implementation does the equivalent of

src/pytest_bdd/parser.py

@@ -218,7 +218,6 @@ class Step:
         failed (bool): Whether the step has failed (internal use only).
         scenario (Optional[ScenarioTemplate]): The scenario to which this step belongs (internal use only).
         background (Optional[Background]): The background to which this step belongs (internal use only).
-        lines (List[str]): Additional lines for the step (internal use only).
     """
 
     type: str
@@ -229,7 +228,6 @@ class Step:
     failed: bool = field(init=False, default=False)
     scenario: ScenarioTemplate | None = field(init=False, default=None)
     background: Background | None = field(init=False, default=None)
-    lines: list[str] = field(init=False, default_factory=list)
 
     def __init__(self, name: str, type: str, indent: int, line_number: int, keyword: str) -> None:
         """Initialize a step.
@@ -332,22 +330,6 @@ def get_tag_names(tag_data: list[GherkinTag]) -> set[str]:
         """
         return {tag.name.lstrip("@") for tag in tag_data}
 
-    @staticmethod
-    def get_step_type(keyword: str) -> str | None:
-        """Map a step keyword to its corresponding type.
-
-        Args:
-            keyword (str): The keyword for the step (e.g., 'given', 'when', 'then').
-
-        Returns:
-            Optional[str]: The type of the step, or None if the keyword is unknown.
-        """
-        return {
-            "given": GIVEN,
-            "when": WHEN,
-            "then": THEN,
-        }.get(keyword)
-
     def parse_steps(self, steps_data: list[GherkinStep]) -> list[Step]:
         """Parse a list of step data into Step objects.
 
@@ -358,7 +340,7 @@ def parse_steps(self, steps_data: list[GherkinStep]) -> list[Step]:
             List[Step]: A list of Step objects.
         """
 
-        def get_step_content(_gherkin_step):
+        def get_step_content(_gherkin_step: GherkinStep) -> str:
             step_name = strip_comments(_gherkin_step.text)
             if _gherkin_step.docString:
                 step_name = f"{step_name}\n{_gherkin_step.docString.content}"