21803785359

Committed 08 Feb 2026 07:13PM UTC coverage: 43.3% (-37.0%) from 80.277%

Build # 21803785359

Build Type

Pull #23085

github

Committed by

web-flow

Commit Message

Merge 7c1cd926d into 40389cc58

Pull Request Pull Request #23085: A helper method for indexing paths by source root

Run Details

2 of 6 new or added lines in 1 file covered. (33.33%)

17114 existing lines in 539 files now uncovered.

26075 of 60219 relevant lines covered (43.3%)

0.43 hits per line

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

70.83

/src/python/pants/core/util_rules/distdir.py

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

from dataclasses import dataclass
from pathlib import Path

from pants.base.build_root import BuildRoot
from pants.engine.rules import collect_rules, rule
from pants.option.global_options import GlobalOptions
from pants.util.strutil import softwrap


def is_child_of(path: Path, directory: Path) -> bool:
    abs_path = path if path.is_absolute() else directory.joinpath(path).resolve()
    return directory == abs_path or directory in abs_path.parents


class InvalidDistDir(Exception):
    pass


@dataclass(frozen=True)
class DistDir:
    """The directory to which we write distributable files."""

    relpath: Path


@rule
async def get_distdir(global_options: GlobalOptions, buildroot: BuildRoot) -> DistDir:
    return validate_distdir(Path(global_options.pants_distdir), buildroot.pathlib_path)


def validate_distdir(distdir: Path, buildroot: Path) -> DistDir:
    if not is_child_of(distdir, buildroot):
        raise InvalidDistDir(
            softwrap(
                f"""
            When set to an absolute path, `--pants-distdir` must be relative to the build root.
            You set it to {distdir}. Instead, use a relative path or an absolute path relative
            to the build root.
            """
            )
        )
    relpath = distdir.relative_to(buildroot) if distdir.is_absolute() else distdir
    return DistDir(relpath)


def rules():
    return collect_rules()

1	# Copyright 2019 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from dataclasses import dataclass	1✔
5	from pathlib import Path	1✔
6
7	from pants.base.build_root import BuildRoot	1✔
8	from pants.engine.rules import collect_rules, rule	1✔
9	from pants.option.global_options import GlobalOptions	1✔
10	from pants.util.strutil import softwrap	1✔
11
12
13	def is_child_of(path: Path, directory: Path) -> bool:	1✔
UNCOV 14	abs_path = path if path.is_absolute() else directory.joinpath(path).resolve()	×
UNCOV 15	return directory == abs_path or directory in abs_path.parents	×
16
17
18	class InvalidDistDir(Exception):	1✔
19	pass	1✔
20
21
22	@dataclass(frozen=True)	1✔
23	class DistDir:	1✔
24	"""The directory to which we write distributable files."""
25
26	relpath: Path	1✔
27
28
29	@rule	1✔
30	async def get_distdir(global_options: GlobalOptions, buildroot: BuildRoot) -> DistDir:	1✔
31	return validate_distdir(Path(global_options.pants_distdir), buildroot.pathlib_path)	×
32
33
34	def validate_distdir(distdir: Path, buildroot: Path) -> DistDir:	1✔
UNCOV 35	if not is_child_of(distdir, buildroot):	×
UNCOV 36	raise InvalidDistDir(	×
37	softwrap(
38	f"""
39	When set to an absolute path, `--pants-distdir` must be relative to the build root.
40	You set it to {distdir}. Instead, use a relative path or an absolute path relative
41	to the build root.
42	"""
43	)
44	)
UNCOV 45	relpath = distdir.relative_to(buildroot) if distdir.is_absolute() else distdir	×
UNCOV 46	return DistDir(relpath)	×
47
48
49	def rules():	1✔
50	return collect_rules()	1✔

pantsbuild / pants / 21803785359

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