Changes between Version 18 and Version 19 of PyYAMLDocumentation

Timestamp:

05/07/06 04:40:22 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -1081 +1081 @@
 }}}
 
-'''`construct(stream)`''' parses the given `stream` and returns a Python object constructed from
+'''`load(stream)`''' parses the given `stream` and returns a Python object constructed from
 for the first document in the stream. If there are no documents in the stream, it returns `None`.
 
-'''`construct_all(stream)`''' parses the given `stream` and returns a sequence of Python objects
+'''`load_all(stream)`''' parses the given `stream` and returns a sequence of Python objects
 corresponding to the documents in the stream.
+
+'''`safe_load(stream)`''' parses the given `stream` and returns a Python object constructed from
+for the first document in the stream. If there are no documents in the stream, it returns `None`.
+`safe_load` recognizes only standard YAML tags and cannot construct an arbitrary Python object.
+
+'''`safe_load_all(stream)`''' parses the given `stream` and returns a sequence of Python objects
+corresponding to the documents in the stream. `safe_load_all` recognizes only standard YAML tags
+and cannot construct an arbitrary Python object.
 
 '''`Loader.check_data()`''' returns `True` is there are more documents available in the stream. Otherwise
@@ -1231 +1239 @@
 ==== Representer interface ====
 
+{{{
+#!python
+dump(data, stream=None, Dumper=Dumper,
+    default_style=None,
+    default_flow_style=None,
+    encoding='utf-8',
+    explicit_start=None,
+    explicit_end=None,
+    version=None,
+    tags=None,
+    canonical=None,
+    indent=None,
+    width=None,
+    allow_unicode=None,
+    line_break=None)
+dump_all(data, stream=None, Dumper=Dumper, ...)
+
+safe_dump(data, stream=None, ...)
+safe_dump_all(data, stream=None, ...)
+
+Dumper.represent(data)
+
+def representer(dumper, data):
+    # ...
+    return node
+
+def multi_representer(dumper, data):
+    # ...
+    return node
+
+add_representer(data_type, representer, Dumper=Dumper)
+add_multi_representer(base_data_type, multi_representer, Dumper=Dumper)
+
+Dumper.add_representer(data_type, representer) # Dumper.add_representer is a class method.
+Dumper.add_multi_representer(base_data_type, multi_representer) # Dumper.add_multi_representer is a class method.
+
+Dumper.represent_scalar(tag, value, style=None)
+Dumper.represent_sequence(tag, value, flow_style=None)
+Dumper.represent_mapping(tag, value, flow_style=None)
+}}}
+
+'''`dump(data, stream=None)`''' serializes the given Python object into the `stream`.
+If `stream` is `None`, it returns the produced stream.
+
+'''`dump_all(data, stream=None)`''' serializes the given sequence of Python objects
+into the given `stream`. If `stream` is `None`, it returns the produced stream.
+Each object is represented as a YAML document.
+
+'''`safe_dump(data, stream=None)`''' serializes the given Python object into the `stream`.
+If `stream` is `None`, it returns the produced stream. `safe_dump` produces only standard YAML
+tags and cannot represent an arbitrary Python object.
+
+'''`safe_dump_all(data, stream=None)`''' serializes the given sequence of Python objects
+into the given `stream`. If `stream` is `None`, it returns the produced stream.
+Each object is represented as a YAML document.  `safe_dump_all` produces only standard YAML
+tags and cannot represent an arbitrary Python object.
+
+'''`Dumper.represent(data)`''' serializes the given Python object to the output YAML stream.
+
+'''`add_representer(data_type, representer)`''' and '''`Dumper.add_representer(data_type, representer)`'''
+allow to specify a `representer` for Python objects of the given `data_type`. A representer is a function
+that converts a native Python object to a node of a YAML representation graph. A representer accepts
+an instance of `Dumper` and an object and returns a node.
+
+'''`add_multi_representer(base_data_type, multi_representer)`''' and '''`Dumper.add_multi_representer(base_data_type, multi_representer)`'''
+allow to specify a `multi_representer` for Python objects of the given `base_data_type` or any of its subclasses.
+A multi-representer is a function that converts a native Python object to a node of a YAML representation graph.
+A multi-representer accepts an instance of `Dumper` and an object and returns a node.
+
+'''`Dumper.represent_scalar(tag, value, style=None)`''' returns a scalar node with the given `tag`, `value`, and `style`.
+This function is intended to be used in representers.
+
+'''`Dumper.represent_sequence(tag, sequence, flow_style=None)`''' return a sequence node with the given `tag`
+and subnodes generated from the items of the given `sequence`.
+
+'''`Dumper.represent_mapping(tag, mapping, flow_style=None)`''' return a mapping node with the given `tag`
+and subnodes generated from the keys and values of the given `mapping`.
+
 
 ==== Resolver interface ====
+
+The ''Resolver'' interfaces of '''`Loader`''' and '''`Dumper`''' are identical. Check the corresponding section
+of the '''`Loader`''' reference.