Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ lint:

.PHONY: test
test:
coverage run -m pytest
TZ=utc coverage run -m pytest
python tests/mypy_checks.py

.PHONY: testcov
Expand Down
2 changes: 1 addition & 1 deletion requirements/docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ packaging==23.1
# mkdocs
pathspec==0.11.1
# via black
platformdirs==3.4.0
platformdirs==3.5.0
Comment thread
samuelcolvin marked this conversation as resolved.
# via black
pygments==2.15.1
# via mkdocs-material
Expand Down
2 changes: 1 addition & 1 deletion requirements/linting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ packaging==23.1
# via black
pathspec==0.11.1
# via black
platformdirs==3.4.0
platformdirs==3.5.0
# via
# black
# virtualenv
Expand Down
2 changes: 1 addition & 1 deletion requirements/tests.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ pytest==7.3.1
# pytest-examples
# pytest-mock
# pytest-pretty
pytest-examples==0.0.8
pytest-examples==0.0.10
# via -r requirements/tests.in
pytest-mock==3.10.0
# via -r requirements/tests.in
Expand Down
22 changes: 15 additions & 7 deletions tests/test_docs.py
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
import platform
from pathlib import Path

import pytest
from pytest_examples import CodeExample, EvalExample, find_examples

root_dir = Path(__file__).parent.parent

examples = find_examples(
root_dir / 'dirty_equals',
root_dir / 'docs',
)


@pytest.mark.skipif(platform.python_implementation() == 'PyPy', reason='PyPy does not allow metaclass dunder methods')
@pytest.mark.parametrize('example', find_examples('dirty_equals', 'docs'), ids=str)
@pytest.mark.parametrize('example', examples, ids=str)
def test_docstrings(example: CodeExample, eval_example: EvalExample):
prefix_settings = example.prefix_settings()
# E711 and E712 refer to `== True` and `== None` and need to be ignored
# I001 refers is a problem with black and ruff disagreeing about blank lines :shrug:
eval_example.set_config(ruff_ignore=['E711', 'E712', 'I001'])

if prefix_settings.get('lint') != 'skip':
if eval_example.update_examples:
eval_example.format(example)
else:
eval_example.lint(example)

if prefix_settings.get('test') != 'skip':
if eval_example.update_examples:
eval_example.run_print_update(example)
else:
eval_example.run_print_check(example)

if prefix_settings.get('lint') != 'skip':
if eval_example.update_examples:
eval_example.format(example)
else:
eval_example.lint(example)