25443604553

Committed 06 May 2026 03:05PM UTC coverage: 92.879% (-0.04%) from 92.915%

Build # 25443604553

Build Type

push

github

Committed by

web-flow

Commit Message

[pants_ng] Scaffolding for a pants_ng mode. (#23319)

In this mode the command line is parsed as an
NG invocation, and dispatched appropriately.

Of course at the moment there are no
implementations to dispatch to. That will follow.

This does expose a new option, `pants_ng` to users. 
There is a big warning not to set it, but we're not trying
to hide that we're working on a new thing, so I am
comfortable with this.

Coverage Stats

25 of 76 new or added lines in 9 files covered. (32.89%)

1294 existing lines in 76 files now uncovered.

92234 of 99306 relevant lines covered (92.88%)

4.05 hits per line

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

76.67

/src/python/pants/util/eval.py

# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from __future__ import annotations

from typing import Any

from pants.util.strutil import softwrap


def parse_expression(
    val: str, acceptable_types: type | tuple[type, ...], name: str | None = None
) -> Any:
    """Attempts to parse the given `val` as a python expression of the specified `acceptable_types`.

    :param val: A string containing a python expression.
    :param acceptable_types: The acceptable types of the parsed object.
    :param name: An optional logical name for the value being parsed; ie if the literal val
                        represents a person's age, 'age'.
    :raises: If `val` is not a valid python literal expression or it is but evaluates to an object
             that is not a an instance of one of the `acceptable_types`.
    """

    def format_type(typ):
        return typ.__name__

    if not isinstance(val, str):
        raise ValueError(
            f"The raw `val` is not a str.  Given {val} of type {format_type(type(val))}."
        )

    def get_name():
        return repr(name) if name else "value"

    def format_raw_value():
        lines = val.splitlines()
        for line_number in range(0, len(lines)):
            lines[line_number] = "{line_number:{width}}: {line}".format(
                line_number=line_number + 1, line=lines[line_number], width=len(str(len(lines)))
            )
        return "\n".join(lines)

    try:
        parsed_value = eval(val)
    except Exception as e:
        raise ValueError(
            softwrap(
                f"""
                The {get_name()} cannot be evaluated as a literal expression: {e!r}
                Given raw value:
                  {format_raw_value()}
                """
            )
        )

    if not isinstance(parsed_value, acceptable_types):

        def iter_types(types):
            if isinstance(types, type):
                yield types
            elif isinstance(types, tuple):
                for item in types:
                    yield from iter_types(item)
            else:
                raise ValueError(
                    f"The given acceptable_types is not a valid type (tuple): {acceptable_types}"
                )

        expected_types = ", ".join(format_type(t) for t in iter_types(acceptable_types))
        raise ValueError(
            softwrap(
                f"""
                The {get_name()} is not of the expected type(s): {expected_types}:
                Given the following raw value that evaluated to type {format_type(type(parsed_value))}:
                  {format_raw_value()}
                """
            )
        )
    return parsed_value

1	# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	12✔
5
6	from typing import Any	12✔
7
8	from pants.util.strutil import softwrap	12✔
9
10
11	def parse_expression(	12✔
12	val: str, acceptable_types: type \| tuple[type, ...], name: str \| None = None
13	) -> Any:
14	"""Attempts to parse the given `val` as a python expression of the specified `acceptable_types`.
15
16	:param val: A string containing a python expression.
17	:param acceptable_types: The acceptable types of the parsed object.
18	:param name: An optional logical name for the value being parsed; ie if the literal val
19	represents a person's age, 'age'.
20	:raises: If `val` is not a valid python literal expression or it is but evaluates to an object
21	that is not a an instance of one of the `acceptable_types`.
22	"""
23
24	def format_type(typ):	3✔
UNCOV 25	return typ.__name__	1✔
26
27	if not isinstance(val, str):	3✔
28	raise ValueError(	×
29	f"The raw `val` is not a str. Given {val} of type {format_type(type(val))}."
30	)
31
32	def get_name():	3✔
UNCOV 33	return repr(name) if name else "value"	1✔
34
35	def format_raw_value():	3✔
UNCOV 36	lines = val.splitlines()	1✔
UNCOV 37	for line_number in range(0, len(lines)):	1✔
UNCOV 38	lines[line_number] = "{line_number:{width}}: {line}".format(	1✔
39	line_number=line_number + 1, line=lines[line_number], width=len(str(len(lines)))
40	)
UNCOV 41	return "\n".join(lines)	1✔
42
43	try:	3✔
44	parsed_value = eval(val)	3✔
45	except Exception as e:	×
46	raise ValueError(	×
47	softwrap(
48	f"""
49	The {get_name()} cannot be evaluated as a literal expression: {e!r}
50	Given raw value:
51	{format_raw_value()}
52	"""
53	)
54	)
55
56	if not isinstance(parsed_value, acceptable_types):	3✔
57
UNCOV 58	def iter_types(types):	1✔
UNCOV 59	if isinstance(types, type):	1✔
UNCOV 60	yield types	1✔
61	elif isinstance(types, tuple):	×
62	for item in types:	×
63	yield from iter_types(item)	×
64	else:
65	raise ValueError(	×
66	f"The given acceptable_types is not a valid type (tuple): {acceptable_types}"
67	)
68
UNCOV 69	expected_types = ", ".join(format_type(t) for t in iter_types(acceptable_types))	1✔
UNCOV 70	raise ValueError(	1✔
71	softwrap(
72	f"""
73	The {get_name()} is not of the expected type(s): {expected_types}:
74	Given the following raw value that evaluated to type {format_type(type(parsed_value))}:
75	{format_raw_value()}
76	"""
77	)
78	)
79	return parsed_value	3✔

pantsbuild / pants / 25443604553

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