Merge pull request #722 from pytest-dev/do-not-strip-comments-from-step-names

Do not strip comments from step names

Author: youtux

CHANGES.rst

@@ -4,6 +4,7 @@ Changelog
 Unreleased
 ----------
 - Dropped support for python 3.8. Supported python versions: 3.9, 3.10, 3.11, 3.12, 3.13.
+- Text after the `#` character is no longer stripped from the Scenario and Feature name.
 
 8.0.0b2
 ----------
@@ -21,6 +22,7 @@ Unreleased
 - All feature files must now use the keyword `Feature:` to be considered valid.
 - Tags can no longer have spaces (e.g. "@tag one" and "@tag two" are no longer valid).
 - Tags can now be on multiple lines (stacked)
+- Text after the `#` character is no longer stripped from the Step name.
 
 7.3.0
 ----------

README.rst

@@ -56,7 +56,7 @@ Note that pytest-splinter_ is used to get the browser fixture.
             And I press the publish button
 
             Then I should not see the error message
-            And the article should be published  # Note: will query the database
+            And the article should be published
 
 Note that only one feature is allowed per feature file.
 

src/pytest_bdd/parser.py

@@ -20,21 +20,6 @@
 from .types import STEP_TYPES
 
 STEP_PARAM_RE = re.compile(r"<(.+?)>")
-COMMENT_RE = re.compile(r"(^|(?<=\s))#")
-
-
-def strip_comments(line: str) -> str:
-    """Remove comments from a line of text.
-
-    Args:
-        line (str): The line of text from which to remove comments.
-
-    Returns:
-        str: The line of text without comments, with leading and trailing whitespace removed.
-    """
-    if res := COMMENT_RE.search(line):
-        line = line[: res.start()]
-    return line.strip()
 
 
 @dataclass(eq=False)
@@ -377,7 +362,7 @@ def parse_steps(self, steps_data: list[GherkinStep]) -> list[Step]:
                 current_type = keyword
             steps.append(
                 Step(
-                    name=strip_comments(step.text),
+                    name=step.text,
                     type=current_type,
                     indent=step.location.column - 1,
                     line_number=step.location.line,
@@ -401,7 +386,7 @@ def parse_scenario(self, scenario_data: GherkinScenario, feature: Feature) -> Sc
         templated = bool(scenario_data.examples)
         scenario = ScenarioTemplate(
             feature=feature,
-            name=strip_comments(scenario_data.name),
+            name=scenario_data.name,
             line_number=scenario_data.location.line,
             templated=templated,
             tags=self.get_tag_names(scenario_data.tags),
@@ -451,7 +436,7 @@ def parse(self) -> Feature:
             scenarios=OrderedDict(),
             filename=self.abs_filename,
             rel_filename=self.rel_filename,
-            name=strip_comments(feature_data.name),
+            name=feature_data.name,
             tags=self.get_tag_names(feature_data.tags),
             background=None,
             line_number=feature_data.location.line,

tests/args/cfparse/test_args.py

@@ -15,7 +15,7 @@ def test_every_step_takes_param_with_the_same_name(pytester):
                     When I pay 2 Euro
                     And I pay 1 Euro
                     Then I should have 0 Euro
-                    And I should have 999999 Euro # In my dream...
+                    And I should have 999999 Euro
 
             """
         ),

tests/args/parse/test_args.py

@@ -14,7 +14,7 @@ def test_every_steps_takes_param_with_the_same_name(pytester):
                     When I pay 2 Euro
                     And I pay 1 Euro
                     Then I should have 0 Euro
-                    And I should have 999999 Euro # In my dream...
+                    And I should have 999999 Euro
 
             """
         ),

tests/feature/test_outline.py

@@ -90,7 +90,6 @@ def test_unused_params(pytester):
                 Scenario Outline: Outlined with unused params
                     Given there are <start> cucumbers
                     When I eat <eat> cucumbers
-                    # And commented out step with <unused_param>
                     Then I should have <left> cucumbers
 
                     Examples:

tests/feature/test_scenario.py

@@ -45,9 +45,10 @@ def test_scenario_comments(pytester):
                     # Comment
                     Given I have a bar
 
-                Scenario: Strings that are not comments
+                Scenario: Strings that are not #comments
                     Given comments should be at the start of words
                     Then this is not a#comment
+                    And this is not a # comment
                     And this is not "#acomment"
 
             """
@@ -65,7 +66,7 @@ def test_scenario_comments(pytester):
         def test_1():
             pass
 
-        @scenario("comments.feature", "Strings that are not comments")
+        @scenario("comments.feature", "Strings that are not #comments")
         def test_2():
             pass
 
@@ -80,9 +81,11 @@ def _():
             pass
 
 
-        @then(parsers.parse("this is not {acomment}"))
-        def _(acomment):
-            assert re.search("a.*comment", acomment)
+        @then("this is not a#comment")
+        @then("this is not a # comment")
+        @then('this is not "#acomment"')
+        def _():
+            pass
 
         """
         )