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 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
|
import collections
import fractions
import sys
import pytest
from packaging.specifiers import SpecifierSet
import asdf
from asdf import AsdfFile, config_context
from asdf.exceptions import AsdfManifestURIMismatchWarning, AsdfSerializationError, ValidationError
from asdf.extension import (
Compressor,
Converter,
ConverterProxy,
Extension,
ExtensionManager,
ExtensionProxy,
ManifestExtension,
TagDefinition,
Validator,
get_cached_extension_manager,
)
from asdf.extension._manager import _resolve_type
from asdf.testing.helpers import roundtrip_object
class MinimumExtension:
extension_uri = "asdf://somewhere.org/extensions/minimum-1.0"
class MinimumExtensionSubclassed(Extension):
extension_uri = "asdf://somewhere.org/extensions/minimum-1.0"
class FullExtension:
extension_uri = "asdf://somewhere.org/extensions/full-1.0"
def __init__(
self,
converters=None,
compressors=None,
validators=None,
asdf_standard_requirement=None,
tags=None,
legacy_class_names=None,
):
self._converters = [] if converters is None else converters
self._compressors = [] if compressors is None else compressors
self._validators = [] if validators is None else validators
self._asdf_standard_requirement = asdf_standard_requirement
self._tags = [] if tags is None else tags
self._legacy_class_names = [] if legacy_class_names is None else legacy_class_names
@property
def converters(self):
return self._converters
@property
def compressors(self):
return self._compressors
@property
def validators(self):
return self._validators
@property
def asdf_standard_requirement(self):
return self._asdf_standard_requirement
@property
def tags(self):
return self._tags
@property
def legacy_class_names(self):
return self._legacy_class_names
class MinimumConverter:
def __init__(self, tags=None, types=None):
if tags is None:
self._tags = []
else:
self._tags = tags
if types is None:
self._types = []
else:
self._types = types
@property
def tags(self):
return self._tags
@property
def types(self):
return self._types
def to_yaml_tree(self, obj, tag, ctx):
return "to_yaml_tree result"
def from_yaml_tree(self, obj, tag, ctx):
return "from_yaml_tree result"
class FullConverter(MinimumConverter):
def select_tag(self, obj, tags, ctx):
return "select_tag result"
class MinimalCompressor(Compressor):
@staticmethod
def compress(data):
return b""
@property
def label(self):
return b"mini"
class MinimalValidator(Validator):
schema_property = "fail"
tags = ["**"]
def validate(self, fail, node, schema):
if fail:
yield ValidationError("Node was doomed to fail")
# Some dummy types for testing converters:
class FooType:
pass
class SubFooType(FooType):
pass
class BarType:
pass
class BazType:
pass
def test_extension_proxy_maybe_wrap():
extension = MinimumExtension()
proxy = ExtensionProxy.maybe_wrap(extension)
assert proxy.delegate is extension
assert ExtensionProxy.maybe_wrap(proxy) is proxy
with pytest.raises(TypeError, match=r"Extension must implement the Extension interface"):
ExtensionProxy.maybe_wrap(object())
def test_extension_proxy():
# Test with minimum properties:
extension = MinimumExtension()
proxy = ExtensionProxy(extension)
assert isinstance(proxy, Extension)
assert proxy.extension_uri == "asdf://somewhere.org/extensions/minimum-1.0"
assert proxy.legacy_class_names == set()
assert proxy.asdf_standard_requirement == SpecifierSet()
assert proxy.converters == []
assert proxy.compressors == []
assert proxy.validators == []
assert proxy.tags == []
assert proxy.types == []
assert proxy.tag_mapping == []
assert proxy.url_mapping == []
assert proxy.delegate is extension
assert proxy.legacy is False
assert proxy.package_name is None
assert proxy.package_version is None
assert proxy.class_name == "asdf._tests.test_extension.MinimumExtension"
# The subclassed version should have the same defaults:
extension = MinimumExtensionSubclassed()
subclassed_proxy = ExtensionProxy(extension)
assert subclassed_proxy.extension_uri == proxy.extension_uri
assert subclassed_proxy.legacy_class_names == proxy.legacy_class_names
assert subclassed_proxy.asdf_standard_requirement == proxy.asdf_standard_requirement
assert subclassed_proxy.converters == proxy.converters
assert subclassed_proxy.compressors == proxy.compressors
assert subclassed_proxy.validators == proxy.validators
assert subclassed_proxy.tags == proxy.tags
assert subclassed_proxy.types == proxy.types
assert subclassed_proxy.tag_mapping == proxy.tag_mapping
assert subclassed_proxy.url_mapping == proxy.url_mapping
assert subclassed_proxy.delegate is extension
assert subclassed_proxy.legacy == proxy.legacy
assert subclassed_proxy.package_name == proxy.package_name
assert subclassed_proxy.package_version == proxy.package_name
assert subclassed_proxy.class_name == "asdf._tests.test_extension.MinimumExtensionSubclassed"
# Test with all properties present:
converters = [MinimumConverter(tags=["asdf://somewhere.org/extensions/full/tags/foo-*"], types=[])]
compressors = [MinimalCompressor()]
validators = [MinimalValidator()]
extension = FullExtension(
converters=converters,
compressors=compressors,
validators=validators,
asdf_standard_requirement=">=1.4.0",
tags=["asdf://somewhere.org/extensions/full/tags/foo-1.0"],
legacy_class_names=["foo.extensions.SomeOldExtensionClass"],
)
proxy = ExtensionProxy(extension, package_name="foo", package_version="1.2.3")
assert proxy.extension_uri == "asdf://somewhere.org/extensions/full-1.0"
assert proxy.legacy_class_names == {"foo.extensions.SomeOldExtensionClass"}
assert proxy.asdf_standard_requirement == SpecifierSet(">=1.4.0")
assert proxy.converters == [ConverterProxy(c, proxy) for c in converters]
assert proxy.compressors == compressors
assert proxy.validators == validators
assert len(proxy.tags) == 1
assert proxy.tags[0].tag_uri == "asdf://somewhere.org/extensions/full/tags/foo-1.0"
assert proxy.types == []
assert proxy.tag_mapping == []
assert proxy.url_mapping == []
assert proxy.delegate is extension
assert proxy.legacy is False
assert proxy.package_name == "foo"
assert proxy.package_version == "1.2.3"
assert proxy.class_name == "asdf._tests.test_extension.FullExtension"
# Should fail when the input is not one of the two extension interfaces:
with pytest.raises(TypeError, match=r"Extension must implement the Extension interface"):
ExtensionProxy(object)
# Should fail with a bad converter:
with pytest.raises(TypeError, match=r"Converter must implement the .* interface"):
ExtensionProxy(FullExtension(converters=[object()]))
# Should fail with a bad compressor:
with pytest.raises(TypeError, match=r"Extension property 'compressors' must contain instances of .*"):
ExtensionProxy(FullExtension(compressors=[object()]))
# Should fail with a bad validator
with pytest.raises(TypeError, match=r"Extension property 'validators' must contain instances of .*"):
ExtensionProxy(FullExtension(validators=[object()]))
# Unparsable ASDF Standard requirement:
with pytest.raises(ValueError, match=r"Invalid specifier:.*"):
ExtensionProxy(FullExtension(asdf_standard_requirement="asdf-standard >= 1.4.0"))
# Unrecognized ASDF Standard requirement type:
with pytest.raises(TypeError, match=r"Extension property 'asdf_standard_requirement' must be str or None"):
ExtensionProxy(FullExtension(asdf_standard_requirement=object()))
# Bad tag:
with pytest.raises(TypeError, match=r"Extension property 'tags' must contain str or .* values"):
ExtensionProxy(FullExtension(tags=[object()]))
# Bad legacy class names:
with pytest.raises(TypeError, match=r"Extension property 'legacy_class_names' must contain str values"):
ExtensionProxy(FullExtension(legacy_class_names=[object]))
def test_extension_proxy_tags():
"""
The tags behavior is a tad complex, so they get their own test.
"""
foo_tag_uri = "asdf://somewhere.org/extensions/full/tags/foo-1.0"
foo_tag_def = TagDefinition(
foo_tag_uri,
schema_uris="asdf://somewhere.org/extensions/full/schemas/foo-1.0",
title="Some tag title",
description="Some tag description",
)
bar_tag_uri = "asdf://somewhere.org/extensions/full/tags/bar-1.0"
bar_tag_def = TagDefinition(
bar_tag_uri,
schema_uris="asdf://somewhere.org/extensions/full/schemas/bar-1.0",
title="Some other tag title",
description="Some other tag description",
)
# The converter should return only the tags
# supported by the extension.
converter = FullConverter(tags=["**"])
extension = FullExtension(tags=[foo_tag_def], converters=[converter])
proxy = ExtensionProxy(extension)
assert proxy.converters[0].tags == [foo_tag_uri]
# The converter should not return tags that
# its patterns do not match.
converter = FullConverter(tags=["**/foo-1.0"])
extension = FullExtension(tags=[foo_tag_def, bar_tag_def], converters=[converter])
proxy = ExtensionProxy(extension)
assert proxy.converters[0].tags == [foo_tag_uri]
# The process should still work if the extension property
# contains str instead of TagDescription.
converter = FullConverter(tags=["**/foo-1.0"])
extension = FullExtension(tags=[foo_tag_uri, bar_tag_uri], converters=[converter])
proxy = ExtensionProxy(extension)
assert proxy.converters[0].tags == [foo_tag_uri]
def test_extension_proxy_hash_and_eq():
extension = MinimumExtension()
proxy1 = ExtensionProxy(extension)
proxy2 = ExtensionProxy(extension, package_name="foo", package_version="1.2.3")
assert proxy1 == proxy2
assert hash(proxy1) == hash(proxy2)
assert proxy1 != extension
assert proxy2 != extension
def test_extension_proxy_repr():
proxy = ExtensionProxy(MinimumExtension(), package_name="foo", package_version="1.2.3")
assert "class: asdf._tests.test_extension.MinimumExtension" in repr(proxy)
assert "package: foo==1.2.3" in repr(proxy)
assert "legacy: False" in repr(proxy)
proxy = ExtensionProxy(MinimumExtension())
assert "class: asdf._tests.test_extension.MinimumExtension" in repr(proxy)
assert "package: (none)" in repr(proxy)
assert "legacy: False" in repr(proxy)
def test_extension_manager():
converter1 = FullConverter(
tags=[
"asdf://somewhere.org/extensions/full/tags/foo-*",
"asdf://somewhere.org/extensions/full/tags/bar-*",
],
types=[
FooType,
"asdf._tests.test_extension.BarType",
],
)
converter2 = FullConverter(
tags=[
"asdf://somewhere.org/extensions/full/tags/baz-*",
],
types=[BazType],
)
converter3 = FullConverter(
tags=[
"asdf://somewhere.org/extensions/full/tags/foo-*",
],
types=[
FooType,
BarType,
],
)
extension1 = FullExtension(
converters=[converter1, converter2],
tags=[
"asdf://somewhere.org/extensions/full/tags/foo-1.0",
"asdf://somewhere.org/extensions/full/tags/baz-1.0",
],
)
extension2 = FullExtension(
converters=[converter3],
tags=[
"asdf://somewhere.org/extensions/full/tags/foo-1.0",
],
)
manager = ExtensionManager([extension1, extension2])
assert manager.extensions == [ExtensionProxy(extension1), ExtensionProxy(extension2)]
assert manager.handles_tag("asdf://somewhere.org/extensions/full/tags/foo-1.0") is True
assert manager.handles_tag("asdf://somewhere.org/extensions/full/tags/bar-1.0") is False
assert manager.handles_tag("asdf://somewhere.org/extensions/full/tags/baz-1.0") is True
assert manager.handles_type(FooType) is True
assert manager.handles_type(SubFooType) is False
# This should return True even though BarType was listed
# as string class name:
assert manager.handles_type(BarType) is True
assert manager.handles_type(BazType) is True
assert (
manager.get_tag_definition("asdf://somewhere.org/extensions/full/tags/foo-1.0").tag_uri
== "asdf://somewhere.org/extensions/full/tags/foo-1.0"
)
assert (
manager.get_tag_definition("asdf://somewhere.org/extensions/full/tags/baz-1.0").tag_uri
== "asdf://somewhere.org/extensions/full/tags/baz-1.0"
)
with pytest.raises(KeyError, match=r"No support available for YAML tag.*"):
manager.get_tag_definition("asdf://somewhere.org/extensions/full/tags/bar-1.0")
assert manager.get_converter_for_tag("asdf://somewhere.org/extensions/full/tags/foo-1.0").delegate is converter1
assert manager.get_converter_for_tag("asdf://somewhere.org/extensions/full/tags/baz-1.0").delegate is converter2
with pytest.raises(KeyError, match=r"No support available for YAML tag.*"):
manager.get_converter_for_tag("asdf://somewhere.org/extensions/full/tags/bar-1.0")
assert manager.get_converter_for_type(FooType).delegate is converter1
assert manager.get_converter_for_type(BarType).delegate is converter1
assert manager.get_converter_for_type(BazType).delegate is converter2
with pytest.raises(KeyError, match=r"\"No support available for Python type .*\""):
manager.get_converter_for_type(object)
with pytest.raises(KeyError, match=r"\"No support available for Python type .*\""):
manager.get_converter_for_type(SubFooType)
def test_get_cached_extension_manager():
extension = MinimumExtension()
extension_manager = get_cached_extension_manager([extension])
assert get_cached_extension_manager([extension]) is extension_manager
assert get_cached_extension_manager([MinimumExtension()]) is not extension_manager
def test_tag_definition():
tag_def = TagDefinition(
"asdf://somewhere.org/extensions/foo/tags/foo-1.0",
schema_uris="asdf://somewhere.org/extensions/foo/schemas/foo-1.0",
title="Some title",
description="Some description",
)
assert tag_def.tag_uri == "asdf://somewhere.org/extensions/foo/tags/foo-1.0"
assert tag_def.schema_uris == ["asdf://somewhere.org/extensions/foo/schemas/foo-1.0"]
assert tag_def.title == "Some title"
assert tag_def.description == "Some description"
assert "URI: asdf://somewhere.org/extensions/foo/tags/foo-1.0" in repr(tag_def)
tag_def = TagDefinition(
"asdf://somewhere.org/extensions/foo/tags/foo-1.0",
schema_uris=[
"asdf://somewhere.org/extensions/foo/schemas/foo-1.0",
"asdf://somewhere.org/extensions/foo/schemas/base-1.0",
],
title="Some title",
description="Some description",
)
assert tag_def.schema_uris == [
"asdf://somewhere.org/extensions/foo/schemas/foo-1.0",
"asdf://somewhere.org/extensions/foo/schemas/base-1.0",
]
with pytest.raises(ValueError, match=r"URI patterns are not permitted in TagDefinition"):
TagDefinition("asdf://somewhere.org/extensions/foo/tags/foo-*")
def test_converter():
class ConverterNoSubclass:
tags = []
types = []
def to_yaml_tree(self, *args):
pass
def from_yaml_tree(self, *args):
pass
assert issubclass(ConverterNoSubclass, Converter)
def test_converter_proxy():
# Test the minimum set of converter methods:
extension = ExtensionProxy(MinimumExtension())
converter = MinimumConverter()
proxy = ConverterProxy(converter, extension)
assert isinstance(proxy, Converter)
assert proxy.tags == []
assert proxy.types == []
assert proxy.to_yaml_tree(None, None, None) == "to_yaml_tree result"
assert proxy.from_yaml_tree(None, None, None) == "from_yaml_tree result"
assert proxy.tags == []
assert proxy.delegate is converter
assert proxy.extension == extension
assert proxy.package_name is None
assert proxy.package_version is None
assert proxy.class_name == "asdf._tests.test_extension.MinimumConverter"
# Check the __eq__ and __hash__ behavior:
assert proxy == ConverterProxy(converter, extension)
assert proxy != ConverterProxy(MinimumConverter(), extension)
assert proxy != ConverterProxy(converter, MinimumExtension())
assert proxy in {ConverterProxy(converter, extension)}
assert proxy not in {ConverterProxy(MinimumConverter(), extension), ConverterProxy(converter, MinimumExtension())}
# Check the __repr__:
assert "class: asdf._tests.test_extension.MinimumConverter" in repr(proxy)
assert "package: (none)" in repr(proxy)
# Test the full set of converter methods:
converter = FullConverter(
tags=[
"asdf://somewhere.org/extensions/test/tags/foo-*",
"asdf://somewhere.org/extensions/test/tags/bar-*",
],
types=[FooType, BarType],
)
extension = FullExtension(
tags=[
TagDefinition(
"asdf://somewhere.org/extensions/test/tags/foo-1.0",
schema_uris="asdf://somewhere.org/extensions/test/schemas/foo-1.0",
title="Foo tag title",
description="Foo tag description",
),
TagDefinition(
"asdf://somewhere.org/extensions/test/tags/bar-1.0",
schema_uris="asdf://somewhere.org/extensions/test/schemas/bar-1.0",
title="Bar tag title",
description="Bar tag description",
),
],
)
extension_proxy = ExtensionProxy(extension, package_name="foo", package_version="1.2.3")
proxy = ConverterProxy(converter, extension_proxy)
assert len(proxy.tags) == 2
assert "asdf://somewhere.org/extensions/test/tags/foo-1.0" in proxy.tags
assert "asdf://somewhere.org/extensions/test/tags/bar-1.0" in proxy.tags
assert proxy.types == [FooType, BarType]
assert proxy.to_yaml_tree(None, None, None) == "to_yaml_tree result"
assert proxy.from_yaml_tree(None, None, None) == "from_yaml_tree result"
assert proxy.select_tag(None, None) == "select_tag result"
assert proxy.delegate is converter
assert proxy.extension == extension_proxy
assert proxy.package_name == "foo"
assert proxy.package_version == "1.2.3"
assert proxy.class_name == "asdf._tests.test_extension.FullConverter"
# Check the __repr__ since it will contain package info now:
assert "class: asdf._tests.test_extension.FullConverter" in repr(proxy)
assert "package: foo==1.2.3" in repr(proxy)
# Should error because object() does fulfill the Converter interface:
with pytest.raises(TypeError, match=r"Converter must implement the .*"):
ConverterProxy(object(), extension)
# Should fail because tags must be str:
with pytest.raises(TypeError, match=r"Converter property .* must contain str values"):
ConverterProxy(MinimumConverter(tags=[object()]), extension)
# Should fail because types must instances of type:
with pytest.raises(TypeError, match=r"Converter property .* must contain str or type values"):
# as the code will ignore types if no relevant tags are found
# include a tag from this extension to make sure the proxy considers
# the types
ConverterProxy(MinimumConverter(tags=[extension.tags[0].tag_uri], types=[object()]), extension)
def test_converter_subclass_with_no_supported_tags():
"""
Adding a Converter to an Extension that doesn't list support for the tags
associated with the Converter should result in a failure to convert.
"""
class Foo:
pass
class FooConverterWithSubclass(Converter):
tags = ["asdf://somewhere.org/tags/foo-1.0.0"]
types = [Foo]
def to_yaml_tree(self, *args):
pass
def from_yaml_tree(self, *args):
pass
class FooExtension(Extension):
tags = []
converters = [FooConverterWithSubclass()]
extension_uri = "asdf://somewhere.org/extensions/foo-1.0.0"
tree = {"obj": Foo()}
with config_context() as cfg:
cfg.add_extension(FooExtension())
with pytest.raises(AsdfSerializationError, match=r"is not serializable by asdf"):
roundtrip_object(tree)
def test_manifest_extension():
with config_context() as config:
minimal_manifest = """%YAML 1.1
---
id: asdf://somewhere.org/manifests/foo
extension_uri: asdf://somewhere.org/extensions/foo
...
"""
config.add_resource_mapping({"asdf://somewhere.org/extensions/foo": minimal_manifest})
extension = ManifestExtension.from_uri("asdf://somewhere.org/extensions/foo")
assert isinstance(extension, Extension)
assert extension.extension_uri == "asdf://somewhere.org/extensions/foo"
assert extension.legacy_class_names == []
assert extension.asdf_standard_requirement is None
assert extension.converters == []
assert extension.compressors == []
assert extension.validators == []
assert extension.tags == []
proxy = ExtensionProxy(extension)
assert proxy.extension_uri == "asdf://somewhere.org/extensions/foo"
assert proxy.legacy_class_names == set()
assert proxy.asdf_standard_requirement == SpecifierSet()
assert proxy.converters == []
assert proxy.compressors == []
assert proxy.validators == []
assert proxy.tags == []
with config_context() as config:
full_manifest = """%YAML 1.1
---
id: asdf://somewhere.org/manifests/foo
extension_uri: asdf://somewhere.org/extensions/foo
asdf_standard_requirement:
gte: 1.6.0
lt: 2.0.0
tags:
- asdf://somewhere.org/tags/bar
- tag_uri: asdf://somewhere.org/tags/baz
schema_uri: asdf://somewhere.org/schemas/baz
title: Baz title
description: Bar description
...
"""
config.add_resource_mapping({"asdf://somewhere.org/extensions/foo": full_manifest})
class FooConverter:
tags = ["asdf://somewhere.org/tags/bar", "asdf://somewhere.org/tags/baz"]
types = []
def select_tag(self, *args):
pass
def to_yaml_tree(self, *args):
pass
def from_yaml_tree(self, *args):
pass
converter = FooConverter()
validator = MinimalValidator()
compressor = MinimalCompressor()
extension = ManifestExtension.from_uri(
"asdf://somewhere.org/extensions/foo",
legacy_class_names=["foo.extension.LegacyExtension"],
converters=[converter],
compressors=[compressor],
validators=[validator],
)
assert extension.extension_uri == "asdf://somewhere.org/extensions/foo"
assert extension.legacy_class_names == ["foo.extension.LegacyExtension"]
assert extension.asdf_standard_requirement == SpecifierSet(">=1.6.0,<2.0.0")
assert extension.converters == [converter]
assert extension.compressors == [compressor]
assert extension.validators == [validator]
assert len(extension.tags) == 2
assert extension.tags[0] == "asdf://somewhere.org/tags/bar"
assert extension.tags[1].tag_uri == "asdf://somewhere.org/tags/baz"
assert extension.tags[1].schema_uris == ["asdf://somewhere.org/schemas/baz"]
assert extension.tags[1].title == "Baz title"
assert extension.tags[1].description == "Bar description"
proxy = ExtensionProxy(extension)
assert proxy.extension_uri == "asdf://somewhere.org/extensions/foo"
assert proxy.legacy_class_names == {"foo.extension.LegacyExtension"}
assert proxy.asdf_standard_requirement == SpecifierSet(">=1.6.0,<2.0.0")
assert proxy.converters == [ConverterProxy(converter, proxy)]
assert proxy.compressors == [compressor]
assert proxy.validators == [validator]
assert len(proxy.tags) == 2
assert proxy.tags[0].tag_uri == "asdf://somewhere.org/tags/bar"
assert proxy.tags[1].tag_uri == "asdf://somewhere.org/tags/baz"
assert proxy.tags[1].schema_uris == ["asdf://somewhere.org/schemas/baz"]
assert proxy.tags[1].title == "Baz title"
assert proxy.tags[1].description == "Bar description"
with config_context() as config:
simple_asdf_standard_manifest = """%YAML 1.1
---
id: asdf://somewhere.org/manifests/foo
extension_uri: asdf://somewhere.org/extensions/foo
asdf_standard_requirement: 1.6.0
...
"""
config.add_resource_mapping({"asdf://somewhere.org/extensions/foo": simple_asdf_standard_manifest})
extension = ManifestExtension.from_uri("asdf://somewhere.org/extensions/foo")
assert extension.asdf_standard_requirement == SpecifierSet("==1.6.0")
proxy = ExtensionProxy(extension)
assert proxy.asdf_standard_requirement == SpecifierSet("==1.6.0")
def test_validator():
validator = MinimalValidator()
extension = FullExtension(validators=[validator])
failing_schema = """
type: object
properties:
foo:
fail: true
"""
passing_schema = """
type: object
properties:
foo:
fail: false
"""
with config_context() as config:
config.add_extension(extension)
config.add_resource_mapping(
{
"asdf://somewhere.org/schemas/failing": failing_schema,
"asdf://somewhere.org/schemas/passing": passing_schema,
},
)
with AsdfFile(custom_schema="asdf://somewhere.org/schemas/passing") as af:
af["foo"] = "bar"
af.validate()
with AsdfFile(custom_schema="asdf://somewhere.org/schemas/failing") as af:
af.validate()
af["foo"] = "bar"
with pytest.raises(ValidationError, match=r"Node was doomed to fail"):
af.validate()
def test_converter_deferral():
class Bar:
def __init__(self, value):
self.value = value
class Foo(Bar):
pass
class Baz(Bar):
pass
class FooConverter:
tags = []
types = [Foo]
def select_tag(self, *args):
return None
def to_yaml_tree(self, obj, tag, ctx):
# convert Foo instance to Bar
return Bar(obj.value)
def from_yaml_tree(self, node, tag, ctx):
raise NotImplementedError()
class BarConverter:
tags = ["asdf://somewhere.org/tags/bar"]
types = [Bar]
def to_yaml_tree(self, obj, tag, ctx):
return {"value": obj.value}
def from_yaml_tree(self, node, tag, ctx):
return Bar(node["value"])
class BazConverter:
tags = []
types = [Baz]
def select_tag(self, *args):
return None
def to_yaml_tree(self, obj, tag, ctx):
return Foo(obj.value)
def from_yaml_tree(self, node, tag, ctx):
raise NotImplementedError()
extension = FullExtension(converters=[FooConverter(), BarConverter(), BazConverter()], tags=BarConverter.tags)
with config_context() as config:
config.add_extension(extension)
foo = Foo(26)
bar = Bar(42)
baz = Baz(720)
bar_rt = roundtrip_object(bar)
assert isinstance(bar_rt, Bar)
assert bar_rt.value == bar.value
foo_rt = roundtrip_object(foo)
assert isinstance(foo_rt, Bar)
assert foo_rt.value == foo.value
baz_rt = roundtrip_object(baz)
assert isinstance(baz_rt, Bar)
assert baz_rt.value == baz.value
def test_converter_loop():
class Bar:
def __init__(self, value):
self.value = value
class Foo(Bar):
pass
class Baz(Bar):
pass
class FooConverter:
tags = []
types = [Foo]
def select_tag(self, *args):
return None
def to_yaml_tree(self, obj, tag, ctx):
return Bar(obj.value)
def from_yaml_tree(self, node, tag, ctx):
raise NotImplementedError()
class BarConverter:
tags = []
types = [Bar]
def select_tag(self, *args):
return None
def to_yaml_tree(self, obj, tag, ctx):
return Baz(obj.value)
def from_yaml_tree(self, node, tag, ctx):
raise NotImplementedError()
class BazConverter:
tags = []
types = [Baz]
def select_tag(self, *args):
return None
def to_yaml_tree(self, obj, tag, ctx):
return Foo(obj.value)
def from_yaml_tree(self, node, tag, ctx):
raise NotImplementedError()
extension = FullExtension(converters=[FooConverter(), BarConverter(), BazConverter()])
with config_context() as config:
config.add_extension(extension)
for typ in (Foo, Bar, Baz):
obj = typ(42)
with pytest.raises(TypeError, match=r"Conversion cycle detected"):
roundtrip_object(obj)
@pytest.mark.parametrize("is_subclass", [True, False])
@pytest.mark.parametrize("indirect", [True, False])
def test_warning_or_error_for_default_select_tag(is_subclass, indirect):
class Foo:
pass
ParentClass = Converter if is_subclass else object
if indirect:
class IntermediateClass(ParentClass):
pass
ParentClass = IntermediateClass
class FooConverter(ParentClass):
tags = ["asdf://somewhere.org/tags/foo-*"]
types = [Foo]
def to_yaml_tree(self, obj, tag, ctx):
return {}
def from_yaml_tree(self, node, tag, ctx):
return Foo()
tags = [
"asdf://somewhere.org/tags/foo-1.0.0",
"asdf://somewhere.org/tags/foo-2.0.0",
]
extension = FullExtension(converters=[FooConverter()], tags=tags)
with config_context() as config:
with pytest.raises(RuntimeError, match="Converter handles multiple tags"):
config.add_extension(extension)
def test_reference_cycle(tmp_path, with_lazy_tree):
class FractionWithInverse(fractions.Fraction):
def __init__(self, *args, **kwargs):
self._inverse = None
@property
def inverse(self):
return self._inverse
@inverse.setter
def inverse(self, value):
self._inverse = value
class FractionWithInverseConverter:
tags = ["asdf://example.com/fractions/tags/fraction-1.0.0"]
types = [FractionWithInverse]
def to_yaml_tree(self, obj, tag, ctx):
return {
"numerator": obj.numerator,
"denominator": obj.denominator,
"inverse": obj.inverse,
}
def from_yaml_tree(self, node, tag, ctx):
obj = FractionWithInverse(node["numerator"], node["denominator"])
yield obj
obj.inverse = node["inverse"]
class FractionWithInverseExtension:
tags = FractionWithInverseConverter.tags
converters = [FractionWithInverseConverter()]
extension_uri = "asdf://example.com/fractions/extensions/fraction-1.0.0"
with config_context() as cfg:
cfg.add_extension(FractionWithInverseExtension())
f1 = FractionWithInverse(3, 5)
f2 = FractionWithInverse(5, 3)
f1.inverse = f2
f2.inverse = f1
fn = tmp_path / "test.asdf"
asdf.AsdfFile({"obj": f1}).write_to(fn)
with asdf.open(fn) as af:
read_f1 = af["obj"]
assert read_f1.inverse.inverse is read_f1
def test_manifest_uri_id_mismatch_warning(tmp_path):
with config_context() as config:
# make an extension with a manifest (where id doesn't match the registered uri)
full_manifest = """%YAML 1.1
---
id: asdf://somewhere.org/manifests/foo
extension_uri: asdf://somewhere.org/extensions/foo
tags:
- asdf://somewhere.org/tags/bar
...
"""
config.add_resource_mapping({"asdf://somewhere.org/extensions/foo": full_manifest})
class Foo:
pass
class FooConverter:
tags = ["asdf://somewhere.org/tags/bar"]
types = [Foo]
def to_yaml_tree(self, *args):
return {}
def from_yaml_tree(self, *args):
return Foo()
extension = ManifestExtension.from_uri(
"asdf://somewhere.org/extensions/foo",
converters=[FooConverter()],
)
# use the extension to write out a file
config.add_extension(extension)
af = AsdfFile()
af["foo"] = Foo()
fn = tmp_path / "foo.asdf"
with pytest.warns(AsdfManifestURIMismatchWarning):
af.write_to(fn)
def test_resolve_type_not_imported():
path = "mailbox.Mailbox"
if "mailbox" in sys.modules:
del sys.modules["mailbox"]
assert _resolve_type(path) is None
import mailbox
assert _resolve_type(path) is mailbox.Mailbox
@pytest.mark.parametrize(
"path, obj", (("sys", sys), ("asdf.AsdfFile", AsdfFile), ("asdf.Missing", None), ("not_a_module", None))
)
def test_resolve_type(path, obj):
assert _resolve_type(path) is obj
def test_extension_converter_by_class_path():
class MailboxConverter:
tags = ["asdf://example.com/tags/mailbox-1.0.0"]
types = ["mailbox.Mailbox"]
def to_yaml_tree(self, obj, tag, ctx):
return {}
def from_yaml_tree(self, node, tag, ctx):
return None
class MailboxExtension:
tags = MailboxConverter.tags
converters = [MailboxConverter()]
extension_uri = "asdf://example.com/extensions/mailbox-1.0.0"
# grab the type so we can use it for extension_manager.get_converter_for_type
import mailbox
typ = mailbox.Mailbox
del sys.modules["mailbox"], mailbox
with config_context() as cfg:
cfg.add_extension(MailboxExtension())
extension_manager = AsdfFile().extension_manager
# make sure that registering the extension did not load the module
assert "mailbox" not in sys.modules
# as the module hasn't been loaded, the converter shouldn't be found
with pytest.raises(KeyError, match="No support available for Python type 'mailbox.Mailbox'"):
extension_manager.get_converter_for_type(typ)
# make sure inspecting the type didn't import the module
assert "mailbox" not in sys.modules
# finally, import the module and check that the converter can now be found
import mailbox
converter = extension_manager.get_converter_for_type(mailbox.Mailbox)
assert isinstance(converter.delegate, MailboxConverter)
def test_named_tuple_extension():
Point = collections.namedtuple("Point", ["x", "y"])
class PointConverter:
tags = ["asdf://example.com/tags/point-1.0.0"]
types = [Point]
def to_yaml_tree(self, obj, tag, ctx):
return list(obj)
def from_yaml_tree(self, node, tag, ctx):
return Point(*node)
class PointExtension:
tags = PointConverter.tags
converters = [PointConverter()]
extension_uri = "asdf://example.com/extensions/point-1.0.0"
pt = Point(1, 2)
# without the extension we can't serialize this
with pytest.raises(AsdfSerializationError, match="is not serializable by asdf"):
roundtrip_object(pt)
with config_context() as cfg:
cfg.add_extension(PointExtension())
rpt = roundtrip_object(pt)
assert isinstance(rpt, Point)
|