pytest-dev / pytest-dev/pytest-bdd
Documentation request: pytest-bdd execution explanation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 251
- Avg merge
- 43m
- Merged PRs (30d)
- 2
Description
I found the docs helpful for describing the different components within the framework - like feature files, step definitions, scenario decorators, etc. - but not for explaining how they work together.
What exactly happens when you run pytest with pytest-bdd?
At a high level, I imagine it goes something like this:
- Scan for feature files
- Create list of scenarios and step definitions from feature files
- Scan for scenario and step definitions
- Create list of scenario/step definitions
- For each step in each scenario, try to find a step definition and execute if found
I wonder if adding a brief section describing how it the framework executes might help clarify how it is meant to be used.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing pytest-bdd documentation for feature files, step definitions, scenario decorators, and pytest execution; the issue names no specific file or test. Document the high-level execution flow from running pytest through scenario and step-definition matching, with the result being a brief explanation of how the components work together.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100