19015773527

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

Build # 19015773527

Build Type

Pull #22816

github

Committed by

web-flow

Commit Message

Merge a12d75757 into 6c024e162

Pull Request Pull Request #22816: Update Pants internal Python to 3.14

Run Details

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

46.58

/src/python/pants/engine/console.py

# Copyright 2018 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
from __future__ import annotations

import sys
from collections.abc import Callable
from typing import TextIO

from colors import blue, cyan, green, magenta, red, yellow

from pants.engine.engine_aware import SideEffecting
from pants.engine.internals.scheduler import SchedulerSession


class Console(SideEffecting):
    """Class responsible for writing text to the console while Pants is running.

    A SchedulerSession should always be set in production usage, in order to track side effects, and
    tear down any running UI before stdio is rendered.
    """

    def __init__(
        self,
        stdin: TextIO | None = None,
        stdout: TextIO | None = None,
        stderr: TextIO | None = None,
        use_colors: bool = True,
        session: SchedulerSession | None = None,
    ):
        self._stdin = stdin or sys.stdin
        self._stdout = stdout or sys.stdout
        self._stderr = stderr or sys.stderr
        self._use_colors = use_colors
        self._session = session
        self._enforce_effects = self._session is not None

    @property
    def stdin(self) -> TextIO:
        if self._session:
            self.side_effected()
            self._session.teardown_dynamic_ui()
        return self._stdin

    @property
    def stdout(self) -> TextIO:
        if self._session:
            self.side_effected()
            self._session.teardown_dynamic_ui()
        return self._stdout

    @property
    def stderr(self) -> TextIO:
        if self._session:
            self.side_effected()
            self._session.teardown_dynamic_ui()
        return self._stderr

    def input(self, prompt: str | None = None) -> str:
        """Equivalent to the `input` builtin, but clears any running UI before rendering."""
        if prompt is not None:
            self.write_stdout(prompt)
        return self.stdin.readline().rstrip("\n")

    def write_stdout(self, payload: str) -> None:
        self.stdout.write(payload)

    def write_stderr(self, payload: str) -> None:
        self.stderr.write(payload)

    def print_stdout(self, payload: str, end: str = "\n") -> None:
        self.write_stdout(f"{payload}{end}")

    def print_stderr(self, payload: str, end: str = "\n") -> None:
        self.write_stderr(f"{payload}{end}")

    def flush(self) -> None:
        self._stdout.flush()
        self._stderr.flush()

    def sigil_succeeded(self) -> str:
        """Sigil for a successful item."""
        return self.green("✓")

    def sigil_succeeded_with_edits(self) -> str:
        """Sigil for a successful item which caused an edit to the workspace."""
        return self.yellow("+")

    def sigil_failed(self) -> str:
        """Sigil for a failed item."""
        return self.red("✕")

    def sigil_skipped(self) -> str:
        """Sigil for a skipped item."""
        return self.yellow("-")

    @property
    def use_colors(self):
        return self._use_colors

    def _safe_color(self, text: str, color: Callable[[str], str]) -> str:
        """We should only output color when the global flag --colors is enabled."""
        return color(text) if self._use_colors else text

    def blue(self, text: str) -> str:
        return self._safe_color(text, blue)

    def cyan(self, text: str) -> str:
        return self._safe_color(text, cyan)

    def green(self, text: str) -> str:
        return self._safe_color(text, green)

    def magenta(self, text: str) -> str:
        return self._safe_color(text, magenta)

    def red(self, text: str) -> str:
        return self._safe_color(text, red)

    def yellow(self, text: str) -> str:
        return self._safe_color(text, yellow)

