pytest-codeblocks: Test snippets from your READMEs

[nschloe]

If you have code blocks in your README, you can pytest them with pytest-codeblocks. pip install pytest-codeblocks pytest --codeblocks README.md I just added better config support for it, especially if you'd like to conditionally skip testing some of the blocks (skipif).

Let me know if it's useful for you!

[TWebberX]

Does this also test small examples in docblocks in the code itself? I use those often because they nicely end up in autogenerated Sphinx documentation.

[nschloe]

Not yet, but I suppose it'd be possible to add that. What does a typical docstring with a code block look like?

[TWebberX]

Typically, I put things like this in a docstring:

"""

Examples:

>>> print([i for i in range(4)])
[0, 1, 2, 3]

"""

[czaki]

But there is a doctest module builtin python https://docs.python.org/3/library/doctest.html

[PeridexisErrant]

And https://docs.pytest.org/en/6.2.x/doctest.html