behave-cucumber-parser 1.1.0__py2.py3-none-any.whl

behave_cucumber_parser/__init__.py

@@ -0,0 +1 @@
+"""Parses feature files with gherkin-official, cucumber's own reference Gherkin parser, instead of behave's built-in parser, so upcoming Gherkin changes such as Markdown with Gherkin can be adopted before behave supports them natively."""

behave_cucumber_parser/adapter/__init__.py

@@ -0,0 +1,8 @@
+"""Converts cucumber/gherkin parser AST into behave model objects.
+
+Given the AST produced by the `gherkin` package's `Parser`, converts it into
+`behave` model objects (Feature, Rule, Scenario, Step, ...). See
+src/patches/parse_features.py for where the AST comes from and how it's fed
+into this conversion.
+"""
+from .is_feature_file import is_feature_file

behave_cucumber_parser/adapter/backgroundCucumber2Behave.py

@@ -0,0 +1,29 @@
+from behave.model import Background
+from .stepCucumber2Behave import stepsCucumber2Behave as convertSteps
+
+def backgroundCucumber2Behave(filename:str, ast:dict):
+    ''' Converts cucumber/gherkin parser AST to behave background object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Background](https://behave.readthedocs.io/en/stable/api/#behave.model.Background)
+
+    Parameter
+    ---------
+    filename : str
+        Path to the feature file this background belongs to.
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin background.
+    '''
+    # Convert steps
+    steps = convertSteps(filename, ast['steps'])
+    # Create background object
+    backgroundObj = Background(
+        filename=filename,
+        line=ast['location']['line'],
+        keyword=ast['keyword'],
+        name=ast['name'],
+        steps=steps,
+        description=ast['description'])
+    # Return converted object
+    return backgroundObj

behave_cucumber_parser/adapter/childrenCucumber2Behave.py

@@ -0,0 +1,50 @@
+from .backgroundCucumber2Behave import backgroundCucumber2Behave as convertBackground
+from .scenarioCucumber2Behave import scenarioCucumber2Behave as convertScenario
+
+def childrenCucumber2Behave(filename:str, ast:dict) -> dict:
+    ''' Converts cucumber/gherkin parser AST children list to behave object lists.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Background](https://behave.readthedocs.io/en/stable/api/#behave.model.Background)
+        - behave [Rule](https://behave.readthedocs.io/en/stable/api/#behave.model.Rule)
+        - behave [Scenario](https://behave.readthedocs.io/en/stable/api/#behave.model.Scenario)
+
+    Parameter
+    ---------
+    filename : str
+        Name of the feature file to convert.
+    ast : dict
+        Abstract Syntax Tree of cucumber/gherkin children list.
+
+    Return
+    ------
+    {
+        "background": list[behave.model.Background],
+        "rule": list[behave.model.Rule],
+        "scenario": list[behave.model.Scenario]
+    }
+    '''
+    # mapping of cucumber/gherkin AST children keys to conversion functions
+    def convertRule(filename:str, ast:dict):
+        # Needs to be wrapped here to avoid circular imports
+        from .ruleCucumber2Behave import ruleCucumber2Behave as convert
+        return convert(filename, ast)
+    childConverter = {
+        'background': convertBackground,
+        'rule': convertRule,
+        'scenario': convertScenario,
+    }
+    # create empty list entry for each implemented child key
+    children = {}
+    for key in childConverter:
+        children[key] = []
+    # convert all children
+    for child in ast:
+        for key, value in child.items():
+            if key in childConverter:
+                children[key].append(childConverter[key](filename, value))
+            else:
+                raise NotImplementedError(f"Feature child type '{key}' not implemented.")
+    # Return converted object
+    return children

behave_cucumber_parser/adapter/examplesCucumber2Behave.py

@@ -0,0 +1,64 @@
+from behave.model import Examples, Table, Row
+from .tagCucumber2Behave import tagCucumber2Behave as convertTag
+
+def exampleCucumber2Behave(filename:str, ast:dict) -> Examples:
+    ''' Converts cucumber/gherkin parser AST to behave examples object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Examples](https://behave.readthedocs.io/en/stable/api/#behave.model.Examples)
+
+    Parameter
+    ---------
+    filename : str
+        Path to the feature file this examples table belongs to.
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin examples table.
+    '''
+    # Convert tags
+    tags = [convertTag(tag) for tag in ast['tags']]
+    # Convert table
+    # NOTE: Unlike a step's dataTable (a flat "rows" list with the heading as
+    # the first row), an Examples table splits header and body: "tableHeader"
+    # (single row) and "tableBody" (list of rows).
+    table = None
+    if ast.get('tableHeader'):
+        headings = [cell['value'] for cell in ast['tableHeader']['cells']]
+        rows = []
+        for row in ast.get('tableBody', []):
+            cells = [cell['value'] for cell in row['cells']]
+            rows.append(Row(
+                headings=headings,
+                cells=cells,
+                line=row['location']['line'],
+                comments=None))
+        table = Table(
+            headings=headings,
+            rows=rows,
+            line=ast['tableHeader']['location']['line'])
+    # Create examples object
+    examplesObj = Examples(
+        filename=filename,
+        line=ast['location']['line'],
+        keyword=ast['keyword'],
+        name=ast['name'],
+        tags=tags,
+        table=table)
+    # Return converted object
+    return examplesObj
+
+def examplesCucumber2Behave(filename:str, ast:list) -> list[Examples]:
+    ''' Converts cucumber/gherkin parser AST to behave list of examples object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Examples](https://behave.readthedocs.io/en/stable/api/#behave.model.Examples)
+
+    Parameter
+    ---------
+    filename : str
+        Path to the feature file this examples tables belong to.
+    ast : list
+        Abstract Syntax Tree of a cucumber/gherkin examples table list.
+    '''
+    return [exampleCucumber2Behave(filename, entry) for entry in ast]

