pytest-dev / pytest-dev/pytest

Add support for markers in doctests

Open
#5,794 6 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

plugin: doctests topic: marks type: enhancement
Dominant language
Python
Stars
14.5k
Forks
3.4k
Avg merge
2d 9h
Merged PRs (30d)
35

Description

It would be useful if also classes / methods / functions with doctests could be marked:

import pytest

@pytest.mark.custom_marker
def return_true():
    """Return True.

    >>> return_true()
    True
    """"
    return True

and then selected
$ pytest -m custom_marker

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 doctest example in the issue and investigate how pytest collects doctests and applies marker selection. Confirm the expected behavior for markers on doctest-containing classes, methods, and functions, then verify that pytest -m custom_marker selects only the marked doctests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.