22740642519

Committed 05 Mar 2026 11:00PM UTC coverage: 52.677% (-40.3%) from 92.931%

Build # 22740642519

Build Type

Pull #23157

github

Committed by

web-flow

Commit Message

Merge 2aa18e6d4 into f0030f5e7

Pull Request Pull Request #23157: [pants ng] Partition source files by config.

Run Details

31678 of 60136 relevant lines covered (52.68%)

0.53 hits per line

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

0.0

/src/python/pants/backend/python/framework/django/dependency_inference.py

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

import json
from pathlib import PurePath

from pants.backend.python import dependency_inference
from pants.backend.python.dependency_inference.parse_python_dependencies import (
    ExplicitPythonDependencies,
    ParsedPythonAssetPaths,
    ParsedPythonImportInfo,
    ParsedPythonImports,
    PythonFileDependencies,
)
from pants.backend.python.dependency_inference.rules import (
    ImportOwnerStatus,
    PythonImportDependenciesInferenceFieldSet,
    ResolvedParsedPythonDependenciesRequest,
    resolve_parsed_dependencies,
)
from pants.backend.python.framework.django.detect_apps import DjangoApps
from pants.backend.python.subsystems.setup import PythonSetup
from pants.backend.python.target_types import EntryPoint
from pants.backend.python.util_rules import pex
from pants.backend.python.util_rules.interpreter_constraints import InterpreterConstraints
from pants.backend.python.util_rules.pex import PexRequest, VenvPexProcess, create_venv_pex
from pants.base.specs import FileGlobSpec, RawSpecs
from pants.core.util_rules.source_files import SourceFilesRequest
from pants.core.util_rules.stripped_source_files import strip_source_roots
from pants.engine.fs import CreateDigest, FileContent
from pants.engine.internals.graph import resolve_targets
from pants.engine.intrinsics import create_digest
from pants.engine.process import execute_process_or_raise
from pants.engine.rules import collect_rules, implicitly, rule
from pants.engine.target import InferDependenciesRequest, InferredDependencies
from pants.engine.unions import UnionRule
from pants.util.logging import LogLevel
from pants.util.resources import read_resource


class InferDjangoDependencies(InferDependenciesRequest):
    infer_from = PythonImportDependenciesInferenceFieldSet


_visitor_resource = "scripts/dependency_visitor.py"
_implicit_dependency_packages = (
    "management.commands",
    "migrations",
)


async def _django_migration_dependencies(
    request: InferDjangoDependencies,
    python_setup: PythonSetup,
    django_apps: DjangoApps,
) -> InferredDependencies:
    stripped_sources = await strip_source_roots(
        **implicitly(SourceFilesRequest([request.field_set.source]))
    )
    assert len(stripped_sources.snapshot.files) == 1

    file_content = FileContent("__visitor.py", read_resource(__name__, _visitor_resource))
    visitor_digest = await create_digest(CreateDigest([file_content]))
    venv_pex = await create_venv_pex(
        **implicitly(
            PexRequest(
                output_filename="__visitor.pex",
                internal_only=True,
                main=EntryPoint("__visitor"),
                interpreter_constraints=InterpreterConstraints.create_from_field_sets(
                    [request.field_set], python_setup=python_setup
                ),
                sources=visitor_digest,
            )
        )
    )
    process_result = await execute_process_or_raise(
        **implicitly(
            VenvPexProcess(
                venv_pex,
                argv=[stripped_sources.snapshot.files[0]],
                description=f"Determine Django app dependencies for {request.field_set.address}",
                input_digest=stripped_sources.snapshot.digest,
                level=LogLevel.DEBUG,
            )
        )
    )
    # See in script for where we explicitly encoded as utf8. Even though utf8 is the
    # default for decode(), we make that explicit here for emphasis.
    process_output = process_result.stdout.decode("utf8") or "{}"
    modules = [
        f"{django_apps.label_to_name[label]}.migrations.{migration}"
        for label, migration in json.loads(process_output)
        if label in django_apps.label_to_name
    ]
    resolve = request.field_set.resolve.normalized_value(python_setup)

    resolved_dependencies = await resolve_parsed_dependencies(
        ResolvedParsedPythonDependenciesRequest(
            request.field_set,
            PythonFileDependencies(
                ParsedPythonImports(
                    (module, ParsedPythonImportInfo(0, False)) for module in modules
                ),
                ParsedPythonAssetPaths(),
                ExplicitPythonDependencies(),
            ),
            resolve,
        ),
        **implicitly(),
    )

    return InferredDependencies(
        sorted(
            address
            for result in resolved_dependencies.resolve_results.values()
            if result.status in (ImportOwnerStatus.unambiguous, ImportOwnerStatus.disambiguated)
            for address in result.address
        )
    )


