Changes between Version 32 and Version 33 of PyYAMLDocumentation

Timestamp:

08/20/06 14:17:33 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -10 +10 @@
 
 
-== Introduction ==
+== Installation ==
+
+Download the source package '''PyYAML-3.04.tar.gz''' and unpack it. Go to the directory '''PyYAML-3.04'''
+and run
+{{{
+$ python setup.py install
+}}}
+
+If you want to use LibYAML bindings, which are much faster than the pure Python version, you need to
+download and install [wiki:LibYAML] and [http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/ Pyrex].
+Then you may build and install the bindings by executing
+{{{
+$ python setup_with_libyaml.py install
+}}}
+
+In order to use [wiki:LibYAML] based parser and emitter, use the classes '''`CParser`''' and '''`CEmitter`'''.
+For instance,
+{{{
+#!python
+from yaml import load, dump
+try:
+    from yaml import CLoader as Loader
+    from yaml import CDumper as Dumper
+except ImportError:
+    from yaml import Loader, Dumper
+
+# ...
+
+data = load(stream, Loader=Loader)
+
+# ...
+
+output = dump(data, Dumper=Dumper)
+}}}
+Note that there are some subtle (but not really significant) differences between pure Python and [wiki:LibYAML] based parsers
+and emitters.
+
+
+== Frequently Asked Questions ==
+
+=== Dictionaries without nested collections are not dumped correctly ===
+
+''Why does
+{{{
+#!python
+import yaml
+document = """
+  a: 1
+  b:
+    c: 3
+    d: 4
+"""
+print yaml.dump(yaml.load(document))
+}}}
+give
+{{{
+a: 1
+b: {c: 3, d: 4}
+}}}
+(see #18, #24)?''
+
+It's a correct output despite the fact that the style of the nested mapping is different.
+
+By default, PyYAML chooses the style of a collection depending on whether it has nested
+collections. If a collection has nested collections, it will be assigned the block style.
+Otherwise it will have the flow style.
+
+If you want collections to be always serialized in a block style, use the
+'''`default_flow_style`''' parameter of '''`dump()`'''. For instance,
+{{{
+#!python
+>>> print yaml.dump(yaml.load(document), default_flow_style=False)
+a: 1
+b:
+  c: 3
+  d: 4
+}}}
+
+
+== Tutorial ==
 
 Start with importing the '''`yaml`''' package.