Changes between Version 4 and Version 5 of PyYAMLDocumentation

Timestamp:

04/23/06 10:53:49 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -42 +42 @@
 by checking the '''BOM''' (byte order mark) sequence at the beginning of the
 string/file. If no '''BOM''' is present, the '''utf-8''' encoding is assumed.
+
+'''`yaml.load`''' returns a Python object.
+
 {{{
 #!python
@@ -134 +137 @@
 
 === dump() ===
+
+The '''`yaml.dump`''' function accepts a Python object and produces a YAML document.
+{{{
+#!python
+>>> print yaml.dump({'name': 'Silenthand Olleander', 'race': 'Human',
+... 'traits': ['ONE_HAND', 'ONE_EYE']})
+
+name: Silenthand Olleander
+race: Human
+traits: [ONE_HAND, ONE_EYE]
+}}}
+
+'''`yaml.dump`''' accepts the second optional argument, which must be an open file.
+In this case, '''`yaml.dump`''' will write the produced YAML document into the file.
+Otherwise, '''`yaml.dump`''' returns the produced document.
+
+{{{
+#!python
+>>> stream = file('document.yaml', 'w')
+>>> yaml.dump(data, stream)    # Write a YAML representation of data to 'document.yaml'.
+>>> print yaml.dump(data)      # Output the document to the screen.
+}}}
+
+If you need to dump several YAML documents to a single stream, use the function
+'''`yaml.dump_all`'''. '''`yaml.dump_all`''' accepts a list or a generator producing
+Python objects to be serialized into a YAML document. The second optional argument is
+an open file.
+
+{{{
+#!python
+>>> print yaml.dump([1,2,3], explicit_start=True)
+--- [1, 2, 3]
+
+>>> print yaml.dump_all([1,2,3], explicit_start=True)
+--- 1
+--- 2
+--- 3
+}}}
+
+You may even dump instances of Python classes.
+
+{{{
+#!python
+>>> class Hero:
+...     def __init__(self, name, hp, sp):
+...         self.name = name
+...         self.hp = hp
+...         self.sp = sp
+...     def __repr__(self):
+...         return "%s(name=%r, hp=%r, sp=%r)" % (
+...             self.__class__.__name__, self.name, self.hp, self.sp)
+
+>>> print yaml.dump(("Galain Ysseleg", hp=-3, sp=2))
+
+!!python/object:__main__.Hero {hp: -3, name: Galain Ysseleg, sp: 2}
+}}}
+
+'''`yaml.dump`''' supports a number of keyword arguments that specify
+formatting details for the emitter. For instance, you may set the
+preferred intendation and width or use the canonical YAML format.
+{{{
+#!python
+>>> print yaml.dump(range(50))
+
+[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,
+  23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42,
+  43, 44, 45, 46, 47, 48, 49]
+
+>>> print yaml.dump(range(50), width=50, indent=4)
+
+[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15,
+    16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27,
+    28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,
+    40, 41, 42, 43, 44, 45, 46, 47, 48, 49]
+
+>>> print yaml.dump(range(5), canonical=True)
+
+---
+!!seq [
+  !!int "0",
+  !!int "1",
+  !!int "2",
+  !!int "3",
+  !!int "4",
+]
+}}}
 
 == YAML syntax ==