-
Notifications
You must be signed in to change notification settings - Fork 251
/
package.py
675 lines (533 loc) · 21.2 KB
/
package.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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
from __future__ import annotations
import copy
import re
import warnings
from contextlib import contextmanager
from typing import TYPE_CHECKING
from typing import TypeVar
from poetry.core.constraints.version import parse_constraint
from poetry.core.constraints.version.exceptions import ParseConstraintError
from poetry.core.packages.dependency_group import MAIN_GROUP
from poetry.core.packages.specification import PackageSpecification
from poetry.core.packages.utils.utils import create_nested_marker
from poetry.core.version.exceptions import InvalidVersion
from poetry.core.version.markers import parse_marker
if TYPE_CHECKING:
from collections.abc import Collection
from collections.abc import Iterable
from collections.abc import Iterator
from pathlib import Path
from packaging.utils import NormalizedName
from poetry.core.constraints.version import Version
from poetry.core.constraints.version import VersionConstraint
from poetry.core.packages.dependency import Dependency
from poetry.core.packages.dependency_group import DependencyGroup
from poetry.core.spdx.license import License
from poetry.core.version.markers import BaseMarker
T = TypeVar("T", bound="Package")
AUTHOR_REGEX = re.compile(
r"(?u)^(?P<name>[- .,\w\d'’\"():&]+)(?: <(?P<email>.+?)>)?$" # noqa: RUF001
)
class Package(PackageSpecification):
AVAILABLE_PYTHONS = {
"2",
"2.7",
"3",
"3.4",
"3.5",
"3.6",
"3.7",
"3.8",
"3.9",
"3.10",
"3.11",
}
def __init__(
self,
name: str,
version: str | Version,
pretty_version: str | None = None,
source_type: str | None = None,
source_url: str | None = None,
source_reference: str | None = None,
source_resolved_reference: str | None = None,
source_subdirectory: str | None = None,
features: Iterable[str] | None = None,
develop: bool = False,
yanked: str | bool = False,
) -> None:
"""
Creates a new in memory package.
"""
from poetry.core.version.markers import AnyMarker
if pretty_version is not None:
warnings.warn(
(
"The `pretty_version` parameter is deprecated and will be removed"
" in a future release."
),
DeprecationWarning,
stacklevel=2,
)
super().__init__(
name,
source_type=source_type,
source_url=source_url,
source_reference=source_reference,
source_resolved_reference=source_resolved_reference,
source_subdirectory=source_subdirectory,
features=features,
)
self._set_version(version)
self.description = ""
self._authors: list[str] = []
self._maintainers: list[str] = []
self.homepage: str | None = None
self.repository_url: str | None = None
self.documentation_url: str | None = None
self.keywords: list[str] = []
self._license: License | None = None
self.readmes: tuple[Path, ...] = ()
self.extras: dict[NormalizedName, list[Dependency]] = {}
self._dependency_groups: dict[str, DependencyGroup] = {}
# Category is heading towards deprecation.
self._category = "main"
self.files: list[dict[str, str]] = []
self.optional = False
self.classifiers: list[str] = []
self._python_versions = "*"
self._python_constraint = parse_constraint("*")
self._python_marker: BaseMarker = AnyMarker()
self.marker: BaseMarker = AnyMarker()
self.root_dir: Path | None = None
self.develop = develop
self._yanked = yanked
@property
def name(self) -> NormalizedName:
return self._name
@property
def pretty_name(self) -> str:
return self._pretty_name
@property
def version(self) -> Version:
return self._version
@property
def pretty_version(self) -> str:
return self._version.text
@property
def unique_name(self) -> str:
if self.is_root():
return self._name
return self.complete_name + "-" + self._version.text
@property
def pretty_string(self) -> str:
return self.pretty_name + " " + self.pretty_version
@property
def full_pretty_version(self) -> str:
if self.source_type in ("file", "directory", "url"):
return f"{self.pretty_version} {self.source_url}"
if self.source_type not in ("hg", "git"):
return self.pretty_version
ref: str | None
if self.source_resolved_reference and len(self.source_resolved_reference) == 40:
ref = self.source_resolved_reference[0:7]
return f"{self.pretty_version} {ref}"
# if source reference is a sha1 hash -- truncate
if self.source_reference and len(self.source_reference) == 40:
return f"{self.pretty_version} {self.source_reference[0:7]}"
ref = self._source_resolved_reference or self._source_reference
return f"{self.pretty_version} {ref}"
@property
def authors(self) -> list[str]:
return self._authors
@property
def author_name(self) -> str | None:
return self._get_author()["name"]
@property
def author_email(self) -> str | None:
return self._get_author()["email"]
@property
def maintainers(self) -> list[str]:
return self._maintainers
@property
def maintainer_name(self) -> str | None:
return self._get_maintainer()["name"]
@property
def maintainer_email(self) -> str | None:
return self._get_maintainer()["email"]
@property
def requires(self) -> list[Dependency]:
"""
Returns the main dependencies
"""
if not self._dependency_groups or MAIN_GROUP not in self._dependency_groups:
return []
return self._dependency_groups[MAIN_GROUP].dependencies
@property
def all_requires(
self,
) -> list[Dependency]:
"""
Returns the main dependencies and group dependencies.
"""
return [
dependency
for group in self._dependency_groups.values()
for dependency in group.dependencies
]
def _set_version(self, version: str | Version) -> None:
from poetry.core.constraints.version import Version
if not isinstance(version, Version):
try:
version = Version.parse(version)
except InvalidVersion:
raise InvalidVersion(
f"Invalid version '{version}' on package {self.name}"
)
self._version = version
def _get_author(self) -> dict[str, str | None]:
if not self._authors:
return {"name": None, "email": None}
m = AUTHOR_REGEX.match(self._authors[0])
if m is None:
raise ValueError(
"Invalid author string. Must be in the format: "
"John Smith <[email protected]>"
)
name = m.group("name")
email = m.group("email")
return {"name": name, "email": email}
def _get_maintainer(self) -> dict[str, str | None]:
if not self._maintainers:
return {"name": None, "email": None}
m = AUTHOR_REGEX.match(self._maintainers[0])
if m is None:
raise ValueError(
"Invalid maintainer string. Must be in the format: "
"John Smith <[email protected]>"
)
name = m.group("name")
email = m.group("email")
return {"name": name, "email": email}
@property
def python_versions(self) -> str:
return self._python_versions
@python_versions.setter
def python_versions(self, value: str) -> None:
try:
constraint = parse_constraint(value)
except ParseConstraintError:
raise ParseConstraintError(f"Invalid python versions '{value}' on {self}")
self._python_versions = value
self._python_constraint = constraint
self._python_marker = parse_marker(
create_nested_marker("python_version", self._python_constraint)
)
@property
def python_constraint(self) -> VersionConstraint:
return self._python_constraint
@property
def python_marker(self) -> BaseMarker:
return self._python_marker
@property
def license(self) -> License | None:
return self._license
@license.setter
def license(self, value: str | License | None) -> None:
from poetry.core.spdx.helpers import license_by_id
from poetry.core.spdx.license import License
if value is None or isinstance(value, License):
self._license = value
else:
self._license = license_by_id(value)
@property
def all_classifiers(self) -> list[str]:
from poetry.core.constraints.version import Version
classifiers = copy.copy(self.classifiers)
# Automatically set python classifiers
if self.python_versions == "*":
python_constraint = parse_constraint("~2.7 || ^3.4")
else:
python_constraint = self.python_constraint
python_classifier_prefix = "Programming Language :: Python"
python_classifiers = []
# we sort python versions by sorting an int tuple of (major, minor) version
# to ensure we sort 3.10 after 3.9
for version in sorted(
self.AVAILABLE_PYTHONS, key=lambda x: tuple(map(int, x.split(".")))
):
if len(version) == 1:
constraint = parse_constraint(version + ".*")
else:
constraint = Version.parse(version)
if python_constraint.allows_any(constraint):
classifier = f"{python_classifier_prefix} :: {version}"
if classifier not in python_classifiers:
python_classifiers.append(classifier)
# Automatically set license classifiers
if self.license:
classifiers.append(self.license.classifier)
# Sort classifiers and insert python classifiers at the right location. We do
# it like this so that 3.10 is sorted after 3.9.
sorted_classifiers = []
python_classifiers_inserted = False
for classifier in sorted(set(classifiers)):
if (
not python_classifiers_inserted
and classifier > python_classifier_prefix
):
sorted_classifiers.extend(python_classifiers)
python_classifiers_inserted = True
sorted_classifiers.append(classifier)
if not python_classifiers_inserted:
sorted_classifiers.extend(python_classifiers)
return sorted_classifiers
@property
def urls(self) -> dict[str, str]:
urls = {}
if self.homepage:
urls["Homepage"] = self.homepage
if self.repository_url:
urls["Repository"] = self.repository_url
if self.documentation_url:
urls["Documentation"] = self.documentation_url
return urls
@property
def category(self) -> str:
warnings.warn(
"`category` is deprecated and will be removed in a future release.",
DeprecationWarning,
stacklevel=2,
)
return self._category
@category.setter
def category(self, category: str) -> None:
warnings.warn(
"Setting `category` is deprecated and will be removed in a future release.",
DeprecationWarning,
stacklevel=2,
)
self._category = category
@property
def readme(self) -> Path | None:
warnings.warn(
(
"`readme` is deprecated: you are getting only the first readme file."
" Please use the plural form `readmes`."
),
DeprecationWarning,
stacklevel=2,
)
return next(iter(self.readmes), None)
@readme.setter
def readme(self, path: Path) -> None:
warnings.warn(
(
"`readme` is deprecated. Please assign a tuple to the plural form"
" `readmes`."
),
DeprecationWarning,
stacklevel=2,
)
self.readmes = (path,)
@property
def yanked(self) -> bool:
return isinstance(self._yanked, str) or bool(self._yanked)
@property
def yanked_reason(self) -> str:
if isinstance(self._yanked, str):
return self._yanked
return ""
def is_prerelease(self) -> bool:
return self._version.is_unstable()
def is_root(self) -> bool:
return False
def dependency_group_names(self, include_optional: bool = False) -> set[str]:
return {
name
for name, group in self._dependency_groups.items()
if not group.is_optional() or include_optional
}
def add_dependency_group(self, group: DependencyGroup) -> None:
self._dependency_groups[group.name] = group
def has_dependency_group(self, name: str) -> bool:
return name in self._dependency_groups
def dependency_group(self, name: str) -> DependencyGroup:
if not self.has_dependency_group(name):
raise ValueError(f'The dependency group "{name}" does not exist.')
return self._dependency_groups[name]
def add_dependency(
self,
dependency: Dependency,
) -> Dependency:
from poetry.core.packages.dependency_group import DependencyGroup
for group_name in dependency.groups:
if group_name not in self._dependency_groups:
# Dynamically add the dependency group
self.add_dependency_group(DependencyGroup(group_name))
self._dependency_groups[group_name].add_dependency(dependency)
return dependency
def without_dependency_groups(self: T, groups: Collection[str]) -> T:
"""
Returns a clone of the package with the given dependency groups excluded.
"""
package = self.clone()
for group_name in groups:
if group_name in package._dependency_groups:
del package._dependency_groups[group_name]
return package
def without_optional_dependency_groups(self: T) -> T:
"""
Returns a clone of the package without optional dependency groups.
"""
package = self.clone()
for group_name, group in self._dependency_groups.items():
if group.is_optional():
del package._dependency_groups[group_name]
return package
def with_dependency_groups(
self: T, groups: Collection[str], only: bool = False
) -> T:
"""
Returns a clone of the package with the given dependency groups opted in.
Note that it will return all dependencies across all groups
more the given, optional, groups.
If `only` is set to True, then only the given groups will be selected.
"""
package = self.clone()
for group_name, group in self._dependency_groups.items():
if (only or group.is_optional()) and group_name not in groups:
del package._dependency_groups[group_name]
return package
def to_dependency(self) -> Dependency:
from pathlib import Path
from poetry.core.packages.dependency import Dependency
from poetry.core.packages.directory_dependency import DirectoryDependency
from poetry.core.packages.file_dependency import FileDependency
from poetry.core.packages.url_dependency import URLDependency
from poetry.core.packages.vcs_dependency import VCSDependency
dep: Dependency
if self.source_type == "directory":
assert self._source_url is not None
dep = DirectoryDependency(
self._name,
Path(self._source_url),
groups=list(self._dependency_groups.keys()),
optional=self.optional,
base=self.root_dir,
develop=self.develop,
extras=self.features,
)
elif self.source_type == "file":
assert self._source_url is not None
dep = FileDependency(
self._name,
Path(self._source_url),
groups=list(self._dependency_groups.keys()),
optional=self.optional,
base=self.root_dir,
extras=self.features,
)
elif self.source_type == "url":
assert self._source_url is not None
dep = URLDependency(
self._name,
self._source_url,
directory=self.source_subdirectory,
groups=list(self._dependency_groups.keys()),
optional=self.optional,
extras=self.features,
)
elif self.source_type == "git":
assert self._source_url is not None
dep = VCSDependency(
self._name,
self.source_type,
self._source_url,
rev=self.source_reference,
resolved_rev=self.source_resolved_reference,
directory=self.source_subdirectory,
groups=list(self._dependency_groups.keys()),
optional=self.optional,
develop=self.develop,
extras=self.features,
)
else:
dep = Dependency(self._name, self._version, extras=self.features)
if not self.marker.is_any():
dep.marker = self.marker
if not self.python_constraint.is_any():
dep.python_versions = self.python_versions
if not self.is_direct_origin():
return dep
return dep.with_constraint(self._version)
@contextmanager
def with_python_versions(self, python_versions: str) -> Iterator[None]:
original_python_versions = self.python_versions
self.python_versions = python_versions
yield
self.python_versions = original_python_versions
def satisfies(
self, dependency: Dependency, ignore_source_type: bool = False
) -> bool:
"""
Helper method to check if this package satisfies a given dependency.
This is determined by assessing if this instance provides the package specified
by the given dependency. Further, version and source types are checked.
"""
if self.name != dependency.name:
return False
if not dependency.constraint.allows(self.version):
return False
if not (ignore_source_type or self.source_satisfies(dependency)):
return False
return True
def source_satisfies(self, dependency: Dependency) -> bool:
"""Determine whether this package's source satisfies the given dependency."""
if dependency.source_type is None:
if dependency.source_name is None:
# The dependency doesn't care about the source, so this package
# certainly satisfies it.
return True
# The dependency specifies a source_name but not a type: it wants either
# pypi or a legacy repository.
#
# - If this package has no source type then it's from pypi, so it
# matches if and only if that's what the dependency wants
# - Else this package is a match if and only if it is from the desired
# repository
if self.source_type is None:
return dependency.source_name.lower() == "pypi"
return (
self.source_type == "legacy"
and self.source_reference is not None
and self.source_reference.lower() == dependency.source_name.lower()
)
# The dependency specifies a source: this package matches if and only if it is
# from that source.
return dependency.is_same_source_as(self)
def __eq__(self, other: object) -> bool:
if not isinstance(other, Package):
return NotImplemented
return super().__eq__(other) and self._version == other.version
def __hash__(self) -> int:
return super().__hash__() ^ hash(self._version)
def __str__(self) -> str:
return f"{self.complete_name} ({self.full_pretty_version})"
def __repr__(self) -> str:
args = [repr(self._name), repr(self._version.text)]
if self._features:
args.append(f"features={self._features!r}")
if self._source_type:
args.append(f"source_type={self._source_type!r}")
args.append(f"source_url={self._source_url!r}")
if self._source_reference:
args.append(f"source_reference={self._source_reference!r}")
if self._source_resolved_reference:
args.append(
f"source_resolved_reference={self._source_resolved_reference!r}"
)
if self._source_subdirectory:
args.append(f"source_subdirectory={self._source_subdirectory!r}")
args_str = ", ".join(args)
return f"Package({args_str})"