async def _django_app_implicit_dependencies(
    request: InferDjangoDependencies,
    python_setup: PythonSetup,
    django_apps: DjangoApps,
) -> InferredDependencies:
    file_path = request.field_set.source.file_path
    apps = [
        django_app for django_app in django_apps.values() if django_app.config_file == file_path
    ]
    if not apps:
        return InferredDependencies([])

    app_package = apps[0].name

    implicit_dependency_packages = [
        f"{app_package}.{subpackage}" for subpackage in _implicit_dependency_packages
    ]

    resolve = request.field_set.resolve.normalized_value(python_setup)

    resolved_dependencies = await resolve_parsed_dependencies(
        ResolvedParsedPythonDependenciesRequest(
            request.field_set,
            PythonFileDependencies(
                ParsedPythonImports(
                    (package, ParsedPythonImportInfo(0, False))
                    for package in implicit_dependency_packages
                ),
                ParsedPythonAssetPaths(),
                ExplicitPythonDependencies(),
            ),
            resolve,
        ),
        **implicitly(),
    )

    spec_paths = [
        address.spec_path
        for result in resolved_dependencies.resolve_results.values()
        if result.status in (ImportOwnerStatus.unambiguous, ImportOwnerStatus.disambiguated)
        for address in result.address
    ]

    targets = await resolve_targets(
        **implicitly(
            RawSpecs.create(
                specs=[FileGlobSpec(f"{spec_path}/*.py") for spec_path in spec_paths],
                description_of_origin="Django implicit dependency detection",
            )
        )
    )

    return InferredDependencies(sorted(target.address for target in targets))


@rule
async def infer_django_dependencies(
    request: InferDjangoDependencies,
    python_setup: PythonSetup,
    django_apps: DjangoApps,
) -> InferredDependencies:
    source_field = request.field_set.source
    # NB: This doesn't consider https://docs.djangoproject.com/en/4.2/ref/settings/#std-setting-MIGRATION_MODULES
    path = PurePath(source_field.file_path)
    if path.match("migrations/*.py"):
        return await _django_migration_dependencies(request, python_setup, django_apps)
    elif path.match("apps.py"):
        return await _django_app_implicit_dependencies(request, python_setup, django_apps)
    else:
        return InferredDependencies([])


def rules():
    return (
        *collect_rules(),
        *pex.rules(),
        *dependency_inference.rules.rules(),
        UnionRule(InferDependenciesRequest, InferDjangoDependencies),
    )

