Changes between Version 10 and Version 11 of PyYAMLDocumentation

Timestamp:

05/06/06 12:13:30 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -908 +908 @@
 === Nodes ===
 
+Nodes are entities in the YAML informational model. There are three kinds of nodes:
+''scalar'', ''sequence'', and ''mapping''. In PyYAML, nodes are produced by Composer
+and can be serialized to a YAML stream by Serializer.
+
+{{{
+#!python
+ScalarNode(tag, value, style, start_mark, end_mark)
+SequenceNode(tag, value, flow_style, start_mark, end_mark)
+MappingNode(tag, value, flow_style, start_mark, end_mark)
+}}}
+
+The '''`style`''' and '''`flow_style`''' flags have the same meaning as for events.
+The value of a scalar node must be a unicode string. The value of a sequence node is
+a list of nodes. The value of a mapping node is a dictionary which keys and values
+are nodes.
+
+Example:
+{{{
+#!python
+>>> print yaml.compose("""
+... kinds:
+... - scalar
+... - sequence
+... - mapping
+... """)
+
+MappingNode(tag=u'tag:yaml.org,2002:map', value={
+    ScalarNode(tag=u'tag:yaml.org,2002:str', value=u'kinds'): SequenceNode(tag=u'tag:yaml.org,2002:seq', value=[
+        ScalarNode(tag=u'tag:yaml.org,2002:str', value=u'scalar'),
+        ScalarNode(tag=u'tag:yaml.org,2002:str', value=u'sequence'),
+        ScalarNode(tag=u'tag:yaml.org,2002:str', value=u'mapping')])})
+
+>>> print yaml.serialize(yaml.SequenceNode(tag=u'tag:yaml.org,2002:seq', value=[
+...     yaml.ScalarNode(tag=u'tag:yaml.org,2002:str', value=u'scalar'),
+...     yaml.ScalarNode(tag=u'tag:yaml.org,2002:str', value=u'sequence'),
+...     yaml.ScalarNode(tag=u'tag:yaml.org,2002:str', value=u'mapping')]))
+
+- scalar
+- sequence
+- mapping
+}}}