pytest-dev / pytest-dev/pytest-bdd

feature request: Use different colour for step arguments in terminal output

Open
#604 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.5k
Forks
251
Avg merge
43m
Merged PRs (30d)
2

Description

I have a feature defined like so:

Feature: Eating bananas
    Scenario Outline: Outlined given, when, then
        Given there are <start> bananas
        When I eat <eat> bananas
        Then I should have <left> bananas

        Examples:
        | start | eat | left |
        |  12   |  5  |  7   |
        |  12   |  3  |  9   |

The terminal output (pytest --gherkin-terminal-reporter) appears like so:

Feature: Eating bananas
    Scenario: Outlined given, when, then
        Given there are 12 bananas
        When I eat 5 bananas
        Then I should have 7 bananas
    PASSED

Feature: Eating bananas
    Scenario: Outlined given, when, then
        Given there are 12 bananas
        When I eat 3 bananas
        Then I should have 9 bananas
    PASSED
image

It would be rather nice if the step argument values (12 ,5, 7 then 12, 3, 9 in the examples above) appeared in a different colour.

I don't know how one should raise feature requests for this project so I hope this suffices.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the pytest --gherkin-terminal-reporter entry point and reproduce the terminal output using the feature example in this issue. Trace how step argument values are rendered, then make the values visually distinct from the surrounding step text and verify that the displayed arguments use a different colour.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, testing-qa
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.