1	# Copyright 2023 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	import json	×
5	from pathlib import PurePath	×
6
7	from pants.backend.python import dependency_inference	×
8	from pants.backend.python.dependency_inference.parse_python_dependencies import (	×
9	ExplicitPythonDependencies,
10	ParsedPythonAssetPaths,
11	ParsedPythonImportInfo,
12	ParsedPythonImports,
13	PythonFileDependencies,
14	)
15	from pants.backend.python.dependency_inference.rules import (	×
16	ImportOwnerStatus,
17	PythonImportDependenciesInferenceFieldSet,
18	ResolvedParsedPythonDependenciesRequest,
19	resolve_parsed_dependencies,
20	)
21	from pants.backend.python.framework.django.detect_apps import DjangoApps	×
22	from pants.backend.python.subsystems.setup import PythonSetup	×
23	from pants.backend.python.target_types import EntryPoint	×
24	from pants.backend.python.util_rules import pex	×
25	from pants.backend.python.util_rules.interpreter_constraints import InterpreterConstraints	×
26	from pants.backend.python.util_rules.pex import PexRequest, VenvPexProcess, create_venv_pex	×
27	from pants.base.specs import FileGlobSpec, RawSpecs	×
28	from pants.core.util_rules.source_files import SourceFilesRequest	×
29	from pants.core.util_rules.stripped_source_files import strip_source_roots	×
30	from pants.engine.fs import CreateDigest, FileContent	×
31	from pants.engine.internals.graph import resolve_targets	×
32	from pants.engine.intrinsics import create_digest	×
33	from pants.engine.process import execute_process_or_raise	×
34	from pants.engine.rules import collect_rules, implicitly, rule	×
35	from pants.engine.target import InferDependenciesRequest, InferredDependencies	×
36	from pants.engine.unions import UnionRule	×
37	from pants.util.logging import LogLevel	×
38	from pants.util.resources import read_resource	×
39
40
41	class InferDjangoDependencies(InferDependenciesRequest):	×
42	infer_from = PythonImportDependenciesInferenceFieldSet	×
43
44
45	_visitor_resource = "scripts/dependency_visitor.py"	×
46	_implicit_dependency_packages = (	×
47	"management.commands",
48	"migrations",
49	)
50
51
52	async def _django_migration_dependencies(	×
53	request: InferDjangoDependencies,
54	python_setup: PythonSetup,
55	django_apps: DjangoApps,
56	) -> InferredDependencies:
57	stripped_sources = await strip_source_roots(	×
58	**implicitly(SourceFilesRequest([request.field_set.source]))
59	)
60	assert len(stripped_sources.snapshot.files) == 1	×
61
62	file_content = FileContent("__visitor.py", read_resource(__name__, _visitor_resource))	×
63	visitor_digest = await create_digest(CreateDigest([file_content]))	×
64	venv_pex = await create_venv_pex(	×
65	**implicitly(
66	PexRequest(
67	output_filename="__visitor.pex",
68	internal_only=True,
69	main=EntryPoint("__visitor"),
70	interpreter_constraints=InterpreterConstraints.create_from_field_sets(
71	[request.field_set], python_setup=python_setup
72	),
73	sources=visitor_digest,
74	)
75	)
76	)
77	process_result = await execute_process_or_raise(	×
78	**implicitly(
79	VenvPexProcess(
80	venv_pex,
81	argv=[stripped_sources.snapshot.files[0]],
82	description=f"Determine Django app dependencies for {request.field_set.address}",
83	input_digest=stripped_sources.snapshot.digest,
84	level=LogLevel.DEBUG,
85	)
86	)
87	)
88	# See in script for where we explicitly encoded as utf8. Even though utf8 is the
89	# default for decode(), we make that explicit here for emphasis.
90	process_output = process_result.stdout.decode("utf8") or "{}"	×
91	modules = [	×
92	f"{django_apps.label_to_name[label]}.migrations.{migration}"
93	for label, migration in json.loads(process_output)
94	if label in django_apps.label_to_name
95	]
96	resolve = request.field_set.resolve.normalized_value(python_setup)	×
97
98	resolved_dependencies = await resolve_parsed_dependencies(	×
99	ResolvedParsedPythonDependenciesRequest(
100	request.field_set,
101	PythonFileDependencies(
102	ParsedPythonImports(
103	(module, ParsedPythonImportInfo(0, False)) for module in modules
104	),
105	ParsedPythonAssetPaths(),
106	ExplicitPythonDependencies(),
107	),
108	resolve,
109	),
110	**implicitly(),
111	)
112
113	return InferredDependencies(	×
114	sorted(
115	address
116	for result in resolved_dependencies.resolve_results.values()
117	if result.status in (ImportOwnerStatus.unambiguous, ImportOwnerStatus.disambiguated)
118	for address in result.address
119	)
120	)
121
122
123	async def _django_app_implicit_dependencies(	×
124	request: InferDjangoDependencies,
125	python_setup: PythonSetup,
126	django_apps: DjangoApps,
127	) -> InferredDependencies:
128	file_path = request.field_set.source.file_path	×
129	apps = [	×
130	django_app for django_app in django_apps.values() if django_app.config_file == file_path
131	]
132	if not apps:	×
133	return InferredDependencies([])	×
134
135	app_package = apps[0].name	×
136
137	implicit_dependency_packages = [	×
138	f"{app_package}.{subpackage}" for subpackage in _implicit_dependency_packages
139	]
140
141	resolve = request.field_set.resolve.normalized_value(python_setup)	×
142
143	resolved_dependencies = await resolve_parsed_dependencies(	×
144	ResolvedParsedPythonDependenciesRequest(
145	request.field_set,
146	PythonFileDependencies(
147	ParsedPythonImports(
148	(package, ParsedPythonImportInfo(0, False))
149	for package in implicit_dependency_packages
150	),
151	ParsedPythonAssetPaths(),
152	ExplicitPythonDependencies(),
153	),
154	resolve,
155	),
156	**implicitly(),
157	)
158
159	spec_paths = [	×
160	address.spec_path
161	for result in resolved_dependencies.resolve_results.values()
162	if result.status in (ImportOwnerStatus.unambiguous, ImportOwnerStatus.disambiguated)
163	for address in result.address
164	]
165
166	targets = await resolve_targets(	×
167	**implicitly(
168	RawSpecs.create(
169	specs=[FileGlobSpec(f"{spec_path}/*.py") for spec_path in spec_paths],
170	description_of_origin="Django implicit dependency detection",
171	)
172	)
173	)
174
175	return InferredDependencies(sorted(target.address for target in targets))	×
176
177
178	@rule	×
179	async def infer_django_dependencies(	×
180	request: InferDjangoDependencies,
181	python_setup: PythonSetup,
182	django_apps: DjangoApps,
183	) -> InferredDependencies:
184	source_field = request.field_set.source	×
185	# NB: This doesn't consider https://docs.djangoproject.com/en/4.2/ref/settings/#std-setting-MIGRATION_MODULES
186	path = PurePath(source_field.file_path)	×
187	if path.match("migrations/*.py"):	×
188	return await _django_migration_dependencies(request, python_setup, django_apps)	×
189	elif path.match("apps.py"):	×
190	return await _django_app_implicit_dependencies(request, python_setup, django_apps)	×
191	else:
192	return InferredDependencies([])	×
193
194
195	def rules():	×
196	return (	×
197	*collect_rules(),
198	*pex.rules(),
199	*dependency_inference.rules.rules(),
200	UnionRule(InferDependenciesRequest, InferDjangoDependencies),
201	)

pantsbuild / pants / 22740642519

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