forked from pantsbuild/pants
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pipenv_requirements.py
153 lines (128 loc) · 5.27 KB
/
pipenv_requirements.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
from __future__ import annotations
import json
from packaging.utils import canonicalize_name as canonicalize_project_name
from pants.backend.python.macros.common_fields import (
ModuleMappingField,
RequirementsOverrideField,
TypeStubsModuleMappingField,
)
from pants.backend.python.pip_requirement import PipRequirement
from pants.backend.python.target_types import (
PythonRequirementModulesField,
PythonRequirementsField,
PythonRequirementsFileSourcesField,
PythonRequirementsFileTarget,
PythonRequirementTarget,
PythonRequirementTypeStubModulesField,
)
from pants.engine.addresses import Address
from pants.engine.fs import DigestContents, GlobMatchErrorBehavior, PathGlobs
from pants.engine.rules import Get, collect_rules, rule
from pants.engine.target import (
COMMON_TARGET_FIELDS,
Dependencies,
GeneratedTargets,
GenerateTargetsRequest,
InvalidFieldException,
SingleSourceField,
StringField,
Target,
)
from pants.engine.unions import UnionRule
from pants.util.logging import LogLevel
class PipenvSourceField(SingleSourceField):
default = "Pipfile.lock"
required = False
class PipenvPipfileTargetField(StringField):
alias = "pipfile_target"
help = "Deprecated: no longer necessary."
removal_version = "2.11.0.dev0"
removal_hint = "This field is no longer necessary."
class PipenvRequirementsTargetGenerator(Target):
alias = "pipenv_requirements"
help = "Generate a `python_requirement` for each entry in `Pipenv.lock`."
core_fields = (
*COMMON_TARGET_FIELDS,
ModuleMappingField,
TypeStubsModuleMappingField,
PipenvSourceField,
PipenvPipfileTargetField,
RequirementsOverrideField,
)
class GenerateFromPipenvRequirementsRequest(GenerateTargetsRequest):
generate_from = PipenvRequirementsTargetGenerator
# TODO(#10655): add support for PEP 440 direct references (aka VCS style).
# TODO(#10655): differentiate between Pipfile vs. Pipfile.lock.
@rule(desc="Generate `python_requirement` targets from Pipfile.lock", level=LogLevel.DEBUG)
async def generate_from_pipenv_requirement(
request: GenerateFromPipenvRequirementsRequest,
) -> GeneratedTargets:
generator = request.generator
lock_rel_path = generator[PipenvSourceField].value
lock_full_path = generator[PipenvSourceField].file_path
file_tgt = PythonRequirementsFileTarget(
{PythonRequirementsFileSourcesField.alias: lock_rel_path},
Address(
generator.address.spec_path,
target_name=generator.address.target_name,
relative_file_path=lock_rel_path,
),
)
digest_contents = await Get(
DigestContents,
PathGlobs(
[lock_full_path],
glob_match_error_behavior=GlobMatchErrorBehavior.error,
description_of_origin=f"{generator}'s field `{PipenvSourceField.alias}`",
),
)
lock_info = json.loads(digest_contents[0].content)
module_mapping = generator[ModuleMappingField].value
stubs_mapping = generator[TypeStubsModuleMappingField].value
overrides = generator[RequirementsOverrideField].flatten_and_normalize()
def generate_tgt(raw_req: str, info: dict) -> PythonRequirementTarget:
if info.get("extras"):
raw_req += f"[{','.join(info['extras'])}]"
raw_req += info.get("version", "")
if info.get("markers"):
raw_req += f";{info['markers']}"
parsed_req = PipRequirement.parse(raw_req)
normalized_proj_name = canonicalize_project_name(parsed_req.project_name)
tgt_overrides = overrides.pop(normalized_proj_name, {})
if Dependencies.alias in tgt_overrides:
tgt_overrides[Dependencies.alias] = list(tgt_overrides[Dependencies.alias]) + [
file_tgt.address.spec
]
# TODO: Consider letting you set metadata in the target generator and having it pass down
# to all generated targets. Especially useful for compatible_resolves.
return PythonRequirementTarget(
{
PythonRequirementsField.alias: [parsed_req],
PythonRequirementModulesField.alias: module_mapping.get(normalized_proj_name),
PythonRequirementTypeStubModulesField.alias: stubs_mapping.get(
normalized_proj_name
),
# This may get overridden by `tgt_overrides`, which will have already added in
# the file tgt.
Dependencies.alias: [file_tgt.address.spec],
**tgt_overrides,
},
generator.address.create_generated(parsed_req.project_name),
)
result = tuple(
generate_tgt(req, info)
for req, info in {**lock_info.get("default", {}), **lock_info.get("develop", {})}.items()
) + (file_tgt,)
if overrides:
raise InvalidFieldException(
f"Unused key in the `overrides` field for {request.generator.address}: "
f"{sorted(overrides)}"
)
return GeneratedTargets(generator, result)
def rules():
return (
*collect_rules(),
UnionRule(GenerateTargetsRequest, GenerateFromPipenvRequirementsRequest),
)