• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

pantsbuild / pants / 19015773527

02 Nov 2025 05:33PM UTC coverage: 17.872% (-62.4%) from 80.3%
19015773527

Pull #22816

github

web-flow
Merge a12d75757 into 6c024e162
Pull Request #22816: Update Pants internal Python to 3.14

4 of 5 new or added lines in 3 files covered. (80.0%)

28452 existing lines in 683 files now uncovered.

9831 of 55007 relevant lines covered (17.87%)

0.18 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0
/src/python/pants/backend/python/subsystems/pytest.py
1
# Copyright 2016 Pants project contributors (see CONTRIBUTORS.md).
2
# Licensed under the Apache License, Version 2.0 (see LICENSE).
3

UNCOV
4
from __future__ import annotations
×
5

UNCOV
6
import os.path
×
UNCOV
7
from collections.abc import Iterable
×
UNCOV
8
from dataclasses import dataclass
×
9

UNCOV
10
from pants.backend.python.subsystems.python_tool_base import PythonToolBase
×
UNCOV
11
from pants.backend.python.target_types import (
×
12
    ConsoleScript,
13
    InterpreterConstraintsField,
14
    PythonResolveField,
15
    PythonTestsBatchCompatibilityTagField,
16
    PythonTestsExtraEnvVarsField,
17
    PythonTestSourceField,
18
    PythonTestsTimeoutField,
19
    PythonTestsXdistConcurrencyField,
20
    SkipPythonTestsField,
21
)
UNCOV
22
from pants.core.environments.target_types import EnvironmentField
×
UNCOV
23
from pants.core.goals.resolves import ExportableTool
×
UNCOV
24
from pants.core.goals.test import RuntimePackageDependenciesField, TestFieldSet
×
UNCOV
25
from pants.core.util_rules.config_files import ConfigFilesRequest
×
UNCOV
26
from pants.engine.rules import collect_rules
×
UNCOV
27
from pants.engine.target import Target
×
UNCOV
28
from pants.engine.unions import UnionRule
×
UNCOV
29
from pants.option.option_types import ArgsListOption, BoolOption, FileOption, SkipOption, StrOption
×
UNCOV
30
from pants.util.strutil import softwrap
×
31

32

UNCOV
33
@dataclass(frozen=True)
×
UNCOV
34
class PythonTestFieldSet(TestFieldSet):
×
UNCOV
35
    required_fields = (PythonTestSourceField,)
×
36

UNCOV
37
    source: PythonTestSourceField
×
UNCOV
38
    interpreter_constraints: InterpreterConstraintsField
×
UNCOV
39
    timeout: PythonTestsTimeoutField
×
UNCOV
40
    runtime_package_dependencies: RuntimePackageDependenciesField
×
UNCOV
41
    extra_env_vars: PythonTestsExtraEnvVarsField
×
UNCOV
42
    xdist_concurrency: PythonTestsXdistConcurrencyField
×
UNCOV
43
    batch_compatibility_tag: PythonTestsBatchCompatibilityTagField
×
UNCOV
44
    resolve: PythonResolveField
×
UNCOV
45
    environment: EnvironmentField
×
46

UNCOV
47
    @classmethod
×
UNCOV
48
    def opt_out(cls, tgt: Target) -> bool:
×
UNCOV
49
        return tgt.get(SkipPythonTestsField).value
×
50

51

UNCOV
52
class PyTest(PythonToolBase):
×
UNCOV
53
    options_scope = "pytest"
×
UNCOV
54
    name = "Pytest"
×
UNCOV
55
    help_short = "The pytest Python test framework (https://docs.pytest.org/)."
×
56

UNCOV
57
    default_requirements = [
×
58
        "pytest>=7,<9,!=7.1.0,!=7.1.1",
59
        "pytest-cov>=5,<7",
60
        "pytest-xdist>=3.6.1,<4",
61
    ]
62

UNCOV
63
    default_main = ConsoleScript("pytest")
×
64

UNCOV
65
    default_lockfile_resource = ("pants.backend.python.subsystems", "pytest.lock")
×
66

UNCOV
67
    args = ArgsListOption(example="-k test_foo --quiet", passthrough=True)
×
UNCOV
68
    junit_family = StrOption(
×
69
        default="xunit2",
70
        advanced=True,
71
        help=softwrap(
72
            """
73
            The format of generated junit XML files. See
74
            https://docs.pytest.org/en/latest/reference.html#confval-junit_family.
75
            """
76
        ),
77
    )
UNCOV
78
    execution_slot_var = StrOption(
×
79
        default=None,
80
        advanced=True,
81
        help=softwrap(
82
            """
83
            If a non-empty string, the process execution slot id (an integer) will be exposed
84
            to tests under this environment variable name.
85
            """
86
        ),
87
    )
UNCOV
88
    config = FileOption(
×
89
        default=None,
90
        advanced=True,
91
        help=lambda cls: softwrap(
92
            f"""
93
            Path to a config file understood by Pytest
94
            (https://docs.pytest.org/en/latest/reference/customize.html#configuration-file-formats).
95
            Setting this option will disable `[{cls.options_scope}].config_discovery`. Use
96
            this option if the config is located in a non-standard location.
97
            """
98
        ),
99
    )
UNCOV
100
    config_discovery = BoolOption(
×
101
        default=True,
102
        advanced=True,
103
        help=lambda cls: softwrap(
104
            f"""
105
            If true, Pants will include all relevant Pytest config files (e.g. `pytest.ini`)
106
            during runs. See
107
            https://docs.pytest.org/en/stable/customize.html#finding-the-rootdir for where
108
            config files should be located for Pytest to discover them.
109

110
            Use `[{cls.options_scope}].config` instead if your config is in a
111
            non-standard location.
112
            """
113
        ),
114
    )
UNCOV
115
    xdist_enabled = BoolOption(
×
116
        default=False,
117
        advanced=False,
118
        help=softwrap(
119
            """
120
            If true, Pants will use `pytest-xdist` (https://pytest-xdist.readthedocs.io/en/latest/)
121
            to parallelize tests within each `python_test` target.
122

123
            NOTE: Enabling `pytest-xdist` can cause high-level scoped fixtures (for example `session`)
124
            to execute more than once. See the `pytest-xdist` docs for more info:
125
            https://pypi.org/project/pytest-xdist/#making-session-scoped-fixtures-execute-only-once
126
            """
127
        ),
128
    )
129

UNCOV
130
    skip = SkipOption("test")
×
131

UNCOV
132
    def config_request(self, dirs: Iterable[str]) -> ConfigFilesRequest:
×
133
        # Refer to https://docs.pytest.org/en/stable/customize.html#finding-the-rootdir for how
134
        # config files are discovered.
135
        check_existence = []
×
136
        check_content = {}
×
137
        for d in ("", *dirs):
×
138
            check_existence.append(os.path.join(d, "pytest.ini"))
×
139
            check_content[os.path.join(d, "pyproject.toml")] = b"[tool.pytest.ini_options]"
×
140
            check_content[os.path.join(d, "tox.ini")] = b"[pytest]"
×
141
            check_content[os.path.join(d, "setup.cfg")] = b"[tool:pytest]"
×
142

143
        return ConfigFilesRequest(
×
144
            specified=self.config,
145
            specified_option_name=f"[{self.options_scope}].config",
146
            discovery=self.config_discovery,
147
            check_existence=check_existence,
148
            check_content=check_content,
149
        )
150

151

UNCOV
152
def rules():
×
UNCOV
153
    return (
×
154
        *collect_rules(),
155
        UnionRule(ExportableTool, PyTest),
156
    )
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc