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
|
"""
This module deals with things that change between different versions
of the ASDF spec.
"""
from functools import total_ordering
import yaml
if getattr(yaml, "__with_libyaml__", None): # pragma: no cover
_yaml_base_loader = yaml.CSafeLoader
else: # pragma: no cover
_yaml_base_loader = yaml.SafeLoader
from semantic_version import SimpleSpec, Version
__all__ = ["AsdfVersion", "AsdfSpec", "AsdfVersionMixin", "split_tag_version", "join_tag_version"]
def split_tag_version(tag):
"""
Split a tag into its base and version.
"""
name, version = tag.rsplit("-", 1)
version = AsdfVersion(version)
return name, version
def join_tag_version(name, version):
"""
Join the root and version of a tag back together.
"""
return f"{name}-{version}"
_version_map = {}
def get_version_map(version):
version_map = _version_map.get(version)
if version_map is None:
from .config import get_config
uri = f"http://stsci.edu/schemas/asdf/version_map-{version}"
version_map = yaml.load(get_config().resource_manager[uri], Loader=_yaml_base_loader) # nosec
# Separate the core tags from the rest of the standard for convenience
version_map["core"] = {}
version_map["standard"] = {}
for tag_name, tag_version in version_map["tags"].items():
if tag_name.startswith("tag:stsci.edu:asdf/core"):
version_map["core"][tag_name] = tag_version
else:
version_map["standard"][tag_name] = tag_version
_version_map[version] = version_map
return version_map
@total_ordering
class AsdfVersionMixin:
"""This mix-in is required in order to impose the total ordering that we
want for ``AsdfVersion``, rather than accepting the total ordering that is
already provided by ``Version`` from ``semantic_version``. Defining these
comparisons directly in ``AsdfVersion`` and applying ``total_ordering``
there will not work since ``total_ordering`` only defines comparison
operations if they do not exist already and the base class ``Version``
already defines these operations.
"""
def __eq__(self, other):
# Seems like a bit of a hack...
if isinstance(other, SimpleSpec):
return other == self
if isinstance(other, (str, tuple, list)):
other = AsdfVersion(other)
return Version.__eq__(self, other)
def __ne__(self, other):
return not self.__eq__(other)
def __lt__(self, other):
if isinstance(other, (str, tuple, list)):
other = AsdfVersion(other)
return Version.__lt__(self, other)
def __hash__(self):
# To be honest, I'm not sure why I had to make this explicit
return Version.__hash__(self)
class AsdfVersion(AsdfVersionMixin, Version):
"""This class adds features to the existing ``Version`` class from the
``semantic_version`` module. Namely, it allows ``Version`` objects to be
constructed from tuples and lists as well as strings, and it allows
``Version`` objects to be compared with tuples, lists, and strings, instead
of just other ``Version`` objects.
If any of these features are added to the ``Version`` class itself (as
requested in https://github.com/rbarrois/python-semanticversion/issues/52),
then this class will become obsolete.
"""
def __init__(self, version):
# This is a dirty hack and you know it
if isinstance(version, AsdfVersion):
version = str(version)
if isinstance(version, (tuple, list)):
version = ".".join([str(x) for x in version])
super().__init__(version)
class AsdfSpec(SimpleSpec):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
def match(self, version):
if isinstance(version, (str, tuple, list)):
version = AsdfVersion(version)
return super().match(version)
def __iterate_versions(self, versions):
for v in versions:
if isinstance(v, (str, tuple, list)):
v = AsdfVersion(v)
yield v
def select(self, versions):
return super().select(self.__iterate_versions(versions))
def filter(self, versions):
return super().filter(self.__iterate_versions(versions))
def __eq__(self, other):
"""Equality between Spec and Version, string, or tuple, means match"""
if isinstance(other, SimpleSpec):
return super().__eq__(other)
return self.match(other)
def __ne__(self, other):
return not self.__eq__(other)
def __hash__(self):
return super().__hash__()
supported_versions = [
AsdfVersion("1.0.0"),
AsdfVersion("1.1.0"),
AsdfVersion("1.2.0"),
AsdfVersion("1.3.0"),
AsdfVersion("1.4.0"),
AsdfVersion("1.5.0"),
AsdfVersion("1.6.0"),
]
default_version = AsdfVersion("1.5.0")
# This is the ASDF Standard version that is currently in development
# it is possible that breaking changes will be made to this version.
asdf_standard_development_version = AsdfVersion("1.6.0")
# This is the ASDF Standard version at which the format of the history
# field changed to include extension metadata.
NEW_HISTORY_FORMAT_MIN_VERSION = AsdfVersion("1.2.0")
# This is the ASDF Standard version at which we begin restricting
# mapping keys to string, integer, and boolean only.
RESTRICTED_KEYS_MIN_VERSION = AsdfVersion("1.6.0")
# This library never removed defaults for ASDF Standard versions
# later than 1.5.0, so filling them isn't necessary.
FILL_DEFAULTS_MAX_VERSION = AsdfVersion("1.5.0")
|
