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
|
"""
Support for Converter, the new API for serializing custom
types. Will eventually replace the `asdf.types` module.
"""
import abc
from asdf.util import get_class_name, uri_match
class Converter(abc.ABC):
"""
Abstract base class for plugins that convert nodes from the
parsed YAML tree into custom objects, and vice versa.
Implementing classes must provide the `tags` and `types`
properties and `to_yaml_tree` and `from_yaml_tree` methods.
The ``select_tag`` method is optional.
If implemented, ``select_tag`` should accept 3 parameters
obj : object
Instance of the custom type being converted. Guaranteed
to be an instance of one of the types listed in the
`types` property.
tags : list of str
List of active tags to choose from. Guaranteed to match
one of the tag patterns listed in the 'tags' property.
ctx : asdf.extension.SerializationContext
Context of the current serialization request.
and return a str, the selected tag (should be one of tags) or
`None` which will trigger the result of ``to_yaml_tree`` to be
used to look up the next converter for this object.
The ``lazy`` attribute is optional. If ``True`` asdf will
pass "lazy" objects to the converter. If ``False`` (or not
defined) asdf will convert all child objects before calling
`from_yaml_tree`.
The ``to_info`` method is optional. If implemented it must
accept 1 parameter ``obj` which is a tree node/custom
object and return a container (list, tuple, dict) containing
information about that object to display during ``AsdfFile.info``.
"""
@classmethod
def __subclasshook__(cls, class_):
if cls is Converter:
return (
hasattr(class_, "tags")
and hasattr(class_, "types")
and hasattr(class_, "to_yaml_tree")
and hasattr(class_, "from_yaml_tree")
)
return NotImplemented # pragma: no cover
@property
@abc.abstractmethod
def tags(self):
"""
Get the YAML tags that this converter is capable of
handling. URI patterns are permitted, see
`asdf.util.uri_match` for details.
Returns
-------
iterable of str
Tag URIs or URI patterns.
"""
@property
@abc.abstractmethod
def types(self):
"""
Get the Python types that this converter is capable of
handling.
Returns
-------
iterable of str or type
If str, the fully qualified class name of the type.
"""
@abc.abstractmethod
def to_yaml_tree(self, obj, tag, ctx):
"""
Convert an object into a node suitable for YAML serialization.
This method is not responsible for writing actual YAML; rather, it
converts an instance of a custom type to a built-in Python object type
(such as dict, list, str, or number), which can then be automatically
serialized to YAML as needed.
For container types returned by this method (dict or list),
the children of the container need not themselves be converted.
Any list elements or dict values will be converted by subsequent
calls to to_yaml_tree implementations.
The returned node must be an instance of `dict`, `list`, or `str`.
Children may be any type supported by an available Converter.
Parameters
----------
obj : object
Instance of a custom type to be serialized. Guaranteed to
be an instance of one of the types listed in the `types`
property.
tag : str
The tag identifying the YAML type that ``obj`` should be
converted into. Selected by a call to this converter's
select_tag method.
ctx : asdf.extension.SerializationContext
The context of the current serialization request.
Returns
-------
dict or list or str
The YAML node representation of the object.
"""
@abc.abstractmethod
def from_yaml_tree(self, node, tag, ctx):
"""
Convert a YAML node into an instance of a custom type.
For container types received by this method (dict or list),
the children of the container will have already been converted
by prior calls to from_yaml_tree implementations unless
``lazy_tree`` was set to ``True`` for `asdf.open`. With a lazy
tree the container types will be `asdf.lazy_nodes` (which act
like dict or list but convert child objects when accessed).
Note on circular references: trees that reference themselves
among their descendants must be handled with care. Most
implementations need not concern themselves with this case, but
if the custom type supports circular references, then the
implementation of this method will need to return a generator.
Consult the documentation for more details.
Parameters
----------
node : dict or list or str
The YAML node to convert.
tag : str
The YAML tag of the object being converted.
ctx : asdf.extension.SerializationContext
The context of the current deserialization request.
Returns
-------
object
An instance of one of the types listed in the `types` property,
or a generator that yields such an instance.
"""
class ConverterProxy(Converter):
"""
Proxy that wraps a `Converter` and provides default
implementations of optional methods.
"""
def __init__(self, delegate, extension):
if not isinstance(delegate, Converter):
msg = "Converter must implement the asdf.extension.Converter interface"
raise TypeError(msg)
self._delegate = delegate
self._extension = extension
self._class_name = get_class_name(delegate)
# Sort these out up-front so that errors are raised when the extension is loaded
# and not in the middle of the user's session. The extension will fail to load
# and a warning will be emitted, but it won't crash the program.
relevant_tags = set()
for tag in delegate.tags:
if isinstance(tag, str):
relevant_tags.update(t.tag_uri for t in extension.tags if uri_match(tag, t.tag_uri))
else:
msg = "Converter property 'tags' must contain str values"
raise TypeError(msg)
if len(relevant_tags) > 1 and not hasattr(delegate, "select_tag"):
msg = "Converter handles multiple tags for this extension, but does not implement a select_tag method."
raise RuntimeError(msg)
self._tags = sorted(relevant_tags)
self._types = []
if not len(self._tags) and not hasattr(delegate, "select_tag"):
# this converter supports no tags so don't inspect the types
return
for typ in delegate.types:
if isinstance(typ, (str, type)):
self._types.append(typ)
else:
msg = "Converter property 'types' must contain str or type values"
raise TypeError(msg)
@property
def lazy(self):
"""
Boolean indicating if this Converter supports "lazy" node objects
Returns
-------
bool
"""
return getattr(self._delegate, "lazy", False)
@property
def tags(self):
"""
Get the list of tag URIs that this converter is capable of
handling.
Returns
-------
list of str
"""
return self._tags
@property
def types(self):
"""
Get the Python types that this converter is capable of
handling.
Returns
-------
list of type or str
"""
return self._types
def select_tag(self, obj, ctx):
"""
Select the tag to use when converting an object to YAML.
Parameters
----------
obj : object
Instance of the custom type being converted.
ctx : asdf.extension.SerializationContext
Serialization parameters.
Returns
-------
str or None
Selected tag or `None` to defer conversion.
"""
method = getattr(self._delegate, "select_tag", None)
if method is None:
return self._tags[0]
return method(obj, self._tags, ctx)
def to_yaml_tree(self, obj, tag, ctx):
"""
Convert an object into a node suitable for YAML serialization.
Parameters
----------
obj : object
Instance of a custom type to be serialized.
tag : str
The tag identifying the YAML type that ``obj`` should be
converted into.
ctx : asdf.extension.SerializationContext
Serialization parameters.
Returns
-------
object
The YAML node representation of the object.
"""
return self._delegate.to_yaml_tree(obj, tag, ctx)
def from_yaml_tree(self, node, tag, ctx):
"""
Convert a YAML node into an instance of a custom type.
Parameters
----------
tree : dict or list or str
The YAML node to convert.
tag : str
The YAML tag of the object being converted.
ctx : asdf.extension.SerializationContext
Serialization parameters.
Returns
-------
object
"""
return self._delegate.from_yaml_tree(node, tag, ctx)
def to_info(self, obj):
"""
Convert an object to a container with items further
defining information about this node. This method
is used for "info" and not used for serialization.
Parameters
----------
obj : object
Instance of a custom type to get "info" for.
Returns
-------
object
Must be a container (list, tuple, dict) with
items providing "info" about ``obj``.
"""
if not hasattr(self._delegate, "to_info"):
return obj
return self._delegate.to_info(obj)
@property
def delegate(self):
"""
Get the wrapped converter instance.
Returns
-------
asdf.extension.Converter
"""
return self._delegate
@property
def extension(self):
"""
Get the extension that provided this converter.
Returns
-------
asdf.extension.ExtensionProxy
"""
return self._extension
@property
def package_name(self):
"""
Get the name of the Python package of this converter's
extension. This may not be the same package that implements
the converter's class.
Returns
-------
str or None
Package name, or `None` if the extension was added at runtime.
"""
return self.extension.package_name
@property
def package_version(self):
"""
Get the version of the Python package of this converter's
extension. This may not be the same package that implements
the converter's class.
Returns
-------
str or None
Package version, or `None` if the extension was added at runtime.
"""
return self.extension.package_version
@property
def class_name(self):
"""
Get the fully qualified class name of this converter.
Returns
-------
str
"""
return self._class_name
def __eq__(self, other):
if isinstance(other, ConverterProxy):
return other.delegate is self.delegate and other.extension is self.extension
return False
def __hash__(self):
return hash((id(self.delegate), id(self.extension)))
def __repr__(self):
package_description = "(none)" if self.package_name is None else f"{self.package_name}=={self.package_version}"
return f"<ConverterProxy class: {self.class_name} package: {package_description}>"
|