Changes between Version 3 and Version 4 of PyYAMLDocumentation

Timestamp:

04/23/06 08:13:30 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -3 +3 @@
 ''work in progress''
 
-''Some RPG-ish descriptions are stolen from [http://www.thangorodrim.net/ the Angband rogue-like game].
+''RPG-ish descriptions are stolen from [http://www.thangorodrim.net/ the Angband rogue-like game].
+Names of the heroes are generated with [http://www.ibiblio.org/pub/Linux/games/muds/mudnames-1.5.lsm MudNames].''
 
 [[PageOutline]]
@@ -86 +87 @@
 'name': "The Set of Gauntlets 'Paurnimmen'"}
 }}}
+
+PyYAML allows you to construct a Python object of any type.
+
+{{{
+#!python
+>>> yaml.load("""
+... none: [~, null]
+... bool: [true, false, on, off]
+... int: 42
+... float: 3.14159
+... list: [LITE, RES_ACID, SUS_DEXT]
+... dict: {hp: 13, sp: 5}
+... """)
+
+{'none': [None, None], 'int': 42, 'float': 3.1415899999999999,
+'list': ['LITE', 'RES_ACID', 'SUS_DEXT'], 'dict': {'hp': 13, 'sp': 5},
+'bool': [True, False, True, False]}
+}}}
+
+Even instances of Python classes can be constructed using the '''`!!python/object`''' tag.
+{{{
+#!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)
+
+>>> yaml.load("""
+... !!python/object:__main__.Hero
+... name: Welthyr Syxgon
+... hp: 1200
+... sp: 0
+... """)
+
+Hero(name='Welthyr Syxgon', hp=1200, sp=0)
+}}}
+
+Note that the ability to construct an arbitrary Python object may be dangerous
+if you receive a YAML document from an untrusted source such as Internet.
+The function '''`yaml.safe_load`''' limits this ability to simple Python objects
+like integers or lists.
 
 === dump() ===