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
|
from __future__ import annotations
from logging import getLogger
from typing import cast
from typing import Type
from typing import Union
from packaging.version import InvalidVersion
from packaging.version import Version as Version
class NonNormalizedVersion(Version):
"""A non-normalizing version handler.
You can use this class to preserve version verification but skip normalization.
For example you can use this to avoid git release candidate version tags
("1.0.0-rc1") to be normalized to "1.0.0rc1". Only use this if you fully
trust the version tags.
"""
def __init__(self, version: str) -> None:
# parse and validate using parent
super().__init__(version)
# store raw for str
self._raw_version = version
def __str__(self) -> str:
# return the non-normalized version (parent returns the normalized)
return self._raw_version
def __repr__(self) -> str:
# same pattern as parent
return f"<NonNormalizedVersion({self._raw_version!r})>"
def _version_as_tuple(version_str: str) -> tuple[int | str, ...]:
try:
parsed_version = Version(version_str)
except InvalidVersion:
log = getLogger(__name__).parent
assert log is not None
log.error("failed to parse version %s", version_str)
return (version_str,)
else:
version_fields: tuple[int | str, ...] = parsed_version.release
if parsed_version.dev is not None:
version_fields += (f"dev{parsed_version.dev}",)
if parsed_version.local is not None:
version_fields += (parsed_version.local,)
return version_fields
_VersionT = Union[Version, NonNormalizedVersion]
def import_name(name: str) -> object:
import importlib
pkg_name, cls_name = name.rsplit(".", 1)
pkg = importlib.import_module(pkg_name)
return getattr(pkg, cls_name)
def _validate_version_cls(
version_cls: type[_VersionT] | str | None, normalize: bool
) -> type[_VersionT]:
if not normalize:
if version_cls is not None:
raise ValueError(
"Providing a custom `version_cls` is not permitted when "
"`normalize=False`"
)
return NonNormalizedVersion
else:
# Use `version_cls` if provided, default to packaging or pkg_resources
if version_cls is None:
return Version
elif isinstance(version_cls, str):
try:
return cast(Type[_VersionT], import_name(version_cls))
except: # noqa
raise ValueError(f"Unable to import version_cls='{version_cls}'")
else:
return version_cls
|
