Renamed from_yaml_sequence into from_yaml_list for consistency with from_yaml_dict

Author: Sylvain MARIE

docs/index.md

@@ -125,7 +125,7 @@ Objects can also be loaded from YAML sequences:
 Foo - {'a': 0, 'b': 'hey'}
 ```
 
-The default implementation of `__from_yaml_sequence__` (that you may wish to override in your subclass), is to call
+The default implementation of `__from_yaml_list__` (that you may wish to override in your subclass), is to call
 the constructor with the sequence contents as positional arguments.
 
 The same also works for scalars:

docs/usage.md

@@ -122,5 +122,5 @@ assert b == load(by)
 
 Objects can be loaded from sequences and scalars, in addition to dictionaries. To support this possibility, you simply need to fill the class methods:
 
- - `from_yaml_sequence` for sequences
+ - `from_yaml_list` for sequences
  - `from_yaml_scalar` for scalars

yamlable/base.py

@@ -63,7 +63,7 @@ class AbstractYamlObject(six.with_metaclass(ABCMeta, object)):
     #     raise NotImplementedError("Please override `__to_yaml_scalar__` if you wish to dump instances of `%s`"
     #                               " as yaml scalars." % type(self).__name__)
     #
-    # def __to_yaml_sequence__(self):
+    # def __to_yaml_list__(self):
     #     # type: (...) -> Sequence[Any]
     #     """
     #     Implementors should transform the object into a Sequence containing all information necessary to decode the
@@ -72,7 +72,7 @@ class AbstractYamlObject(six.with_metaclass(ABCMeta, object)):
     #     Default implementation raises an error.
     #     :return:
     #     """
-    #     raise NotImplementedError("Please override `__to_yaml_sequence__` if you wish to dump instances of `%s`"
+    #     raise NotImplementedError("Please override `__to_yaml_list__` if you wish to dump instances of `%s`"
     #                               " as yaml sequences." % type(self).__name__)
 
     def __to_yaml_dict__(self):
@@ -117,10 +117,10 @@ def __from_yaml_scalar__(cls,      # type: Type[Y]
         return cls(scalar)  # type: ignore
 
     @classmethod
-    def __from_yaml_sequence__(cls,      # type: Type[Y]
-                               seq,      # type: Sequence[Any]
-                               yaml_tag  # type: str
-                               ):
+    def __from_yaml_list__(cls,      # type: Type[Y]
+                           seq,      # type: Sequence[Any]
+                           yaml_tag  # type: str
+                           ):
         # type: (...) -> Y
         """
         Implementors should transform the given Sequence (read from yaml by the pyYaml stack) into an object instance.
@@ -333,7 +333,7 @@ def read_yaml_node_as_yamlobject(
 
     elif isinstance(node, SequenceNode):
         constructor_args = read_yaml_node_as_sequence(loader, node)
-        return cls.__from_yaml_sequence__(constructor_args, yaml_tag=yaml_tag)  # type: ignore
+        return cls.__from_yaml_list__(constructor_args, yaml_tag=yaml_tag)  # type: ignore
 
     elif isinstance(node, MappingNode):
         constructor_args = read_yaml_node_as_dict(loader, node)

yamlable/main.py

@@ -416,7 +416,7 @@ def decode(cls, loader,
 
             elif isinstance(node, SequenceNode):
                 constructor_args = read_yaml_node_as_sequence(loader, node)
-                return cls.from_yaml_sequence(yaml_tag_suffix, constructor_args, **kwargs)  # type: ignore
+                return cls.from_yaml_list(yaml_tag_suffix, constructor_args, **kwargs)  # type: ignore
 
             elif isinstance(node, MappingNode):
                 constructor_args = read_yaml_node_as_dict(loader, node)
@@ -456,10 +456,10 @@ def from_yaml_scalar(cls,
                                   "`from_yaml_scalar` to support this feature.")
 
     @classmethod
-    def from_yaml_sequence(cls,
-                           yaml_tag_suffix,  # type: str
-                           seq,              # type: Sequence[Any]
-                           **kwargs):
+    def from_yaml_list(cls,
+                       yaml_tag_suffix,  # type: str
+                       seq,              # type: Sequence[Any]
+                       **kwargs):
         # type: (...) -> Any
         """
         Implementing classes should create an object corresponding to the given yaml tag, using the given YAML sequence.
@@ -470,7 +470,7 @@ def from_yaml_sequence(cls,
         :return:
         """
         raise NotImplementedError("This codec does not support loading objects from sequence. Please override "
-                                  "`from_yaml_sequence` to support this feature.")
+                                  "`from_yaml_list` to support this feature.")
 
     @classmethod
     @abstractmethod

yamlable/tests/test_yamlcodec.py

@@ -103,10 +103,10 @@ def to_yaml_dict(cls, obj):
 
     class MyCodec2(MyCodec):
         @classmethod
-        def from_yaml_sequence(cls,
-                               yaml_tag_suffix,  # type: str
-                               seq,              # type: Sequence[Any]
-                               **kwargs):
+        def from_yaml_list(cls,
+                           yaml_tag_suffix,  # type: str
+                           seq,              # type: Sequence[Any]
+                           **kwargs):
             # type: (...) -> Any
             typ = yaml_tags_to_types[yaml_tag_suffix]
             return typ(*seq)