/
core.py
424 lines (370 loc) · 14.8 KB
/
core.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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
from __future__ import annotations
import hashlib
import json
import os
import re
from pathlib import Path
from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Type, Union
import halo
import tomlkit
from pip._vendor.pkg_resources import safe_name
from pip_shims import shims
from pdm._types import Source
from pdm.exceptions import ProjectError
from pdm.iostream import stream
from pdm.models.caches import CandidateInfoCache, HashCache
from pdm.models.candidates import Candidate, identify
from pdm.models.environment import Environment, GlobalEnvironment
from pdm.models.repositories import BaseRepository, PyPIRepository
from pdm.models.requirements import Requirement, parse_requirement, strip_extras
from pdm.models.specifiers import PySpecSet
from pdm.project.config import Config
from pdm.project.meta import PackageMeta
from pdm.resolver import BaseProvider, EagerUpdateProvider, ReusePinProvider
from pdm.resolver.reporters import SpinnerReporter
from pdm.utils import (
atomic_open_for_write,
cached_property,
find_project_root,
get_python_version,
get_venv_python,
)
if TYPE_CHECKING:
from tomlkit.container import Container
class Project:
"""Core project class"""
PYPROJECT_FILENAME = "pyproject.toml"
PDM_NAMESPACE = "tool.pdm"
DEPENDENCIES_RE = re.compile(r"(?:(.+?)-)?dependencies")
PYPROJECT_VERSION = "0.0.1"
GLOBAL_PROJECT = Path.home() / ".pdm" / "global-project"
@classmethod
def create_global(cls, root_path: Optional[str] = None) -> "Project":
if root_path is None:
root_path = cls.GLOBAL_PROJECT.as_posix()
project = cls(root_path)
project.is_global = True
project.init_global_project()
return project
def __init__(self, root_path: Optional[str] = None) -> None:
self.is_global = False
self._pyproject = None # type: Optional[Container]
self._lockfile = None # type: Optional[Container]
self.core = None
if root_path is None:
root_path = find_project_root()
if root_path is None and self.global_config["auto_global"]:
self.root = self.GLOBAL_PROJECT
self.is_global = True
self.init_global_project()
else:
self.root = Path(root_path or "").absolute()
def __repr__(self) -> str:
return f"<Project '{self.root.as_posix()}'>"
@property
def pyproject_file(self) -> Path:
return self.root / self.PYPROJECT_FILENAME
@property
def lockfile_file(self) -> Path:
return self.root / "pdm.lock"
@property
def pyproject(self):
# type: () -> Container
if not self._pyproject and self.pyproject_file.exists():
data = tomlkit.parse(self.pyproject_file.read_text("utf-8"))
self._pyproject = data
return self._pyproject
@pyproject.setter
def pyproject(self, data):
self._pyproject = data
@property
def tool_settings(self):
# type: () -> Union[Container, Dict]
data = self.pyproject
if not data:
return {}
for sec in self.PDM_NAMESPACE.split("."):
# setdefault has bug
if sec not in data:
data[sec] = {}
data = data[sec]
return data
@property
def lockfile(self):
# type: () -> Container
if not self.lockfile_file.is_file():
raise ProjectError("Lock file does not exist.")
if not self._lockfile:
data = tomlkit.parse(self.lockfile_file.read_text("utf-8"))
self._lockfile = data
return self._lockfile
@property
def config(self) -> Dict[str, Any]:
"""A read-only dict configuration, any modifications won't land in the file."""
result = dict(self.global_config)
result.update(self.project_config)
return result
@cached_property
def global_config(self) -> Config:
"""Read-and-writable configuration dict for global settings"""
return Config(Path.home() / ".pdm" / "config.toml", is_global=True)
@cached_property
def project_config(self) -> Config:
"""Read-and-writable configuration dict for project settings"""
return Config(self.root / ".pdm.toml")
@property
def is_pdm(self) -> bool:
if not self.pyproject_file.is_file():
return False
return bool(self.tool_settings)
@cached_property
def environment(self) -> Environment:
if self.is_global:
env = GlobalEnvironment(self)
# Rewrite global project's python requires to be
# compatible with the exact version
env.python_requires = PySpecSet(
"==" + get_python_version(env.python_executable, True)
)
return env
if self.config["use_venv"] and "VIRTUAL_ENV" in os.environ:
self.project_config["python.path"] = get_venv_python()
return GlobalEnvironment(self)
return Environment(self)
@property
def python_requires(self) -> PySpecSet:
return PySpecSet(self.tool_settings.get("python_requires", ""))
def get_dependencies(self, section: Optional[str] = None) -> Dict[str, Requirement]:
if section in (None, "default"):
deps = self.tool_settings.get("dependencies", [])
elif section == "dev":
deps = self.tool_settings.get("dev-dependencies", [])
else:
deps = self.tool_settings[f"{section}-dependencies"]
result = {}
for name, dep in deps.items():
req = Requirement.from_req_dict(name, dep)
req.from_section = section or "default"
result[identify(req)] = req
return result
@property
def dependencies(self) -> Dict[str, Requirement]:
return self.get_dependencies()
@property
def dev_dependencies(self) -> Dict[str, Requirement]:
return self.get_dependencies("dev")
def iter_sections(self) -> Iterable[str]:
for key in self.tool_settings:
match = self.DEPENDENCIES_RE.match(key)
if not match:
continue
section = match.group(1) or "default"
yield section
@property
def all_dependencies(self) -> Dict[str, Dict[str, Requirement]]:
return {
section: self.get_dependencies(section) for section in self.iter_sections()
}
@property
def allow_prereleases(self) -> Optional[bool]:
return self.tool_settings.get("allow_prereleases")
@property
def sources(self) -> List[Source]:
sources = self.tool_settings.get("source", [])
if not any(source.get("name") == "pypi" for source in sources):
sources.insert(
0,
{
"url": self.config["pypi.url"],
"verify_ssl": self.config["pypi.verify_ssl"],
"name": "pypi",
},
)
return sources
def get_repository(self, cls: Optional[Type[BaseRepository]]) -> BaseRepository:
"""Get the repository object"""
if cls is None:
cls = PyPIRepository
sources = self.sources or []
return cls(sources, self.environment)
def get_provider(
self, strategy: str = "all", tracked_names: Optional[Iterable[str]] = None,
) -> BaseProvider:
"""Build a provider class for resolver.
:param strategy: the resolve strategy
:param tracked_names: the names of packages that needs to update
:returns: The provider object
"""
repository = self.get_repository(cls=self.core.repository_class)
allow_prereleases = self.allow_prereleases
requires_python = self.environment.python_requires
if strategy == "all":
provider = BaseProvider(repository, requires_python, allow_prereleases)
else:
provider_class = (
ReusePinProvider if strategy == "reuse" else EagerUpdateProvider
)
preferred_pins = self.get_locked_candidates("__all__")
provider = provider_class(
preferred_pins,
tracked_names or (),
repository,
requires_python,
allow_prereleases,
)
return provider
def get_reporter(
self,
requirements: Dict[str, Dict[str, Requirement]],
tracked_names: Optional[Iterable[str]] = None,
spinner: Optional[halo.Halo] = None,
) -> SpinnerReporter:
"""Return the reporter object to construct a resolver.
:param requirements: requirements to resolve
:param tracked_names: the names of packages that needs to update
:param spinner: optional spinner object
:returns: a reporter
"""
flat_reqs = [
req for req_set in requirements.values() for req in req_set.values()
]
return SpinnerReporter(spinner, flat_reqs)
def get_project_metadata(self) -> Dict[str, Any]:
content_hash = self.get_content_hash("md5")
data = {
"meta_version": self.PYPROJECT_VERSION,
"content_hash": f"md5:{content_hash}",
}
return data
def write_lockfile(self, toml_data: Container, show_message: bool = True) -> None:
toml_data.update({"root": self.get_project_metadata()})
with atomic_open_for_write(self.lockfile_file) as fp:
fp.write(tomlkit.dumps(toml_data))
if show_message:
stream.echo("Changes are written to pdm.lock.")
self._lockfile = None
def make_self_candidate(self, editable: bool = True) -> Candidate:
req = parse_requirement(self.root.as_posix(), editable)
req.name = self.meta.name
return Candidate(
req, self.environment, name=self.meta.name, version=self.meta.version
)
def get_locked_candidates(
self, section: Optional[str] = None
) -> Dict[str, Candidate]:
if not self.lockfile_file.is_file():
return {}
section = section or "default"
result = {}
for package in [dict(p) for p in self.lockfile.get("package", [])]:
if section != "__all__" and section not in package["sections"]:
continue
version = package.get("version")
if version:
package["version"] = f"=={version}"
package_name = package.pop("name")
req = Requirement.from_req_dict(package_name, dict(package))
can = Candidate(req, self.environment, name=package_name, version=version)
can.marker = req.marker
can.hashes = {
item["file"]: item["hash"]
for item in self.lockfile["metadata"].get(
f"{package_name} {version}", []
)
} or None
result[identify(req)] = can
if section in ("default", "__all__") and self.meta.name and self.meta.version:
result[safe_name(self.meta.name).lower()] = self.make_self_candidate(True)
return result
def get_content_hash(self, algo: str = "md5") -> str:
# Only calculate sources and dependencies sections. Otherwise lock file is
# considered as unchanged.
dump_data = {"sources": self.tool_settings.get("source", [])}
for section in self.iter_sections():
toml_section = (
"dependencies" if section == "default" else f"{section}-dependencies"
)
dump_data[toml_section] = dict(self.tool_settings.get(toml_section, {}))
pyproject_content = json.dumps(dump_data, sort_keys=True)
hasher = hashlib.new(algo)
hasher.update(pyproject_content.encode("utf-8"))
return hasher.hexdigest()
def is_lockfile_hash_match(self) -> bool:
if not self.lockfile_file.exists():
return False
hash_in_lockfile = str(self.lockfile["root"]["content_hash"])
algo, hash_value = hash_in_lockfile.split(":")
content_hash = self.get_content_hash(algo)
return content_hash == hash_value
def add_dependencies(
self, requirements: Dict[str, Requirement], show_message: bool = True
) -> None:
for name, dep in requirements.items():
if dep.from_section == "default":
deps = self.tool_settings["dependencies"]
elif dep.from_section == "dev":
deps = self.tool_settings["dev-dependencies"]
else:
section = f"{dep.from_section}-dependencies"
if section not in self.tool_settings:
self.tool_settings[section] = tomlkit.table()
deps = self.tool_settings[section]
matched_name = next(
filter(
lambda k: strip_extras(name)[0] == safe_name(k).lower(), deps.keys()
),
None,
)
name_to_save = dep.name if matched_name is None else matched_name
_, req_dict = dep.as_req_dict()
if isinstance(req_dict, dict):
req = tomlkit.inline_table()
req.update(req_dict)
req_dict = req
deps[name_to_save] = req_dict
self.write_pyproject(show_message)
def write_pyproject(self, show_message: bool = True) -> None:
with atomic_open_for_write(
self.pyproject_file.as_posix(), encoding="utf-8"
) as f:
f.write(tomlkit.dumps(self.pyproject))
if show_message:
stream.echo("Changes are written to pyproject.toml.")
self._pyproject = None
@property
def meta(self) -> PackageMeta:
return PackageMeta(self)
def init_global_project(self) -> None:
if not self.is_global:
return
if not self.pyproject_file.exists():
self.root.mkdir(parents=True, exist_ok=True)
self.pyproject_file.write_text(
"""\
[tool.pdm.dependencies]
pip = "*"
setuptools = "*"
wheels = "*"
[tool.pdm.dev-dependencies]
"""
)
self._pyproject = None
@property
def cache_dir(self) -> Path:
return Path(self.config.get("cache_dir"))
def cache(self, name: str) -> Path:
path = self.cache_dir / name
path.mkdir(parents=True, exist_ok=True)
return path
def make_wheel_cache(self) -> shims.WheelCache:
return shims.WheelCache(
self.cache_dir.as_posix(), shims.FormatControl(set(), set())
)
def make_candidate_info_cache(self) -> CandidateInfoCache:
python_hash = hashlib.sha1(
str(self.environment.python_requires).encode()
).hexdigest()
file_name = f"package_meta_{python_hash}.json"
return CandidateInfoCache(self.cache_dir / file_name)
def make_hash_cache(self) -> HashCache:
return HashCache(directory=self.cache("hashes").as_posix())