Changes between Version 5 and Version 6 of PyYAMLDocumentation

Timestamp:

04/23/06 12:58:51 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -8 +8 @@
 [[PageOutline]]
 
+
 == Basic usage ==
 
@@ -16 +17 @@
 >>> import yaml
 }}}
+
 
 === load() ===
@@ -136 +138 @@
 like integers or lists.
 
+
 === dump() ===
 
@@ -224 +227 @@
 }}}
 
+
 == YAML syntax ==
 
+A good introduction to the YAML syntax is
+[http://yaml.org/spec/cvs/current.html#id857168 Chapter 2 of the YAML specification].
+
+You may also check [http://yaml4r.sourceforge.net/cookbook/ the YAML cookbook]. Note
+that it is focused on a Ruby implementation and uses the old YAML 1.0 syntax.
+
+Here we present most common YAML constructs together with the corresponding Python objects.
+
+=== Documents ===
+
+YAML stream is a collection of zero or more documents. An empty stream contains no documents.
+Documents are separated with '''`---`'''. Documents may optionally end with '''`...`'''.
+A single document may or may not be marked with '''`---`'''.
+
+Example of an implicit document:
+{{{
+- Multimedia
+- Internet
+- Education
+}}}
+
+Example of an explicit document:
+{{{
+---
+- Afterstep
+- CTWM
+- Oroborus
+...
+}}}
+
+Example of several documents in the same stream:
+{{{
+---
+- Ada
+- APL
+- ASP
+- Assembly
+- Awk
+---
+- Basic
+---
+- C
+- C#    # Note that comments are denoted with ' #' (space and #).
+- C++
+- Cold Fusion
+}}}
+
+=== Block sequences ===
+
+In the block context, sequence entries are denoted by '''`- `''' (dash and space):
+{{{
+# YAML
+- The Dagger 'Narthanc'
+- The Dagger 'Nimthanc'
+- The Dagger 'Dethanc'
+}}}
+{{{
+#!python
+# Python
+["The Dagger 'Narthanc'", "The Dagger 'Nimthanc'", "The Dagger 'Dethanc'"]
+}}}
+
+Block sequences can be nested:
+{{{
+# YAML
+-
+  - HTML
+  - LaTeX
+  - SGML
+  - VRML
+  - XML
+  - YAML
+-
+  - BSD
+  - GNU Hurd
+  - Linux
+}}}
+{{{
+#!python
+# Python
+[['HTML', 'LaTeX', 'SGML', 'VRML', 'XML', 'YAML'], ['BSD', 'GNU Hurd', 'Linux']]
+}}}
+
+It's not necessary to start a nested sequence with a new line:
+{{{
+# YAML
+- 1.1
+- - 2.1
+  - 2.2
+- - - 3.1
+    - 3.2
+    - 3.3
+}}}
+{{{
+#!python
+# Python
+[1.1, [2.1, 2.2], [[3.1, 3.2, 3.3]]]
+}}}
+
+A block sequence may be nested to a block mapping. Note that in this
+case it is not necessary to indent the sequence.
+{{{
+# YAML
+left hand:
+- Ring of Teleportation
+- Ring of Speed
+right hand:
+- Ring of Resist Fire
+- Ring of Resist Cold
+- Ring of Resist Poison
+}}}
+{{{
+#!python
+# Python
+{'right hand': ['Ring of Resist Fire', 'Ring of Resist Cold', 'Ring of Resist Poison'],
+'left hand': ['Ring of Teleportation', 'Ring of Speed']}
+}}}
+
+=== Block mappings ===
+
+In the block context, keys and values of mappings are separated by '''`: `''' (colon and space):
+{{{
+# YAML
+base armor class: 0
+base damage: [4,4]
+plus to-hit: 12
+plus to-dam: 16
+plus to-ac: 0
+}}}
+{{{
+#!python
+# Python
+{'plus to-hit': 12, 'base damage': [4, 4], 'base armor class': 0, 'plus to-ac': 0, 'plus to-dam': 16}
+}}}
+
+Complex keys are denoted with '''`? `''' (question mark and space):
+{{{
+# YAML
+? !!python/tuple [0,0]
+: The Hero
+? !!python/tuple [0,1]
+: Treasure
+? !!python/tuple [1,0]
+: Treasure
+? !!python/tuple [1,1]
+: The Dragon
+}}}
+{{{
+#!python
+# Python
+{(0, 1): 'Treasure', (1, 0): 'Treasure', (0, 0): 'The Hero', (1, 1): 'The Dragon'}
+}}}
+
+Block mapping can be nested:
+{{{
+# YAML
+hero:
+  hp: 34
+  sp: 8
+  level: 4
+orc:
+  hp: 12
+  sp: 0
+  level: 2
+}}}
+{{{
+#!python
+# Python
+{'hero': {'hp': 34, 'sp': 8, 'level': 4}, 'orc': {'hp': 12, 'sp': 0, 'level': 2}}
+}}}
+
+A block mapping may be nested in a block sequence:
+{{{
+# YAML
+- name: PyYAML
+  status: 4
+  license: MIT
+  language: Python
+- name: PySyck
+  status: 5
+  license: BSD
+  language: Python
+}}}
+{{{
+#!python
+# Python
+[{'status': 4, 'language': 'Python', 'name': 'PyYAML', 'license': 'MIT'},
+{'status': 5, 'license': 'BSD', 'name': 'PySyck', 'language': 'Python'}]
+}}}
+
+=== Flow collections ===
+
+The syntax of flow collections in YAML is very close to the syntax of list and
+dictionary constructors in Python:
+{{{
+# YAML
+{ str: [15, 17], con: [16, 16], dex: [17, 18], wis: [16, 16], int: [10, 13], chr: [5, 8] }
+}}}
+{{{
+#!python
+# Python
+{'dex': [17, 18], 'int': [10, 13], 'chr': [5, 8], 'wis': [16, 16], 'str': [15, 17], 'con': [16, 16]}
+}}}
+
+=== Scalars ===
+
+=== Aliases ===
+
+=== Tags ===
+
 == YAML tags and Python types ==
 
 == Reference ==
+
+'''Warning: API stability is not guaranteed!'''
 
 === YAMLError ===