behave_cucumber_parser/adapter/featureCucumber2Behave.py

@@ -0,0 +1,44 @@
+from behave.model import Feature
+from .tagCucumber2Behave import tagCucumber2Behave as convertTag
+from .childrenCucumber2Behave import childrenCucumber2Behave as convertChildren
+
+def featureCucumber2Behave(filename:str, ast:dict) -> Feature:
+    ''' Converts cucumber/gherkin parser AST to behave feature object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Feature](https://behave.readthedocs.io/en/stable/api/#behave.model.Feature)
+
+    Parameter
+    ---------
+    filename : str
+        Name of the feature file to convert.
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin feature.
+    '''
+    # Convert tags
+    tags = [convertTag(tag) for tag in ast['tags']]
+    # Create feature object
+    featureObj = Feature(
+        filename=filename,
+        line=ast['location']['line'],
+        keyword=ast['keyword'],
+        name=ast['name'],
+        tags=tags,
+        description=ast['description'],
+        scenarios=None,
+        background=None,
+        language=ast['language'])
+    # Convert children
+    children = convertChildren(filename, ast['children'])
+    # Add backgrounds to feature object
+    for background in children['background']:
+        featureObj.add_background(background)
+    # Add scenarios to feature object
+    for scenario in children['scenario']:
+        featureObj.add_scenario(scenario)
+    # Add rules to feature object
+    for rule in children['rule']:
+        featureObj.add_rule(rule)
+    # Return converted object
+    return featureObj

behave_cucumber_parser/adapter/is_feature_file.py

@@ -0,0 +1,10 @@
+def is_feature_file(filename):
+    """
+    Check if filename is a feature file.
+    :param filename:  File name to check.
+    :return:  True if filename is a feature file.
+    """
+    for ending in (".feature", ".feature.md"):
+        if filename.endswith(ending):
+            return True
+    return False

behave_cucumber_parser/adapter/ruleCucumber2Behave.py

@@ -0,0 +1,41 @@
+from behave.model import Rule
+from .tagCucumber2Behave import tagCucumber2Behave as convertTag
+from .childrenCucumber2Behave import childrenCucumber2Behave as convertChildren
+
+def ruleCucumber2Behave(filename:str, ast:dict) -> Rule:
+    ''' Converts cucumber/gherkin parser AST to behave rule object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Rule](https://behave.readthedocs.io/en/stable/api/#behave.model.Rule)
+
+    Parameter
+    ---------
+    filename : str
+        Name of the feature file the rule belongs to.
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin rule.
+    '''
+    # Convert tags
+    tags = [convertTag(tag) for tag in ast['tags']]
+    # Create feature object
+    ruleObj = Rule(
+        filename=filename,
+        line=ast['location']['line'],
+        keyword=ast['keyword'],
+        name=ast['name'],
+        tags=tags,
+        description=ast['description'],
+        scenarios=None,
+        background=None,
+        parent=None)
+    # Convert children
+    children = convertChildren(filename, ast['children'])
+    # Add backgrounds to rule object
+    for background in children['background']:
+        ruleObj.add_background(background)
+    # Add scenarios to rule object
+    for scenario in children['scenario']:
+        ruleObj.add_scenario(scenario)
+    # Return converted object
+    return ruleObj

behave_cucumber_parser/adapter/scenarioCucumber2Behave.py

