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
|
import bisect
from collections import OrderedDict
from functools import lru_cache
from . import util
from .versioning import AsdfVersion, default_version, get_version_map, join_tag_version, split_tag_version
__all__ = ["AsdfTypeIndex"]
_BASIC_PYTHON_TYPES = [str, int, float, list, dict, tuple]
class _AsdfWriteTypeIndex:
"""
The _AsdfWriteTypeIndex is a helper class for AsdfTypeIndex that
manages an index of types for writing out ASDF files, i.e. from
converting from custom types to tagged_types. It is not always
the inverse of the mapping from tags to custom types, since there
are likely multiple versions present for a given tag.
This uses the `version_map.yaml` file that ships with the ASDF
standard to figure out which schemas correspond to a particular
version of the ASDF standard.
An AsdfTypeIndex manages multiple _AsdfWriteTypeIndex instances
for each version the user may want to write out, and they are
instantiated on-demand.
If version is ``'latest'``, it will just use the highest-numbered
versions of each of the schemas. This is currently only used to
aid in testing.
In the future, this may be renamed to _ExtensionWriteTypeIndex since it is
not specific to classes that inherit `AsdfType`.
"""
_version_map = None
def __init__(self, version, index):
self._version = version
self._type_by_cls = {}
self._type_by_name = {}
self._type_by_subclasses = {}
self._class_by_subclass = {}
self._types_with_dynamic_subclasses = {}
self._extension_by_cls = {}
self._extensions_used = set()
try:
version_map = get_version_map(self._version)
core_version_map = version_map["core"]
standard_version_map = version_map["standard"]
except ValueError:
raise ValueError(f"Don't know how to write out ASDF version {self._version}")
# Process all types defined in the ASDF version map. It is important to
# make sure that tags that are associated with the core part of the
# standard are processed first in order to handle subclasses properly.
for name, _version in core_version_map.items():
self._add_by_tag(index, name, AsdfVersion(_version))
for name, _version in standard_version_map.items():
self._add_by_tag(index, name, AsdfVersion(_version))
# Now add any extension types that aren't known to the ASDF standard.
# This expects that all types defined by ASDF will be encountered
# before any types that are defined by external packages. This
# allows external packages to override types that are also defined
# by ASDF. The ordering is guaranteed due to the use of OrderedDict
# for _versions_by_type_name, and due to the fact that the built-in
# extension will always be processed first.
for name, versions in index._versions_by_type_name.items():
if name not in self._type_by_name:
self._add_by_tag(index, name, versions[-1])
for asdftype in index._unnamed_types:
self._add_all_types(index, asdftype)
def _should_overwrite(self, cls, new_type):
existing_type = self._type_by_cls[cls]
# Types that are provided by extensions from other packages should
# only override the type index corresponding to the latest version
# of ASDF.
if existing_type.tag_base() != new_type.tag_base():
return self._version == default_version
return True
def _add_type_to_index(self, index, cls, typ):
if cls in self._type_by_cls and not self._should_overwrite(cls, typ):
return
self._type_by_cls[cls] = typ
self._extension_by_cls[cls] = index._extension_by_type[typ]
def _add_subclasses(self, index, typ, asdftype):
for subclass in util.iter_subclasses(typ):
# Do not overwrite the tag type for an existing subclass if the
# new tag serializes a class that is higher in the type
# hierarchy than the existing subclass.
if subclass in self._class_by_subclass:
if issubclass(self._class_by_subclass[subclass], typ):
# Allow for cases where a subclass tag is being
# overridden by a tag from another extension.
if self._extension_by_cls[subclass] == index._extension_by_type[asdftype]:
continue
self._class_by_subclass[subclass] = typ
self._type_by_subclasses[subclass] = asdftype
self._extension_by_cls[subclass] = index._extension_by_type[asdftype]
def _add_all_types(self, index, asdftype):
self._add_type_to_index(index, asdftype, asdftype)
for typ in asdftype.types:
self._add_type_to_index(index, typ, asdftype)
self._add_subclasses(index, typ, asdftype)
if asdftype.handle_dynamic_subclasses:
for typ in asdftype.types:
self._types_with_dynamic_subclasses[typ] = asdftype
def _add_by_tag(self, index, name, version):
tag = join_tag_version(name, version)
if tag in index._type_by_tag:
asdftype = index._type_by_tag[tag]
self._type_by_name[name] = asdftype
self._add_all_types(index, asdftype)
def _mark_used_extension(self, custom_type, serialization_context):
extension = self._extension_by_cls[custom_type]
self._extensions_used.add(extension)
if serialization_context is not None:
serialization_context._mark_extension_used(extension)
def _process_dynamic_subclass(self, custom_type, serialization_context):
for key, val in self._types_with_dynamic_subclasses.items():
if issubclass(custom_type, key):
self._type_by_cls[custom_type] = val
self._mark_used_extension(key, serialization_context)
return val
return None
def from_custom_type(self, custom_type, _serialization_context=None):
"""
Given a custom type, return the corresponding `ExtensionType`
definition.
"""
asdftype = None
# Try to find an exact class match first...
try:
asdftype = self._type_by_cls[custom_type]
except KeyError:
# ...failing that, match any subclasses
try:
asdftype = self._type_by_subclasses[custom_type]
except KeyError:
# ...failing that, try any subclasses that we couldn't
# cache in _type_by_subclasses. This generally only
# includes classes that are created dynamically post
# Python-import, e.g. astropy.modeling._CompoundModel
# subclasses.
return self._process_dynamic_subclass(custom_type, _serialization_context)
if asdftype is not None:
extension = self._extension_by_cls.get(custom_type)
if extension is not None:
self._mark_used_extension(custom_type, _serialization_context)
else:
# Handle the case where the dynamic subclass was identified as
# a proper subclass above, but it has not yet been registered
# as such.
self._process_dynamic_subclass(custom_type, _serialization_context)
return asdftype
class AsdfTypeIndex:
"""
An index of the known `ExtensionType` classes.
In the future this class may be renamed to ExtensionTypeIndex, since it is
not specific to classes that inherit `AsdfType`.
"""
def __init__(self):
self._write_type_indices = {}
self._type_by_tag = {}
# Use OrderedDict here to preserve the order in which types are added
# to the type index. Since the ASDF built-in extension is always
# processed first, this ensures that types defined by external packages
# will always override corresponding types that are defined by ASDF
# itself. However, if two different external packages define tags for
# the same type, the result is currently undefined.
self._versions_by_type_name = OrderedDict()
self._best_matches = {}
self._unnamed_types = set()
self._hooks_by_type = {}
self._all_types = set()
self._has_warned = {}
self._extension_by_type = {}
def add_type(self, asdftype, extension):
"""
Add a type to the index.
"""
self._all_types.add(asdftype)
self._extension_by_type[asdftype] = extension
if asdftype.yaml_tag is None and asdftype.name is None:
return
if isinstance(asdftype.name, list):
yaml_tags = [asdftype.make_yaml_tag(name) for name in asdftype.name]
elif isinstance(asdftype.name, str):
yaml_tags = [asdftype.yaml_tag]
elif asdftype.name is None:
yaml_tags = []
else:
raise TypeError("name must be a string, list or None")
for yaml_tag in yaml_tags:
self._type_by_tag[yaml_tag] = asdftype
name, version = split_tag_version(yaml_tag)
versions = self._versions_by_type_name.get(name)
if versions is None:
self._versions_by_type_name[name] = [version]
else:
idx = bisect.bisect_left(versions, version)
if idx == len(versions) or versions[idx] != version:
versions.insert(idx, version)
if not len(yaml_tags):
self._unnamed_types.add(asdftype)
def from_custom_type(self, custom_type, version=default_version, _serialization_context=None):
"""
Given a custom type, return the corresponding `ExtensionType`
definition.
"""
# Basic Python types should not ever have an AsdfType associated with
# them.
if custom_type in _BASIC_PYTHON_TYPES:
return None
write_type_index = self._write_type_indices.get(str(version))
if write_type_index is None:
write_type_index = _AsdfWriteTypeIndex(version, self)
self._write_type_indices[version] = write_type_index
return write_type_index.from_custom_type(custom_type, _serialization_context=_serialization_context)
def fix_yaml_tag(self, ctx, tag):
"""
Given a YAML tag, adjust it to the best supported version.
If there is no exact match, this finds the newest version
understood that is still less than the version in file. Or,
the earliest understood version if none are less than the
version in the file.
"""
if tag in self._type_by_tag:
return tag
if tag in self._best_matches:
best_tag = self._best_matches[tag]
ctx._warn_tag_mismatch(tag, best_tag)
return best_tag
name, version = split_tag_version(tag)
versions = self._versions_by_type_name.get(name)
if versions is None:
return tag
# The versions list is kept sorted, so bisect can be used to
# quickly find the best option.
i = bisect.bisect_left(versions, version)
i = max(0, i - 1)
best_version = versions[i]
best_tag = join_tag_version(name, best_version)
ctx._warn_tag_mismatch(tag, best_tag)
self._best_matches[tag] = best_tag
return best_tag
def from_yaml_tag(self, ctx, tag, _serialization_context=None):
"""
From a given YAML tag string, return the corresponding
AsdfType definition.
"""
tag = self.fix_yaml_tag(ctx, tag)
asdftype = self._type_by_tag.get(tag)
if asdftype is not None and _serialization_context is not None:
_serialization_context._mark_extension_used(self._extension_by_type[asdftype])
return asdftype
@lru_cache(5)
def has_hook(self, hook_name):
"""
Returns `True` if the given hook name exists on any of the managed
types.
"""
for cls in self._all_types:
if hasattr(cls, hook_name):
return True
return False
def get_hook_for_type(self, hookname, typ, version=default_version):
"""
Get the hook function for the given type, if it exists,
else return None.
"""
hooks = self._hooks_by_type.setdefault(hookname, {})
hook = hooks.get(typ, None)
if hook is not None:
return hook
tag = self.from_custom_type(typ, version)
if tag is not None:
hook = getattr(tag, hookname, None)
if hook is not None:
hooks[typ] = hook
return hook
hooks[typ] = None
return None
def get_extensions_used(self, version=default_version):
write_type_index = self._write_type_indices.get(str(version))
if write_type_index is None:
return []
return list(write_type_index._extensions_used)
|