Skip to content

Working with module_globals #56

Open

Description

@TiemenSch

So i tried to inject some fixtures as "module_globals" into my doctests, but I can't seem to get it to work.

I've tried the following:

from pathlib import Path

import pytest
from pytest_examples import CodeExample, EvalExample, find_examples

DOCS_DIR = Path(__file__).parent.parent / "docs"
DOCS_FILES = DOCS_DIR.glob("**/*.md")

@pytest.mark.parametrize("example", find_examples(*DOCS_FILES), ids=str)
def test_docs(
    example: CodeExample,
    eval_example: EvalExample,
    datadir: Path,
):
    """Test the package's documentation."""

    globals = dict(datadir=datadir, foo=2)

    eval_example.set_config(line_length=88)
    if eval_example.update_examples:
        eval_example.format(example)
        eval_example.run_print_update(example, module_globals=globals)
    else:
        eval_example.lint(example)
        eval_example.run_print_check(example, module_globals=globals)

where my example Markdown file is picked up fine in the documentation directory, but the examples

assert datadir

and

assert foo == 2

both fail.

I can't find documentation on the feature, but would love to know how it's supposed to work!

Activity

  1. TiemenSch commented on Feb 14, 2025

    @TiemenSch
    Author

    Ah, it turned out that ruff's formatting failed on variables being undefined. Adding

    eval_example.set_config(ruff_ignore=["F821"])

    did wonders already

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions