25441711719

Committed 06 May 2026 02:31PM UTC coverage: 92.915%. Remained the same

Build # 25441711719

Build Type

push

github

Committed by

web-flow

Commit Message

use sha pin (with comment) format for generated actions (#23312)

Per the GitHub Action best practices we recently enabled at #23249, we
should pin each action to a SHA so that the reference is actually
immutable.

This will -- I hope -- knock out a large chunk of the 421 alerts we
currently get from zizmor. The next followup would then be upgrades and
harmonizing the generated and none-generated pins.

Notice: This idea was suggested by Claude while going over pinact output
and I was surprised to see that post processing the yaml wasn't too
gross.

Coverage Stats

92206 of 99237 relevant lines covered (92.91%)

4.04 hits per line

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

87.18

/src/python/pants/backend/python/dependency_inference/parse_python_dependencies.py

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

import logging
import os
from collections.abc import Iterable
from dataclasses import dataclass
from fnmatch import fnmatchcase

from pants.backend.python.dependency_inference.subsystem import PythonInferSubsystem
from pants.core.util_rules.source_files import SourceFiles
from pants.core.util_rules.stripped_source_files import strip_source_roots
from pants.engine.collection import DeduplicatedCollection
from pants.engine.fs import CreateDigest, Digest, FileContent
from pants.engine.internals.native_engine import NativeDependenciesRequest
from pants.engine.intrinsics import create_digest, parse_python_deps
from pants.engine.rules import collect_rules, rule
from pants.util.frozendict import FrozenDict
from pants.util.logging import LogLevel
from pants.util.resources import read_resource

logger = logging.getLogger(__name__)


@dataclass(frozen=True, order=True)
class ParsedPythonImportInfo:
    lineno: int
    # An import is considered "weak" if we're unsure if a dependency will exist between the parsed
    # file and the parsed import.
    # Examples of "weak" imports include string imports (if enabled) or those inside a try block
    # which has a handler catching ImportError.
    weak: bool


class ParsedPythonImports(FrozenDict[str, ParsedPythonImportInfo]):
    """All the discovered imports from a Python source file mapped to the relevant info."""


class ParsedPythonAssetPaths(DeduplicatedCollection[str]):
    """All the discovered possible assets from a Python source file."""

    # N.B. Don't set `sort_input`, as the input is already sorted


# Map from argument of `pants: infer-dep(...)` to line number at which it appears.
class ExplicitPythonDependencies(FrozenDict[str, int]):
    """Dependencies provided via the # pants: infer-dep() pragma."""


# TODO: Use the Native* eqivalents of these classes directly? Would require
#  conversion to the component classes in Rust code. Might require passing
#  the PythonInferSubsystem settings through to Rust and acting on them there.


@dataclass(frozen=True)
class PythonFileDependencies:
    imports: ParsedPythonImports
    assets: ParsedPythonAssetPaths
    explicit_dependencies: ExplicitPythonDependencies


@dataclass(frozen=True)
class PythonFilesDependencies:
    path_to_deps: FrozenDict[str, PythonFileDependencies]


@dataclass(frozen=True)
class ParsePythonDependenciesRequest:
    source: SourceFiles


@dataclass(frozen=True)
class PythonDependencyVisitor:
    """Wraps a subclass of DependencyVisitorBase."""

    digest: Digest  # The file contents for the visitor
    classname: str  # The full classname, e.g., _my_custom_dep_parser.MyCustomVisitor
    env: FrozenDict[str, str]  # Set these env vars when invoking the visitor


@dataclass(frozen=True)
class ParserScript:
    digest: Digest
    env: FrozenDict[str, str]


_scripts_package = "pants.backend.python.dependency_inference.scripts"


def _is_ignored_string_import(module_path: str, ignored_patterns: tuple[str, ...]) -> bool:
    return any(fnmatchcase(module_path, ignored_pattern) for ignored_pattern in ignored_patterns)


async def get_scripts_digest(scripts_package: str, filenames: Iterable[str]) -> Digest:
    scripts = [read_resource(scripts_package, filename) for filename in filenames]
    assert all(script is not None for script in scripts)
    path_prefix = scripts_package.replace(".", os.path.sep)
    contents = [
        FileContent(os.path.join(path_prefix, relpath), script)
        for relpath, script in zip(filenames, scripts)
    ]

    # Python 2 requires all the intermediate __init__.py to exist in the sandbox.
    package = scripts_package
    while package:
        contents.append(
            FileContent(
                os.path.join(package.replace(".", os.path.sep), "__init__.py"),
                read_resource(package, "__init__.py"),
            )
        )
        package = package.rpartition(".")[0]

    digest = await create_digest(CreateDigest(contents))
    return digest


@rule(level=LogLevel.DEBUG)
async def parse_python_dependencies(
    request: ParsePythonDependenciesRequest,
    python_infer_subsystem: PythonInferSubsystem,
) -> PythonFilesDependencies:
    stripped_sources = await strip_source_roots(request.source)
    native_results = await parse_python_deps(
        NativeDependenciesRequest(stripped_sources.snapshot.digest)
    )

    path_to_deps = {}
    for path, native_result in native_results.path_to_deps.items():
        imports = dict(native_result.imports)
        assets = set()

        if python_infer_subsystem.string_imports or python_infer_subsystem.assets:
            for string, line in native_result.string_candidates.items():
                if (
                    python_infer_subsystem.string_imports
                    and not _is_ignored_string_import(
                        string, python_infer_subsystem.string_import_ignore
                    )
                    and string.count(".") >= python_infer_subsystem.string_imports_min_dots
                    and all(part.isidentifier() for part in string.split("."))
                ):
                    imports.setdefault(string, (line, True))
                if (
                    python_infer_subsystem.assets
                    and string.count("/") >= python_infer_subsystem.assets_min_slashes
                ):
                    assets.add(string)

        explicit_deps = dict(native_result.explicit_dependencies)

        path_to_deps[path] = PythonFileDependencies(
            ParsedPythonImports(
                (key, ParsedPythonImportInfo(*value)) for key, value in imports.items()
            ),
            ParsedPythonAssetPaths(sorted(assets)),
            ExplicitPythonDependencies(FrozenDict(explicit_deps)),
        )
    return PythonFilesDependencies(FrozenDict(path_to_deps))


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	from __future__ import annotations	12✔
4
5	import logging	12✔
6	import os	12✔
7	from collections.abc import Iterable	12✔
8	from dataclasses import dataclass	12✔
9	from fnmatch import fnmatchcase	12✔
10
11	from pants.backend.python.dependency_inference.subsystem import PythonInferSubsystem	12✔
12	from pants.core.util_rules.source_files import SourceFiles	12✔
13	from pants.core.util_rules.stripped_source_files import strip_source_roots	12✔
14	from pants.engine.collection import DeduplicatedCollection	12✔
15	from pants.engine.fs import CreateDigest, Digest, FileContent	12✔
16	from pants.engine.internals.native_engine import NativeDependenciesRequest	12✔
17	from pants.engine.intrinsics import create_digest, parse_python_deps	12✔
18	from pants.engine.rules import collect_rules, rule	12✔
19	from pants.util.frozendict import FrozenDict	12✔
20	from pants.util.logging import LogLevel	12✔
21	from pants.util.resources import read_resource	12✔
22
23	logger = logging.getLogger(__name__)	12✔
24
25
26	@dataclass(frozen=True, order=True)	12✔
27	class ParsedPythonImportInfo:	12✔
28	lineno: int	12✔
29	# An import is considered "weak" if we're unsure if a dependency will exist between the parsed
30	# file and the parsed import.
31	# Examples of "weak" imports include string imports (if enabled) or those inside a try block
32	# which has a handler catching ImportError.
33	weak: bool	12✔
34
35
36	class ParsedPythonImports(FrozenDict[str, ParsedPythonImportInfo]):	12✔
37	"""All the discovered imports from a Python source file mapped to the relevant info."""
38
39
40	class ParsedPythonAssetPaths(DeduplicatedCollection[str]):	12✔
41	"""All the discovered possible assets from a Python source file."""
42
43	# N.B. Don't set `sort_input`, as the input is already sorted
44
45
46	# Map from argument of `pants: infer-dep(...)` to line number at which it appears.
47	class ExplicitPythonDependencies(FrozenDict[str, int]):	12✔
48	"""Dependencies provided via the # pants: infer-dep() pragma."""
49
50
51	# TODO: Use the Native* eqivalents of these classes directly? Would require
52	# conversion to the component classes in Rust code. Might require passing
53	# the PythonInferSubsystem settings through to Rust and acting on them there.
54
55
56	@dataclass(frozen=True)	12✔
57	class PythonFileDependencies:	12✔
58	imports: ParsedPythonImports	12✔
59	assets: ParsedPythonAssetPaths	12✔
60	explicit_dependencies: ExplicitPythonDependencies	12✔
61
62
63	@dataclass(frozen=True)	12✔
64	class PythonFilesDependencies:	12✔
65	path_to_deps: FrozenDict[str, PythonFileDependencies]	12✔
66
67
68	@dataclass(frozen=True)	12✔
69	class ParsePythonDependenciesRequest:	12✔
70	source: SourceFiles	12✔
71
72
73	@dataclass(frozen=True)	12✔
74	class PythonDependencyVisitor:	12✔
75	"""Wraps a subclass of DependencyVisitorBase."""
76
77	digest: Digest # The file contents for the visitor	12✔
78	classname: str # The full classname, e.g., _my_custom_dep_parser.MyCustomVisitor	12✔
79	env: FrozenDict[str, str] # Set these env vars when invoking the visitor	12✔
80
81
82	@dataclass(frozen=True)	12✔
83	class ParserScript:	12✔
84	digest: Digest	12✔
85	env: FrozenDict[str, str]	12✔
86
87
88	_scripts_package = "pants.backend.python.dependency_inference.scripts"	12✔
89
90
91	def _is_ignored_string_import(module_path: str, ignored_patterns: tuple[str, ...]) -> bool:	12✔
92	return any(fnmatchcase(module_path, ignored_pattern) for ignored_pattern in ignored_patterns)	2✔
93
94
95	async def get_scripts_digest(scripts_package: str, filenames: Iterable[str]) -> Digest:	12✔
96	scripts = [read_resource(scripts_package, filename) for filename in filenames]	×
97	assert all(script is not None for script in scripts)	×
98	path_prefix = scripts_package.replace(".", os.path.sep)	×
99	contents = [	×
100	FileContent(os.path.join(path_prefix, relpath), script)
101	for relpath, script in zip(filenames, scripts)
102	]
103
104	# Python 2 requires all the intermediate __init__.py to exist in the sandbox.
105	package = scripts_package	×
106	while package:	×
107	contents.append(	×
108	FileContent(
109	os.path.join(package.replace(".", os.path.sep), "__init__.py"),
110	read_resource(package, "__init__.py"),
111	)
112	)
113	package = package.rpartition(".")[0]	×
114
115	digest = await create_digest(CreateDigest(contents))	×
116	return digest	×
117
118
119	@rule(level=LogLevel.DEBUG)	12✔
120	async def parse_python_dependencies(	12✔
121	request: ParsePythonDependenciesRequest,
122	python_infer_subsystem: PythonInferSubsystem,
123	) -> PythonFilesDependencies:
124	stripped_sources = await strip_source_roots(request.source)	11✔
125	native_results = await parse_python_deps(	11✔
126	NativeDependenciesRequest(stripped_sources.snapshot.digest)
127	)
128
129	path_to_deps = {}	11✔
130	for path, native_result in native_results.path_to_deps.items():	11✔
131	imports = dict(native_result.imports)	11✔
132	assets = set()	11✔
133
134	if python_infer_subsystem.string_imports or python_infer_subsystem.assets:	11✔
135	for string, line in native_result.string_candidates.items():	3✔
136	if (	3✔
137	python_infer_subsystem.string_imports
138	and not _is_ignored_string_import(
139	string, python_infer_subsystem.string_import_ignore
140	)
141	and string.count(".") >= python_infer_subsystem.string_imports_min_dots
142	and all(part.isidentifier() for part in string.split("."))
143	):
144	imports.setdefault(string, (line, True))	2✔
145	if (	3✔
146	python_infer_subsystem.assets
147	and string.count("/") >= python_infer_subsystem.assets_min_slashes
148	):
149	assets.add(string)	3✔
150
151	explicit_deps = dict(native_result.explicit_dependencies)	11✔
152
153	path_to_deps[path] = PythonFileDependencies(	11✔
154	ParsedPythonImports(
155	(key, ParsedPythonImportInfo(*value)) for key, value in imports.items()
156	),
157	ParsedPythonAssetPaths(sorted(assets)),
158	ExplicitPythonDependencies(FrozenDict(explicit_deps)),
159	)
160	return PythonFilesDependencies(FrozenDict(path_to_deps))	11✔
161
162
163	def rules():	12✔
164	return [	12✔
165	*collect_rules(),
166	]

pantsbuild / pants / 25441711719

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