Class FeatureParser

src/pytest_bdd/parser.py:366–543

Converts a feature file into a Feature object. Args: basedir (str): The basedir for locating feature files. filename (str): The filename of the feature file. encoding (str): File encoding of the feature file to parse.

class FeatureParser:
    """Converts a feature file into a Feature object.

    Args:
        basedir (str): The basedir for locating feature files.
        filename (str): The filename of the feature file.
        encoding (str): File encoding of the feature file to parse.
    """

    def __init__(self, basedir: str, filename: str, encoding: str = "utf-8"):
        self.abs_filename = os.path.abspath(os.path.join(basedir, filename))
        self.rel_filename = os.path.join(os.path.basename(basedir), filename)
        self.encoding = encoding

    def parse_steps(self, steps_data: list[GherkinStep]) -> list[Step]:
        """Parse a list of step data into Step objects.

        Args:
            steps_data (List[dict]): The list of step data.

        Returns:
            List[Step]: A list of Step objects.
        """

        if not steps_data:
            return []

        first_step = steps_data[0]
        if first_step.keyword_type not in STEP_TYPE_BY_PARSER_KEYWORD:
            raise StepError(
                message=f"First step in a scenario or background must start with 'Given', 'When' or 'Then', but got {first_step.keyword}.",
                line=first_step.location.line,
                line_content=first_step.text,
                filename=self.abs_filename,
            )

        steps = []
        current_type = STEP_TYPE_BY_PARSER_KEYWORD[first_step.keyword_type]
        for step in steps_data:
            current_type = STEP_TYPE_BY_PARSER_KEYWORD.get(step.keyword_type, current_type)
            steps.append(
                Step(
                    name=step.text,
                    type=current_type,
                    indent=step.location.column - 1,
                    line_number=step.location.line,
                    keyword=step.keyword.title(),
                    datatable=step.datatable,
                    docstring=step.docstring.content if step.docstring else None,
                )
            )
        return steps

    def parse_scenario(
        self, scenario_data: GherkinScenario, feature: Feature, rule: Rule | None = None
    ) -> ScenarioTemplate:
        """Parse a scenario data dictionary into a ScenarioTemplate object.