Changes between Version 13 and Version 14 of PyYAMLDocumentation

Timestamp:

05/07/06 03:05:55 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -956 +956 @@
 {{{
 #!python
+Loader(stream)
+SafeLoader(stream)
 BaseLoader(stream)
-SafeLoader(stream)
-Loader(stream)
-}}}
-
-'''`BaseLoader`''', '''`SafeLoader`''', and '''`Loader`''' provide the PyYAML ''Loader'' interfaces.
-'''`Loader`''' is the most common of them and should be used in most cases. '''`BaseLoader`''' does not
-resolve or support any tags and construct only basic Python objects: lists, dictionaries and Unicode strings.
-'''`SafeLoader`''' supports only standard YAML tags and thus it does not construct class instances and
-probably safe to use with documents received from an untrusted source.
-
-'''`stream`''' is an input YAML stream. It can be a string, a Unicode string, an open file, an open Unicode file.
+}}}
+
+'''`BaseLoader`''', '''`SafeLoader`''', and '''`Loader`''' provide the following interfaces:
+ ''Scanner'', ''Parser'', ''Composer'', ''Constructor'', ''Resolver''.
+ 
+'''`Loader(stream)`''' is the most common of the above classes and should be used in most cases.
+`stream` is an input YAML stream. It can be a string, a Unicode string, an open file, an open Unicode file.
+
+'''`Loader`''' supports all predefined tags and may construct an arbitrary Python object. Therefore it is not safe to use
+`Loader` to load a document received from an untrusted source. By default, the functions `scan`, `parse`,
+`compose`, `construct`, and others use `Loader`.
+
+'''`SafeLoader(stream)`''' supports only standard YAML tags and thus it does not construct class instances and
+probably safe to use with documents received from an untrusted source. The functions `safe_load` and
+`safe_load_all` use `SafeLoader` to parse a stream.
+
+'''`BaseLoader(stream)`''' does not resolve or support any tags and construct only basic Python objects:
+lists, dictionaries and Unicode strings.
+
 
 
@@ -1017 +1027 @@
 
 ==== Composer interface ====
+
+{{{
+#!python
+compose(stream, Loader=Loader)
+compose_all(stream, Loader=Loader)
+
+Loader.check_node()
+Loader.get_node()
+}}}
+
+'''`compose(stream)`''' parses the given `stream` and returns the root of the representation graph
+for the first document in the stream. If there are no documents in the stream, it returns `None`.
+
+'''`compose_all(stream)`''' parses the given `stream` and returns a sequence of representation graphs
+corresponding to the documents in the stream.
+
+'''`Loader.check_node()`''' returns `True` is there are more documents available in the stream. Otherwise
+it returns `False`.
+
+'''`Loader.get_node()`''' construct the representation graph of the next document in the stream and
+returns its root node.