nvim-neotest / nvim-neotest/neotest-python

Add support for Python doctests

Open
#20 5 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
192
Forks
60
PR merge metrics
No merged PRs in 30d

Description

As in the title. For me, the most important thing is to be able to run tests from in-code Docstrings, but as far as I know, it is also possible to have them in other text files, for example in documentation. pytest has options to run doctests. It would be nice if one could run doctests together with the other framework, as these are rather a complement, not displacement. Not as with unittest–pytest dichotomy.

https://docs.python.org/3/library/doctest.html

Contributor guide

No contributing guide indexed for this repository

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 doctest options and Python doctest documentation linked in the issue. Trace how neotest-python currently runs pytest, then determine how in-code docstrings and documentation text files should run alongside existing tests. Done means doctests execute together with the framework's other tests.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.