Changes between Version 23 and Version 24 of PyYAMLDocumentation

Timestamp:

05/07/06 10:01:32 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -1 +1 @@
 = PyYAML Documentation =
-
-''work in progress''
 
 ''RPG-ish descriptions are stolen from [http://www.thangorodrim.net/ the Angband rogue-like game].
@@ -195 +193 @@
 ...             self.__class__.__name__, self.name, self.hp, self.sp)
 
->>> print yaml.dump(("Galain Ysseleg", hp=-3, sp=2))
+>>> print yaml.dump(Hero("Galain Ysseleg", hp=-3, sp=2))
 
 !!python/object:__main__.Hero {hp: -3, name: Galain Ysseleg, sp: 2}
@@ -244 +242 @@
 to define a subclass of '''`yaml.YAMLObject`''':
 {{{
+>>> class Monster(yaml.YAMLObject):
+...     yaml_tag = u'!Monster'
+...     def __init__(self, name, hp, ac, attacks):
+...         self.name = name
+...         self.hp = hp
+...         self.ac = ac
+...         self.attacks = attacks
+...     def __repr__(self):
+...         return "%s(name=%r, hp=%r, ac=%r, attacks=%r)" % (
+...             self.__class__.__name__, self.name, self.hp, self.ac, self.attacks)
+}}}
+
+The above definition is enough to automatically load and dump `Monster` objects:
+{{{
 #!python
 >>> yaml.load("""
@@ -285 +297 @@
 }}}
 
-First we define a representer, that convert a dice object to scalar node
+First we define a representer that convert a dice object to scalar node
 with the tag `!dice` and register it.
 {{{
@@ -320 +332 @@
 ... """)
 
-{'initial hit points': 8d4
+{'initial hit points': 8d4}
 }}}
 
@@ -769 +781 @@
 '''Warning: API stability is not guaranteed!'''
 
+
 === The yaml package ===
 
@@ -943 +956 @@
 Paths elements can be string values, integers, or `None`. The `kind` of a node can
 be `str`, `list`, `dict`, or `None`.
+
 
 === YAMLError ===
@@ -1440 +1454 @@
 === YAMLObject ===
 
+{{{
+#!python
+class MyYAMLObject(YAMLObject):
+    yaml_loader = Loader
+    yaml_dumper = Dumper
+
+    yaml_tag = u'...'
+    yaml_flow_style = ...
+
+    @classmethod
+    def from_yaml(cls, loader, node):
+        # ...
+        return data
+
+    @classmethod
+    def to_yaml(cls, dumper, data):
+        # ...
+        return node
+}}}
+
+Subclassing '''`YAMLObject`''' is an easy way to define tags, constructors, and representers
+for your classes. You only need to override the `yaml_tag` attribute. If you want
+to define your custom constructor and representer, redefine the `from_yaml` and `to_yaml` method
+correspondingly.