@@ -0,0 +1,54 @@
+from behave.model import Scenario, ScenarioOutline
+from .stepCucumber2Behave import stepsCucumber2Behave as convertSteps
+from .tagCucumber2Behave import tagCucumber2Behave as convertTag
+from .examplesCucumber2Behave import examplesCucumber2Behave as convertExamples
+
+def scenarioCucumber2Behave(filename:str, ast:dict) -> Scenario:
+    ''' Converts cucumber/gherkin parser AST to behave scenario object.
+
+    A "Scenario Outline" (identified by a non-empty "examples" list) is
+    converted to a behave ScenarioOutline instead of a plain Scenario, so
+    its Examples tables get expanded into concrete scenarios by behave.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Scenario](https://behave.readthedocs.io/en/stable/api/#behave.model.Scenario)
+        - behave [ScenarioOutline](https://behave.readthedocs.io/en/stable/api/#behave.model.ScenarioOutline)
+
+    Parameter
+    ---------
+    filename : str
+        Path to the feature file this scenario belongs to.
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin scenario.
+    '''
+    # Convert tags
+    tags = [convertTag(tag) for tag in ast['tags']]
+    # Convert steps
+    steps = convertSteps(filename, ast['steps'])
+    # Scenario Outline: convert examples tables and build a ScenarioOutline
+    if ast.get('examples'):
+        examples = convertExamples(filename, ast['examples'])
+        return ScenarioOutline(
+            filename=filename,
+            line=ast['location']['line'],
+            keyword=ast['keyword'],
+            name=ast['name'],
+            tags=tags,
+            steps=steps,
+            examples=examples,
+            description=ast['description'])
+    # Create scenario object
+    scenarioObj = Scenario(
+        filename=filename,
+        line=ast['location']['line'],
+        keyword=ast['keyword'],
+        name=ast['name'],
+        tags=tags,
+        steps=steps,
+        description=ast['description'],
+        parent=None,
+        background=None,
+        background_steps=None)
+    # Return converted object
+    return scenarioObj

behave_cucumber_parser/adapter/stepCucumber2Behave.py

@@ -0,0 +1,66 @@
+from behave.model import Step
+from .textCucumber2Behave import textCucumber2Behave as convertText
+from .tableCucumber2Behave import tableCucumber2Behave as convertTable
+
+def stepCucumber2Behave(filename:str, ast:dict, previousKeyword:str|None=None) -> Step:
+    ''' Converts cucumber/gherkin parser AST to behave step object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Step](https://behave.readthedocs.io/en/stable/api/#behave.model.Step)
+
+    Parameter
+    ---------
+    filename : str
+        Path to the feature file this step belongs to.
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin step.
+    previousKeyword : str|None
+        Keyword of the previous step. This is used to determine the step_type
+        of the current step, if it is "And".
+    '''
+    # Convert text
+    text = None
+    if 'docString' in ast:
+        text = convertText(ast['docString'])
+    # Convert data table
+    table = None
+    if 'dataTable' in ast:
+        table = convertTable(ast['dataTable'])
+    # Get step type
+    step_type = ast['keyword'].strip().lower()
+    if step_type == 'and':
+        if previousKeyword is None:
+            raise ValueError('The first step must not be "And"')
+        step_type = previousKeyword
+    # Create step object
+    return Step(
+        filename=filename,
+        line=ast['location']['line'],
+        keyword=ast['keyword'],
+        step_type=step_type,
+        name=ast['text'],
+        text=text,
+        table=table)
+
+def stepsCucumber2Behave(filename:str, ast:dict) -> list[Step]:
+    ''' Converts cucumber/gherkin parser AST to behave list of step object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Step](https://behave.readthedocs.io/en/stable/api/#behave.model.Step)
+
+    Parameter
+    ---------
+    filename : str
+        Path to the feature file this step belongs to.
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin step list.
+    '''
+    steps = []
+    previousKeyword = None
+    for entry in ast:
+        step = stepCucumber2Behave(filename, entry, previousKeyword)
+        previousKeyword = step.step_type
+        steps.append(step)
+    return steps

behave_cucumber_parser/adapter/tableCucumber2Behave.py

@@ -0,0 +1,34 @@
+from behave.model import Table, Row
+
+def tableCucumber2Behave(ast:dict) -> Table:
+    ''' Converts cucumber/gherkin parser AST to behave Table object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Table](https://behave.readthedocs.io/en/stable/api/#behave.model.Table)
+        - behave [Row](https://behave.readthedocs.io/en/stable/api/#behave.model.Row)
+
+    Parameter
+    ---------
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin table.
+    '''
+    # Get first row as headings
+    headings = []
+    for cell in ast['rows'][0]['cells']:
+        headings.append(cell['value'])
+    # Convert further rows
+    rows = []
+    if len(ast['rows']) > 1:
+        for row in ast['rows'][1:]:
+            cells = [c['value'] for c in row['cells']]
+            rows.append(Row(
+                headings=headings,
+                cells=cells,
+                line=row['location']['line'],
+                comments=None))
+    # Create table object
+    return Table(
+        headings=headings,
+        rows=rows,
+        line=ast['location']['line'])

behave_cucumber_parser/adapter/tagCucumber2Behave.py

@@ -0,0 +1,19 @@
+from behave.model import Tag
+
+def tagCucumber2Behave(ast:dict) -> Tag:
+    ''' Converts a cucumber/gherkin AST tag to a behave Tag object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Tag](https://behave.readthedocs.io/en/stable/api/#behave.model.Tag)
+
+    Parameter
+    ---------
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin tag.
+    '''
+    name = ast['name']
+    if name.startswith('@'):
+        name = name[1:]
+    line = ast['location']['line']
+    return Tag(name, line)

behave_cucumber_parser/adapter/textCucumber2Behave.py

