20632486505

Committed 01 Jan 2026 04:21AM UTC coverage: 43.231% (-37.1%) from 80.281%

Build # 20632486505

Build Type

Pull #22962

github

Committed by

web-flow

Commit Message

Merge 08d5c63b0 into f52ab6675

Pull Request Pull Request #22962: Bump the gha-deps group across 1 directory with 6 updates

Run Details

26122 of 60424 relevant lines covered (43.23%)

0.86 hits per line

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

46.34

/src/python/pants/backend/python/util_rules/ancestor_files.py

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

from __future__ import annotations

import os
from dataclasses import dataclass

from pants.engine.fs import EMPTY_SNAPSHOT, PathGlobs, Snapshot
from pants.engine.intrinsics import digest_to_snapshot, get_digest_contents
from pants.engine.rules import collect_rules, implicitly, rule


@dataclass(frozen=True)
class AncestorFilesRequest:
    """A request for ancestor files of the given names.

    "Ancestor files" means all files with one of the given names that are siblings of, or in parent
    directories of, a `.py` or `.pyi` file in the input_files.
    """

    input_files: tuple[str, ...]
    requested: tuple[str, ...]
    ignore_empty_files: bool = False


@dataclass(frozen=True)
class AncestorFiles:
    """Any ancestor files found."""

    snapshot: Snapshot


def putative_ancestor_files(input_files: tuple[str, ...], requested: tuple[str, ...]) -> set[str]:
    """Return the paths of potentially missing ancestor files.

    NB: The sources are expected to not have had their source roots stripped.
    Therefore this function will consider superfluous files at and above the source roots,
    (e.g., src/python/<name>, src/<name>). It is the caller's responsibility to filter these
    out if necessary.
    """
    packages: set[str] = set()
    for input_file in input_files:
        if not input_file.endswith((".py", ".pyi")):
            continue
        pkg_dir = os.path.dirname(input_file)
        if pkg_dir in packages:
            continue
        package = ""
        packages.add(package)
        for component in pkg_dir.split(os.sep):
            package = os.path.join(package, component)
            packages.add(package)

    return {
        os.path.join(package, requested_f) for package in packages for requested_f in requested
    } - set(input_files)


@rule
async def find_ancestor_files(request: AncestorFilesRequest) -> AncestorFiles:
    putative = putative_ancestor_files(request.input_files, request.requested)
    if not putative:
        return AncestorFiles(EMPTY_SNAPSHOT)

    # NB: This will intentionally _not_ error on any unmatched globs.
    globs = PathGlobs(putative)
    if request.ignore_empty_files:
        digest_contents = await get_digest_contents(**implicitly({globs: PathGlobs}))
        snapshot = await digest_to_snapshot(
            **implicitly(PathGlobs([fc.path for fc in digest_contents if fc.content.strip()]))
        )
    else:
        snapshot = await digest_to_snapshot(**implicitly({globs: PathGlobs}))

    return AncestorFiles(snapshot)


def rules():
    return collect_rules()

1	# Copyright 2020 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	2✔
5
6	import os	2✔
7	from dataclasses import dataclass	2✔
8
9	from pants.engine.fs import EMPTY_SNAPSHOT, PathGlobs, Snapshot	2✔
10	from pants.engine.intrinsics import digest_to_snapshot, get_digest_contents	2✔
11	from pants.engine.rules import collect_rules, implicitly, rule	2✔
12
13
14	@dataclass(frozen=True)	2✔
15	class AncestorFilesRequest:	2✔
16	"""A request for ancestor files of the given names.
17
18	"Ancestor files" means all files with one of the given names that are siblings of, or in parent
19	directories of, a `.py` or `.pyi` file in the input_files.
20	"""
21
22	input_files: tuple[str, ...]	2✔
23	requested: tuple[str, ...]	2✔
24	ignore_empty_files: bool = False	2✔
25
26
27	@dataclass(frozen=True)	2✔
28	class AncestorFiles:	2✔
29	"""Any ancestor files found."""
30
31	snapshot: Snapshot	2✔
32
33
34	def putative_ancestor_files(input_files: tuple[str, ...], requested: tuple[str, ...]) -> set[str]:	2✔
35	"""Return the paths of potentially missing ancestor files.
36
37	NB: The sources are expected to not have had their source roots stripped.
38	Therefore this function will consider superfluous files at and above the source roots,
39	(e.g., src/python/<name>, src/<name>). It is the caller's responsibility to filter these
40	out if necessary.
41	"""
42	packages: set[str] = set()	×
43	for input_file in input_files:	×
44	if not input_file.endswith((".py", ".pyi")):	×
45	continue	×
46	pkg_dir = os.path.dirname(input_file)	×
47	if pkg_dir in packages:	×
48	continue	×
49	package = ""	×
50	packages.add(package)	×
51	for component in pkg_dir.split(os.sep):	×
52	package = os.path.join(package, component)	×
53	packages.add(package)	×
54
55	return {	×
56	os.path.join(package, requested_f) for package in packages for requested_f in requested
57	} - set(input_files)
58
59
60	@rule	2✔
61	async def find_ancestor_files(request: AncestorFilesRequest) -> AncestorFiles:	2✔
62	putative = putative_ancestor_files(request.input_files, request.requested)	×
63	if not putative:	×
64	return AncestorFiles(EMPTY_SNAPSHOT)	×
65
66	# NB: This will intentionally _not_ error on any unmatched globs.
67	globs = PathGlobs(putative)	×
68	if request.ignore_empty_files:	×
69	digest_contents = await get_digest_contents(**implicitly({globs: PathGlobs}))	×
70	snapshot = await digest_to_snapshot(	×
71	**implicitly(PathGlobs([fc.path for fc in digest_contents if fc.content.strip()]))
72	)
73	else:
74	snapshot = await digest_to_snapshot(**implicitly({globs: PathGlobs}))	×
75
76	return AncestorFiles(snapshot)	×
77
78
79	def rules():	2✔
80	return collect_rules()	2✔

pantsbuild / pants / 20632486505

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