1	# Copyright 2018 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3	from __future__ import annotations	1✔
4
5	import sys	1✔
6	from collections.abc import Callable	1✔
7	from typing import TextIO	1✔
8
9	from colors import blue, cyan, green, magenta, red, yellow	1✔
10
11	from pants.engine.engine_aware import SideEffecting	1✔
12	from pants.engine.internals.scheduler import SchedulerSession	1✔
13
14
15	class Console(SideEffecting):	1✔
16	"""Class responsible for writing text to the console while Pants is running.
17
18	A SchedulerSession should always be set in production usage, in order to track side effects, and
19	tear down any running UI before stdio is rendered.
20	"""
21
22	def __init__(	1✔
23	self,
24	stdin: TextIO \| None = None,
25	stdout: TextIO \| None = None,
26	stderr: TextIO \| None = None,
27	use_colors: bool = True,
28	session: SchedulerSession \| None = None,
29	):
UNCOV 30	self._stdin = stdin or sys.stdin	×
UNCOV 31	self._stdout = stdout or sys.stdout	×
UNCOV 32	self._stderr = stderr or sys.stderr	×
UNCOV 33	self._use_colors = use_colors	×
UNCOV 34	self._session = session	×
UNCOV 35	self._enforce_effects = self._session is not None	×
36
37	@property	1✔
38	def stdin(self) -> TextIO:	1✔
UNCOV 39	if self._session:	×
40	self.side_effected()	×
41	self._session.teardown_dynamic_ui()	×
UNCOV 42	return self._stdin	×
43
44	@property	1✔
45	def stdout(self) -> TextIO:	1✔
UNCOV 46	if self._session:	×
47	self.side_effected()	×
48	self._session.teardown_dynamic_ui()	×
UNCOV 49	return self._stdout	×
50
51	@property	1✔
52	def stderr(self) -> TextIO:	1✔
UNCOV 53	if self._session:	×
54	self.side_effected()	×
55	self._session.teardown_dynamic_ui()	×
UNCOV 56	return self._stderr	×
57
58	def input(self, prompt: str \| None = None) -> str:	1✔
59	"""Equivalent to the `input` builtin, but clears any running UI before rendering."""
UNCOV 60	if prompt is not None:	×
UNCOV 61	self.write_stdout(prompt)	×
UNCOV 62	return self.stdin.readline().rstrip("\n")	×
63
64	def write_stdout(self, payload: str) -> None:	1✔
UNCOV 65	self.stdout.write(payload)	×
66
67	def write_stderr(self, payload: str) -> None:	1✔
UNCOV 68	self.stderr.write(payload)	×
69
70	def print_stdout(self, payload: str, end: str = "\n") -> None:	1✔
UNCOV 71	self.write_stdout(f"{payload}{end}")	×
72
73	def print_stderr(self, payload: str, end: str = "\n") -> None:	1✔
UNCOV 74	self.write_stderr(f"{payload}{end}")	×
75
76	def flush(self) -> None:	1✔
UNCOV 77	self._stdout.flush()	×
UNCOV 78	self._stderr.flush()	×
79
80	def sigil_succeeded(self) -> str:	1✔
81	"""Sigil for a successful item."""
UNCOV 82	return self.green("✓")	×
83
84	def sigil_succeeded_with_edits(self) -> str:	1✔
85	"""Sigil for a successful item which caused an edit to the workspace."""
86	return self.yellow("+")	×
87
88	def sigil_failed(self) -> str:	1✔
89	"""Sigil for a failed item."""
UNCOV 90	return self.red("✕")	×
91
92	def sigil_skipped(self) -> str:	1✔
93	"""Sigil for a skipped item."""
94	return self.yellow("-")	×
95
96	@property	1✔
97	def use_colors(self):	1✔
98	return self._use_colors	×
99
100	def _safe_color(self, text: str, color: Callable[[str], str]) -> str:	1✔
101	"""We should only output color when the global flag --colors is enabled."""
UNCOV 102	return color(text) if self._use_colors else text	×
103
104	def blue(self, text: str) -> str:	1✔
105	return self._safe_color(text, blue)	×
106
107	def cyan(self, text: str) -> str:	1✔
108	return self._safe_color(text, cyan)	×
109
110	def green(self, text: str) -> str:	1✔
UNCOV 111	return self._safe_color(text, green)	×
112
113	def magenta(self, text: str) -> str:	1✔
114	return self._safe_color(text, magenta)	×
115
116	def red(self, text: str) -> str:	1✔
UNCOV 117	return self._safe_color(text, red)	×
118
119	def yellow(self, text: str) -> str:	1✔
120	return self._safe_color(text, yellow)	×

pantsbuild / pants / 19015773527

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

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