PyYaml 5.1 added some breaking changes. We now comply with them while still supporting the old versions. Fixed #8

Author: Sylvain MARIE

.travis.yml

@@ -7,11 +7,15 @@ matrix:
   include:
 #    - python: 2.6
     - python: 2.7
+      PYYAML_VERSION: ""
 #    - python: 3.3
 #    - python: 3.4
     - python: 3.5
+      PYYAML_VERSION: "<5"
     - python: 3.6
+      PYYAML_VERSION: ""
     - python: 3.7
+      PYYAML_VERSION: ""
       dist: xenial
       sudo: true
 

ci_tools/requirements-pip.txt

@@ -4,6 +4,9 @@ pytest-runner
 pandoc
 pypandoc
 
+# --- to install
+pyyaml$PYYAML_VERSION
+
 # --- to run the tests
 pytest  #$PYTEST_VERSION
 pytest-logging  # ==2015.11.4

yamlable/main.py

@@ -262,7 +262,17 @@ def encode_yamlable(dumper,
         return dumper.represent_mapping(yaml_tag, new_data, flow_style=None)
 
 
-def register_yamlable_codec(loaders=(Loader, SafeLoader), dumpers=(Dumper, SafeDumper)):
+try:  # PyYaml 5.1+
+    from yaml import FullLoader, UnsafeLoader
+    ALL_PYYAML_LOADERS = (Loader, SafeLoader, FullLoader, UnsafeLoader)
+except ImportError:
+    ALL_PYYAML_LOADERS = (Loader, SafeLoader)
+
+
+ALL_PYYAML_DUMPERS = (Dumper, SafeDumper)
+
+
+def register_yamlable_codec(loaders=ALL_PYYAML_LOADERS, dumpers=ALL_PYYAML_DUMPERS):
     # type: (...) -> None
     """
     Registers the yamlable encoder and decoder with all pyYaml loaders and dumpers.
@@ -472,17 +482,17 @@ def to_yaml_dict(cls, obj):
         """
 
     @classmethod
-    def register_with_pyyaml(cls, loaders={Loader, SafeLoader}, dumpers={Dumper, SafeDumper}):
+    def register_with_pyyaml(cls, loaders=ALL_PYYAML_LOADERS, dumpers=ALL_PYYAML_DUMPERS):
         # type: (...) -> None
         """
         Registers this codec with PyYaml, on the provided loaders and dumpers (default: all PyYaml loaders and dumpers).
          - The encoding part is registered for the object types listed in cls.get_known_types(), in order
          - The decoding part is registered for the yaml prefix in cls.get_yaml_prefix()
 
         :param loaders: the PyYaml loaders to register this codec with. By default all pyyaml loaders are considered
-            (Loader, SafeLoader)
+            (Loader, SafeLoader...)
         :param dumpers: the PyYaml dumpers to register this codec with. By default all pyyaml loaders are considered
-            (Dumper, SafeDumper)
+            (Dumper, SafeDumper...)
         :return:
         """
         for loader in loaders:

yamlable/tests/test_yamlable.py

@@ -81,8 +81,11 @@ def __from_yaml_dict__(cls,  # type: Type[Y]
     f = Foo(1, 'hello')  # note:
 
     # dump
-    y = f.dumps_yaml()
-    assert y == "!yamlable/yaml.tests.Foo {a: 1, b: hello}\n"
+    y = f.dumps_yaml(default_flow_style=False)
+    assert y == """!yamlable/yaml.tests.Foo
+a: 1
+b: hello
+"""
 
     # dump io
     class MemorizingStringIO(StringIO):
@@ -93,11 +96,11 @@ def close(self):
             StringIO.close(self)
 
     s = MemorizingStringIO()
-    f.dump_yaml(s)
+    f.dump_yaml(s, default_flow_style=False)
     assert s.value == y
 
     # dump pyyaml
-    assert dump(f) == y
+    assert dump(f, default_flow_style=False) == y
 
     # load
     assert f == Foo.loads_yaml(y)
@@ -147,8 +150,11 @@ def from_yaml_dict(cls,  # type: Type[Y]
     f = FooLegacy(1, 'hello')
 
     # dump
-    y = f.dumps_yaml()
-    assert y == "!yamlable/yaml.tests.FooLegacy {a: 1, b: hello}\n"
+    y = f.dumps_yaml(default_flow_style=False)
+    assert y == """!yamlable/yaml.tests.FooLegacy
+a: 1
+b: hello
+"""
 
     # dump io
     class MemorizingStringIO(StringIO):
@@ -159,11 +165,11 @@ def close(self):
             StringIO.close(self)
 
     s = MemorizingStringIO()
-    f.dump_yaml(s)
+    f.dump_yaml(s, default_flow_style=False)
     assert s.value == y
 
     # dump pyyaml
-    assert dump(f) == y
+    assert dump(f, default_flow_style=False) == y
 
     # load
     assert f == FooLegacy.loads_yaml(y)
@@ -228,10 +234,13 @@ def __init__(self, a, b):
             self.b = b
 
     f = Foo_Default(1, 'hello')
-    s = '!yamlable/yaml.tests.Foo_Default {a: 1, b: hello}\n'
-    assert dump(f) == s
+    s = """!yamlable/yaml.tests.Foo_Default
+a: 1
+b: hello
+"""
+    assert dump(f, default_flow_style=False) == s
 
-    assert dump(load(dump(load(s)))) == s
+    assert dump(load(dump(load(s))), default_flow_style=False) == s
 
 
 def test_help_yaml_info():
@@ -297,8 +306,11 @@ def __eq__(self, other):
     f = FooValid(1, 'hello')  # note:
 
     # dump
-    y = f.dumps_yaml()
-    assert y == "!yamlable/yaml.tests.FooValid {a: 1, b: hello}\n"
+    y = f.dumps_yaml(default_flow_style=False)
+    assert y == """!yamlable/yaml.tests.FooValid
+a: 1
+b: hello
+"""
 
     # dump io
     class MemorizingStringIO(StringIO):
@@ -310,11 +322,11 @@ def close(self):
             StringIO.close(self)
 
     s = MemorizingStringIO()
-    f.dump_yaml(s)
+    f.dump_yaml(s, default_flow_style=False)
     assert s.value == y
 
     # dump pyyaml
-    assert dump(f) == y
+    assert dump(f, default_flow_style=False) == y
 
     # load
     assert f == FooValid.loads_yaml(y)

yamlable/tests/test_yamlcodec.py

@@ -69,14 +69,19 @@ def to_yaml_dict(cls, obj):
 
     # instantiate
     f = Foo(1, 'hello')
-    fy = "!mycodec/yaml.tests.Foo {a: 1, b: hello}\n"
+    fy = """!mycodec/yaml.tests.Foo
+a: 1
+b: hello
+"""
 
     b = Bar('what?')
-    by = "!mycodec/yaml.tests.Bar {c: 'what?'}\n"
+    by = """!mycodec/yaml.tests.Bar
+c: what?
+"""
 
     # dump pyyaml
-    assert dump(f) == fy
-    assert dump(b) == by
+    assert dump(f, default_flow_style=False) == fy
+    assert dump(b, default_flow_style=False) == by
 
     # load pyyaml
     assert f == load(fy)

yamlable/tests/test_yamlobjects.py

@@ -49,8 +49,11 @@ def __from_yaml_dict__(cls,      # type: Type[Y]
     f = Foo(1, 'hello')
 
     # dump to yaml
-    o = f.dumps_yaml(safe=False)
-    assert o == "!foo {a: 1, b: hello}\n"
+    o = f.dumps_yaml(safe=False, default_flow_style=False)
+    assert o == """!foo
+a: 1
+b: hello
+"""
 
     # load from yaml
     g = Foo.loads_yaml(o)
@@ -104,8 +107,11 @@ def __eq__(self, other):
     f = FooValid(1, 'hello')
 
     # dump to yaml
-    o = f.dumps_yaml(safe=False)
-    assert o == "!foo {a: 1, b: hello}\n"
+    o = f.dumps_yaml(safe=False, default_flow_style=False)
+    assert o == """!foo
+a: 1
+b: hello
+"""
 
     # load from yaml
     g = FooValid.loads_yaml(o)