Changes between Version 14 and Version 15 of PyYAMLDocumentation

Timestamp:

05/07/06 03:23:42 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -991 +991 @@
 }}}
 
-The function '''`scan(stream)`''' scans the given `stream` and produces a sequence of tokens.
-
-The method '''`Loader.check_token(*TokenClasses)`''' returns `True` if the next token in the stream
+'''`scan(stream)`''' scans the given `stream` and produces a sequence of tokens.
+
+'''`Loader.check_token(*TokenClasses)`''' returns `True` if the next token in the stream
 is an instance of one of the given `TokenClasses`. Otherwise it returns `False`.
 
-The method '''`Loader.peek_token()`''' returns the next token in the stream, but does not remove
+'''`Loader.peek_token()`''' returns the next token in the stream, but does not remove
 it from the internal token queue. The function returns `None` at the end of the stream.
 
-The method '''`Loader.get_token()`''' returns the next token in the stream and removes
+'''`Loader.get_token()`''' returns the next token in the stream and removes
 it from the internal token queue. The function returns `None` at the end of the stream.
 
@@ -1014 +1014 @@
 }}}
 
-The function '''`parse(stream)`''' parses the given `stream` and produces a sequence of parsing events.
-
-The method '''`Loader.check_event(*EventClasses)`''' returns `True` if the next event in the stream
+'''`parse(stream)`''' parses the given `stream` and produces a sequence of parsing events.
+
+'''`Loader.check_event(*EventClasses)`''' returns `True` if the next event in the stream
 is an instance of one of the given `EventClasses`. Otherwise it returns `False`.
 
-The method '''`Loader.peek_event()`''' returns the next event in the stream, but does not remove
+'''`Loader.peek_event()`''' returns the next event in the stream, but does not remove
 it from the internal event queue. The function returns `None` at the end of the stream.
 
-The method '''`Loader.get_event()`''' returns the next event in the stream and removes
+'''`Loader.get_event()`''' returns the next event in the stream and removes
 it from the internal event queue. The function returns `None` at the end of the stream.
 
@@ -1051 +1051 @@
 
 ==== Constructor interface ====
+
+{{{
+#!python
+load(stream, Loader=Loader)
+load_all(stream, Loader=Loader)
+
+safe_load(stream)
+safe_load_all(stream)
+
+Loader.check_data()
+Loader.get_data()
+
+def constructor(loader, node):
+    # ...
+    return data
+
+def multi_constructor(loader, tag_suffix, node):
+    # ...
+    return data
+
+add_constructor(tag, constructor, Loader=Loader)
+add_multi_constructor(tag_prefix, multi_constructor, Loader=Loader)
+
+Loader.add_constructor(tag, constructor) # Loader.add_constructor is a class method.
+Loader.add_multi_constructor(tag_prefix, multi_constructor) # Loader.add_multi_constructor is a class method.
+
+Loader.construct_scalar(node)
+Loader.construct_sequence(node)
+Loader.construct_mapping(node)
+}}}
+
+'''`construct(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
+corresponding to the documents in the stream.
+
+'''`Loader.check_data()`''' returns `True` is there are more documents available in the stream. Otherwise
+it returns `False`.
+
+'''`Loader.get_data()`''' constructs and returns a Python object corresponding to the next document
+in the stream.
+
+'''`add_constructor(tag, constructor)`''' and '''`Loader.add_constructor(tag, constructor)`''' allow
+to specify a `constructor` for the given `tag`. A constructor is a function that converts a node
+of a YAML representation graph to a native Python object. A constructor accepts an instance of `Loader`
+and a node and returns a Python object.
+
+'''`add_multi_constructor(tag_prefix, multi_constructor)`''' and '''`Loader.add_multi_constructor(tag_prefix, multi_constructor)`'''
+allow to specify a `multi_constructor` for the given `tag_prefix`. A multi-constructor is a function that converts a node
+of a YAML representation graph to a native Python object. A multi-constructor accepts an instance of `Loader`,
+the suffix of the node tag, and a node and returns a Python object.
+
+'''`Loader.construct_scalar(node)`''' checks that the given `node` is a scalar and returns its value.
+This function is intended to be used in constructors.
+
+'''`Loader.construct_sequence(node)`''' checks that the given `node` is a sequence and returns a list
+of Python objects corresponding to the node items. This function is intended to be used in constructors.
+
+'''`Loader.construct_mapping(node)`''' checks that the given `node` is a mapping and returns a dictionary
+of Python objects corresponding to the node keys and values. This function is intended to be used in constructors.