@@ -0,0 +1,18 @@
+from behave.model import Text
+
+def textCucumber2Behave(ast:dict) -> Text:
+    ''' Converts cucumber/gherkin parser AST to behave Text object.
+
+    Documentations:
+        - cucumber/gherkin [Abstract Syntax Tree](https://github.com/cucumber/gherkin#abstract-syntax-tree-ast)
+        - behave [Text](https://behave.readthedocs.io/en/stable/api/#behave.model.Text)
+
+    Parameter
+    ---------
+    ast : dict
+        Abstract Syntax Tree of a cucumber/gherkin text.
+    '''
+    return Text(
+        value=ast['content'],
+        content_type=ast['mediaType'],
+        line=ast['location']['line'])

behave_cucumber_parser/patches/BEHAVE_LICENSE.md

@@ -0,0 +1,36 @@
+# Upstream license (behave)
+
+The files in this directory (`src/patches/`) each adapt a small piece of
+[behave](https://github.com/behave/behave)'s own source (copied, then
+modified — see each file's own `.md` doc for what changed and why), copied
+from behave at commit
+[`4387315f12299d4b0b2ec5bf0b399e2366a99f5e`](https://github.com/behave/behave/commit/4387315f12299d4b0b2ec5bf0b399e2366a99f5e).
+behave is distributed under the following license; this notice covers all
+files in this directory.
+
+```license
+Copyright (c) 2012-2014 Benno Rice, Richard Jones and others, except where noted.
+Copyright (c) 2014-2023 Jens Engel and others, except where noted.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```

behave_cucumber_parser/patches/__init__.py

@@ -0,0 +1,8 @@
+"""behave-internals overrides ("patches") this project needs.
+
+`collect_feature_locations` and `setup_paths` are copied and modified from
+behave's own source (see each one's .md doc for what was adapted and why,
+and BEHAVE_LICENSE.md for the shared upstream license notice).
+`parse_features` is original code that replaces behave's own function
+instead (see parse_features.md). `install.py` applies all three.
+"""

behave_cucumber_parser/patches/collect_feature_locations.md

@@ -0,0 +1,47 @@
+# collect_feature_locations
+
+Adapted from [`behave.runner_util.collect_feature_locations()`](https://github.com/behave/behave/blob/4387315f12299d4b0b2ec5bf0b399e2366a99f5e/behave/runner_util.py).
+License: see [BEHAVE_LICENSE.md](BEHAVE_LICENSE.md).
+
+## What changed
+
+Extended to also accept `*.feature.md` files (see `is_feature_file()` in
+[`src/adapter/is_feature_file.py`](../adapter/is_feature_file.py)), to
+support Markdown with Gherkin.
+
+## Diff
+
+Against `collect_feature_locations()` in `behave/runner_util.py` at the
+pinned commit (see [BEHAVE_LICENSE.md](BEHAVE_LICENSE.md)):
+
+```diff
+--- behave/runner_util.py (behave @ 4387315f12299d4b0b2ec5bf0b399e2366a99f5e)
++++ collect_feature_locations.py (this file)
+@@ -3,7 +3,7 @@
+     Collect feature file names by processing list of paths (from command line).
+     A path can be a:
+ 
+-      * filename (ending with ".feature")
++      * filename (ending with ".feature" or ".feature.md")
+       * location, ala "{filename}:{line_number}"
+       * features configuration filename, ala "@features.txt"
+       * directory, to discover and collect all "*.feature" files below.
+@@ -17,7 +17,7 @@
+             for dirpath, dirnames, filenames in os.walk(path, followlinks=True):
+                 dirnames.sort()
+                 for filename in sorted(filenames):
+-                    if filename.endswith(".feature"):
++                    if is_feature_file(filename):
+                         location = FileLocation(os.path.join(dirpath, filename))
+                         locations.append(location)
+         elif path.startswith('@'):
+@@ -26,7 +26,7 @@
+         else:
+             # -- OTHERWISE: Normal filename or location (schema: filename:line)
+             location = FileLocationParser.parse(path)
+-            if not location.filename.endswith(".feature"):
++            if not is_feature_file(location.filename):
+                 raise InvalidFilenameError(location.filename)
+             if location.exists():
+                 locations.append(location)
+```

behave_cucumber_parser/patches/collect_feature_locations.py

@@ -0,0 +1,44 @@
+# -- ADAPTED-FROM: behave.runner_util.collect_feature_locations()
+# See collect_feature_locations.md for the upstream license notice and a
+# description of what was changed.
+from behave.exception import InvalidFilenameError
+from behave.model_type import FileLocation
+from behave.runner_util import FeatureListParser, FileLocationParser
+from ..adapter.is_feature_file import is_feature_file
+import os
+
+def collect_feature_locations(paths, strict=True):
+    """
+    Collect feature file names by processing list of paths (from command line).
+    A path can be a:
+
+      * filename (ending with ".feature" or ".feature.md")
+      * location, ala "{filename}:{line_number}"
+      * features configuration filename, ala "@features.txt"
+      * directory, to discover and collect all "*.feature" files below.
+
+    :param paths:  Paths to process.
+    :return: Feature file locations to use (as list of FileLocations).
+    """
+    locations = []
+    for path in paths:
+        if os.path.isdir(path):
+            for dirpath, dirnames, filenames in os.walk(path, followlinks=True):
+                dirnames.sort()
+                for filename in sorted(filenames):
+                    if is_feature_file(filename):
+                        location = FileLocation(os.path.join(dirpath, filename))
+                        locations.append(location)
+        elif path.startswith('@'):
+            # -- USE: behave @list_of_features.txt
+            locations.extend(FeatureListParser.parse_file(path[1:]))
+        else:
+            # -- OTHERWISE: Normal filename or location (schema: filename:line)
+            location = FileLocationParser.parse(path)
+            if not is_feature_file(location.filename):
+                raise InvalidFilenameError(location.filename)
+            if location.exists():
+                locations.append(location)
+            elif strict:
+                raise FileNotFoundError(path)
+    return locations

behave_cucumber_parser/patches/install.md

@@ -0,0 +1,12 @@
+# install
+
+Applies every patch in this directory to `behave` (monkeypatches
+`behave.runner`/`behave.runner_util`) — see
+[`parse_features`](parse_features.md), [`collect_feature_locations`](collect_feature_locations.md),
+and [`setup_paths`](setup_paths.md) for what each patch does and why.
+
+Run once at interpreter startup by
+[`pth/behave_cucumber_parser.pth`](../../pth/behave_cucumber_parser.pth),
+via `import behave_cucumber_parser.patches.install` (a `.pth` file's `import`
+line executes the target module immediately, and `install()` is called at
+module scope — see the comment in the `.pth` file itself).

behave_cucumber_parser/patches/install.py

@@ -0,0 +1,25 @@
+"""Applies every patch in this package to behave. See install.md."""
+
+def install():
+    """Apply all patches in src/patches/ to behave.
+
+    behave.runner imports parse_features/collect_feature_locations by name
+    (`from behave.runner_util import ...`), so both that local copy and the
+    original in runner_util need to be repointed for each override to
+    actually run. Runner.setup_paths() is a method, so it's repointed on the
+    class itself.
+    """
+    import behave.runner
+    import behave.runner_util
+    from .parse_features import parse_features
+    from .collect_feature_locations import collect_feature_locations
+    from .setup_paths import setup_paths
+
+    behave.runner_util.parse_features = parse_features
+    behave.runner.parse_features = parse_features
+    behave.runner_util.collect_feature_locations = collect_feature_locations
+    behave.runner.collect_feature_locations = collect_feature_locations
+    behave.runner.Runner.setup_paths = setup_paths
+
+# Executed each time this file is imported.
+install()

behave_cucumber_parser/patches/parse_features.md

@@ -0,0 +1,19 @@
+# parse_features
+
+Overrides `behave.runner_util.parse_features()` / `behave.runner.parse_features()`.
+
+Unlike [`collect_feature_locations`](collect_feature_locations.md) and
+[`setup_paths`](setup_paths.md), this is **not** adapted from behave's own
+source — it's original code, so [`BEHAVE_LICENSE.md`](BEHAVE_LICENSE.md)
+doesn't apply to it. It's still a patch in the sense that matters here: it
+replaces one of behave's own functions at runtime, same as the other two.
+
+## What it does
+
+behave's own `parse_features()` uses its own hand-written Gherkin parser.
+This replacement parses feature files with the `gherkin` package (the
+reference Cucumber/Gherkin parser) instead, selecting the Markdown-with-
+Gherkin token matcher for `*.feature.md` files, then converts the resulting
+Cucumber AST into `behave` model objects via `src/adapter/`. This lets the
+project pick up upstream Gherkin changes — such as Markdown with Gherkin —
+before behave supports them natively.

behave_cucumber_parser/patches/parse_features.py

@@ -0,0 +1,32 @@
+# -- OVERRIDES: behave.runner_util.parse_features() / behave.runner.parse_features()
+# See parse_features.md for what this replaces and why. Original code (not
+# adapted from behave's source), so BEHAVE_LICENSE.md does not apply here.
+from ..adapter.featureCucumber2Behave import featureCucumber2Behave as convertFeature
+from gherkin import Parser
+from gherkin.token_matcher_markdown import GherkinInMarkdownTokenMatcher
+
+def parse_features(feature_files, language=None):
+    """
+    Parse feature files and return list of Feature model objects.
+    Handles:
+
+      * feature file names, ala "alice.feature"
+      * feature file locations, ala: "alice.feature:10"
+
+    :param feature_files: List of feature file names to parse.
+    :param language:      Default language to use.
+    :return: List of feature objects.
+    """
+    features = []
+    for file in feature_files:
+        gherkin_document = None
+        # Markdown with Gherkin ("*.feature.md") needs its own token matcher;
+        # classic Gherkin ("*.feature") uses the default (token_matcher=None).
+        token_matcher = None
+        if file.filename.endswith(".feature.md"):
+            token_matcher = GherkinInMarkdownTokenMatcher()
+        with open(file.filename, "r") as f:
+            gherkin_document = Parser().parse(f.read(), token_matcher)
+        features.append(
+            convertFeature(file.filename, gherkin_document['feature']))
+    return features

behave_cucumber_parser/patches/setup_paths.md

@@ -0,0 +1,38 @@
+# setup_paths
+
+Adapted from [`behave.runner.Runner.setup_paths()`](https://github.com/behave/behave/blob/4387315f12299d4b0b2ec5bf0b399e2366a99f5e/behave/runner.py).
+License: see [BEHAVE_LICENSE.md](BEHAVE_LICENSE.md).
+
+## What changed
+
+`Runner.setup_paths()` has its own hardcoded "does this directory contain
+feature files?" probe (`fn.endswith(".feature")`), independent of
+`collect_feature_locations()`. It runs first, during `Runner.run()`, and
+raises `ConfigError` before `collect_feature_locations()` is ever called —
+so overriding `collect_feature_locations()` alone is not enough to support
+directories that only contain `*.feature.md` files. This copy swaps that
+probe for `is_feature_file()` (see
+[`src/adapter/is_feature_file.py`](../adapter/is_feature_file.py)) so it
+accepts `*.feature.md` too.
+
+## Diff
+
+Against `Runner.setup_paths()` in `behave/runner.py` at the pinned commit
+(see [BEHAVE_LICENSE.md](BEHAVE_LICENSE.md)). `Runner.setup_paths()` is a
+class method there; this file copies it out as a standalone function (see
+`install.py`), so the method body is shown de-indented by one level below
+to keep the diff to the one line that actually changed:
+
+```diff
+--- behave/runner.py, Runner.setup_paths() (behave @ 4387315f12299d4b0b2ec5bf0b399e2366a99f5e), de-indented
++++ setup_paths.py (this file)
+@@ -63,7 +63,7 @@
+     self.config.base_dir = base_dir
+ 
+     for dirpath, dirnames, filenames in os.walk(base_dir, followlinks=True):
+-        if [fn for fn in filenames if fn.endswith(".feature")]:
++        if [fn for fn in filenames if is_feature_file(fn)]:
+             break
+     else:
+         if self.config.verbose:
+```

behave_cucumber_parser/patches/setup_paths.py

@@ -0,0 +1,92 @@
+# -- ADAPTED-FROM: behave.runner.Runner.setup_paths()
+# See setup_paths.md for the upstream license notice and a description of
+# what was changed.
+from behave.exception import ConfigError
+from behave.runner import path_getrootdir
+from ..adapter.is_feature_file import is_feature_file
+import os
+
+def setup_paths(self):
+    # pylint: disable=too-many-branches, too-many-statements
+    if self.config.paths:
+        if self.config.verbose:
+            print("Supplied path:", \
+                  ", ".join('"%s"' % path for path in self.config.paths))
+        first_path = self.config.paths[0]
+        if hasattr(first_path, "filename"):
+            # -- BETTER: isinstance(first_path, FileLocation):
+            first_path = first_path.filename
+        base_dir = first_path
+        if base_dir.startswith("@"):
+            # -- USE: behave @features.txt
+            base_dir = base_dir[1:]
+            file_locations = self.feature_locations()
+            if file_locations:
+                base_dir = os.path.dirname(file_locations[0].filename)
+        base_dir = os.path.abspath(base_dir)
+
+        # supplied path might be to a feature file
+        if os.path.isfile(base_dir):
+            if self.config.verbose:
+                print("Primary path is to a file so using its directory")
+            base_dir = os.path.dirname(base_dir)
+    else:
+        if self.config.verbose:
+            print('Using default path "{}"'.format(self.DEFAULT_DIRECTORY))
+        base_dir = os.path.abspath(self.DEFAULT_DIRECTORY)
+
+    # Get the root. This is not guaranteed to be "/" because Windows.
+    root_dir = path_getrootdir(base_dir)
+    new_base_dir = base_dir
+    steps_dir = self.config.steps_dir
+    environment_file = self.config.environment_file
+
+    while True:
+        if self.config.verbose:
+            print("Trying base directory:", new_base_dir)
+
+        if os.path.isdir(os.path.join(new_base_dir, steps_dir)):
+            break
+        if os.path.isfile(os.path.join(new_base_dir, environment_file)):
+            break
+        if new_base_dir == root_dir:
+            break
+
+        new_base_dir = os.path.dirname(new_base_dir)
+
+    if new_base_dir == root_dir:
+        if self.config.verbose:
+            if not self.config.paths:
+                print('ERROR: Could not find "%s" directory. '\
+                      'Please specify where to find your features.' % \
+                            steps_dir)
+            else:
+                print('ERROR: Could not find "%s" directory in your '\
+                    'specified path "%s"' % (steps_dir, base_dir))
+
+        message = 'No %s directory in %r' % (steps_dir, base_dir)
+        raise ConfigError(message)
+
+    base_dir = new_base_dir
+    self.config.base_dir = base_dir
+
+    for dirpath, dirnames, filenames in os.walk(base_dir, followlinks=True):
+        if [fn for fn in filenames if is_feature_file(fn)]:
+            break
+    else:
+        if self.config.verbose:
+            if not self.config.paths:
+                print('ERROR: Could not find any "<name>.feature" files. '\
+                    'Please specify where to find your features.')
+            else:
+                print('ERROR: Could not find any "<name>.feature" files '\
+                    'in your specified path "%s"' % base_dir)
+        raise ConfigError('No feature files in %r' % base_dir)
+
+    self.base_dir = base_dir
+    self.path_manager.add(base_dir)
+    if not self.config.paths:
+        self.config.paths = [base_dir]
+
+    if base_dir != os.getcwd():
+        self.path_manager.add(os.getcwd())

behave_cucumber_parser-1.1.0.dist-info/METADATA

@@ -0,0 +1,39 @@
+Metadata-Version: 2.5
+Name: behave_cucumber_parser
+Version: 1.1.0
+Summary: Parses feature files with gherkin-official, cucumber's own reference Gherkin parser, instead of behave's built-in parser, so upcoming Gherkin changes such as Markdown with Gherkin can be adopted before behave supports them natively.
+Project-URL: Homepage, https://gitlab.com/pm-virutallab/workflow/behave-cucumber-parser
+Project-URL: Repository, https://gitlab.com/pm-virutallab/workflow/behave-cucumber-parser
+Project-URL: Documentation, https://behave-cucumber-parser-c2df5d.gitlab.io/
+Project-URL: Issues, https://gitlab.com/pm-virutallab/workflow/behave-cucumber-parser/-/work_items
+Author-email: Paul Markstädter <paul.markstaedter.git@mailbox.org>
+Maintainer-email: Paul Markstädter <paul.markstaedter.git@mailbox.org>
+License-Expression: BSD-2-Clause
+License-File: LICENSE
+License-File: src/patches/BEHAVE_LICENSE.md
+Requires-Dist: behave>=1.3.3
+Requires-Dist: gherkin-official>=41.0.0
+Provides-Extra: build
+Requires-Dist: build>=1.5.0; extra == 'build'
+Requires-Dist: hatch-requirements-txt>=0.4.1; extra == 'build'
+Requires-Dist: hatchling>=1.29.0; extra == 'build'
+Requires-Dist: versioningit>=3.3.0; extra == 'build'
+Provides-Extra: buildapt
+Requires-Dist: git; extra == 'buildapt'
+Requires-Dist: python3; extra == 'buildapt'
+Requires-Dist: python3-venv; extra == 'buildapt'
+Provides-Extra: docu
+Requires-Dist: myst-parser>=5.1.0; extra == 'docu'
+Requires-Dist: sphinx-autobuild>=2025.8.25; extra == 'docu'
+Requires-Dist: sphinx-book-theme>=1.2.0; extra == 'docu'
+Requires-Dist: sphinx>=9.1.0; extra == 'docu'
+Requires-Dist: versioningit>=3.3.0; extra == 'docu'
+Provides-Extra: docuapt
+Requires-Dist: texlive-full; extra == 'docuapt'
+Provides-Extra: runtime
+Requires-Dist: behave>=1.3.3; extra == 'runtime'
+Requires-Dist: gherkin-official>=41.0.0; extra == 'runtime'
+Provides-Extra: runtimeapt
+Provides-Extra: test
+Requires-Dist: behave>=1.3.3; extra == 'test'
+Provides-Extra: testapt

behave_cucumber_parser-1.1.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+behave_cucumber_parser/__init__.py,sha256=XzI85RexoYcMMqWDqXfzQwiP9iTVIbtKkKrkcD6D_y0,239
+behave_cucumber_parser/adapter/__init__.py,sha256=ZI23JpBXOn5h1ocFzBTvsPSuukGqLFWyw2h8thCLyPA,357
+behave_cucumber_parser/adapter/backgroundCucumber2Behave.py,sha256=mn-pKYYbnnd4-FglyM80fdkzzIyib12e8iVC6RikeA0,1035
+behave_cucumber_parser/adapter/childrenCucumber2Behave.py,sha256=mkOva-cIWq3ZOOo4i3IbgLTAPQi592dj-TRKBOsr1yU,2011
+behave_cucumber_parser/adapter/examplesCucumber2Behave.py,sha256=zpsB4GTS_-6B5GPsoQjkN4NXf9TYlwetWBnJrLzsXlQ,2462
+behave_cucumber_parser/adapter/featureCucumber2Behave.py,sha256=JzG_7U1wJ8m_ykFhCL8w-4TtNHJHb79yyyGiSWR2_hg,1595
+behave_cucumber_parser/adapter/is_feature_file.py,sha256=b1HowOSuoIANUHirVYfHROl_DXuncHvOWLkOkm-9bSs,306
+behave_cucumber_parser/adapter/ruleCucumber2Behave.py,sha256=70TcUXNvRRQQQ8j2K0cw7E8-bZI_pqA49VwwDJ63I3U,1447
+behave_cucumber_parser/adapter/scenarioCucumber2Behave.py,sha256=WBl4Evs-XUmO7V8x2HQObTXl5ZwUpCUzBdQAH-C87rA,2143
+behave_cucumber_parser/adapter/stepCucumber2Behave.py,sha256=uKqtulsFexkZMP-cUgyDYkwUIa_8Zh6bD3sbwcuIVOI,2340
+behave_cucumber_parser/adapter/tableCucumber2Behave.py,sha256=K8Zrfjv5uUSxg_b-NwdqohdX2Gkmjd4WhO7araoSsWw,1160
+behave_cucumber_parser/adapter/tagCucumber2Behave.py,sha256=X4IbBWf5w12M5_Hzt-QkpEqlOllL5zQ_9uQ4u1cW2B8,604
+behave_cucumber_parser/adapter/textCucumber2Behave.py,sha256=utF7XaIvxHNEHR-kDBDYHz2myvQVG-PHe50w8K9lvZY,596
+behave_cucumber_parser/patches/BEHAVE_LICENSE.md,sha256=adtGj6aq0p38fsxO2kNq0wONwQI_Az_FOIn7eaXC3MI,1877
+behave_cucumber_parser/patches/__init__.py,sha256=RepUTu5bR8ICuEFSyBSGkygGwUSpAHbY-O_J6VuJOBw,414
+behave_cucumber_parser/patches/collect_feature_locations.md,sha256=VY9F82FZGuMgSMMa8tOL2KC5rST1-a4hczkyjWMinHk,2017
+behave_cucumber_parser/patches/collect_feature_locations.py,sha256=LUE9jcI60G0dEsdyf-h83l5d5nd7Y4NV2K-FSYfpAao,1929
+behave_cucumber_parser/patches/install.md,sha256=OY6aYFf_0j1y-AJL5d8ePJVV7J3knxU40SJSihRO5HM,615
+behave_cucumber_parser/patches/install.py,sha256=xHYQX8LjGeWy0pUhghsqljUe8By3wLz24aOZQsohwOI,1035
+behave_cucumber_parser/patches/parse_features.md,sha256=Fk_zsK7vzUI1goIjt7FnXHrUOsLJCkCBbQcPEKsKKBg,976
+behave_cucumber_parser/patches/parse_features.py,sha256=dd4mkwb0mdwKgCYekksaBJz7zRqtcQKlgMtrZLXUBNE,1434
+behave_cucumber_parser/patches/setup_paths.md,sha256=bYwZPWU5Cl1CFwNp1KKKrA_6lL1LrZ-FAGEg_Il40xM,1648
+behave_cucumber_parser/patches/setup_paths.py,sha256=4ZX9Qw3401GOU2Rr9_6Rxm_3-C3gtPCn37bUAbrTp3M,3547
+behave_cucumber_parser.pth,sha256=_jBY29w3L7l5q30cx8YUPuiazoOMWRC6wpiIWQiQ1co,184
+behave_cucumber_parser-1.1.0.dist-info/METADATA,sha256=_tNJtcMw3ujZ2sYigzEGVSESBROQCyh3MEVr-CTUw9A,1973
+behave_cucumber_parser-1.1.0.dist-info/WHEEL,sha256=K_1GFnQyJknHy845BKcqIEBshHiHkrbA-n3al-vZCiY,105
+behave_cucumber_parser-1.1.0.dist-info/licenses/LICENSE,sha256=fGpN5i6E-e4xJJDAg0on6RTdMlB-zc0JF4mV23rMn7g,1545
+behave_cucumber_parser-1.1.0.dist-info/licenses/src/patches/BEHAVE_LICENSE.md,sha256=adtGj6aq0p38fsxO2kNq0wONwQI_Az_FOIn7eaXC3MI,1877
+behave_cucumber_parser-1.1.0.dist-info/RECORD,,

behave_cucumber_parser-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

behave_cucumber_parser-1.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2026, Paul Markstädter
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+This project also contains code adapted from behave
+(https://github.com/behave/behave), used and modified under its own
+BSD-2-Clause license — see src/patches/BEHAVE_LICENSE.md for the full
+upstream notice and src/patches/ for what was adapted and why.

behave_cucumber_parser-1.1.0.dist-info/licenses/src/patches/BEHAVE_LICENSE.md

@@ -0,0 +1,36 @@
+# Upstream license (behave)
+
+The files in this directory (`src/patches/`) each adapt a small piece of
+[behave](https://github.com/behave/behave)'s own source (copied, then
+modified — see each file's own `.md` doc for what changed and why), copied
+from behave at commit
+[`4387315f12299d4b0b2ec5bf0b399e2366a99f5e`](https://github.com/behave/behave/commit/4387315f12299d4b0b2ec5bf0b399e2366a99f5e).
+behave is distributed under the following license; this notice covers all
+files in this directory.
+
+```license
+Copyright (c) 2012-2014 Benno Rice, Richard Jones and others, except where noted.
+Copyright (c) 2014-2023 Jens Engel and others, except where noted.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```

behave_cucumber_parser.pth

@@ -0,0 +1,5 @@
+''' This file is executed by pythons site module before each execution.
+It is used to reconfigure behave to use the cucumber parser.
+'''
+
+import behave_cucumber_parser.patches.install