File: conftest.py

package info (click to toggle)
pytest-check 2.7.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 480 kB
  • sloc: python: 2,220; sh: 17; makefile: 6
file content (53 lines) | stat: -rw-r--r-- 1,526 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
from typing import TYPE_CHECKING, Any, Callable, Optional

import pytest

pytest_plugins = "pytester"

if TYPE_CHECKING:
    from _pytest.pytester import Pytester

# RunResult is not available in type stubs, use Any as return type
RunResult = Any


@pytest.fixture
def run_example_test(pytester: "Pytester") -> Callable[..., "RunResult"]:
    """
    Fixture that returns a helper function to run tests from examples directory.

    Usage:
        def test_something(run_example_test):
            result = run_example_test("test_example_simple.py")
            result.assert_outcomes(passed=1)

    Args:
        pytester: The pytester fixture (injected by pytest)

    Returns:
        A function that takes (example_name, test_filter=None, *pytest_args) and returns RunResult
    """

    def _run_example_test(
        example_name: str,
        test_filter: Optional[str] = None,
        *pytest_args: str,
    ) -> "RunResult":
        """
        Helper function to run tests from examples directory.

        Args:
            example_name: Name of the example file (e.g., "test_example_simple.py")
            test_filter: Optional test filter for -k option
            *pytest_args: Additional pytest arguments

        Returns:
            RunResult from pytest execution
        """
        pytester.copy_example(f"examples/{example_name}")
        args = list(pytest_args)
        if test_filter:
            args.extend(["-k", test_filter])
        return pytester.runpytest(*args)

    return _run_example_test