控制Python中的Yaml序列化顺序

Question

如何控制PyYaml在序列化Python字典时如何输出键/值对的顺序？

我在Python脚本中使用Yaml作为简单的序列化格式。我的Yaml序列化对象代表一种“文档”，所以为了最大限度地方便用户，我希望我的对象的“名称”字段首先出现在文件中。当然，由于我的对象__getstate__返回的值是一个字典，并且Python字典是无序的，所以“name”字段将被序列化为输出中的随机位置。

例如

>>> import yaml 
>>> class Document(object): 
...  def __init__(self, name): 
...   self.name = name 
...   self.otherstuff = 'blah' 
...  def __getstate__(self): 
...   return self.__dict__.copy() 
... 
>>> doc = Document('obj-20111227') 
>>> print yaml.dump(doc, indent=4) 
!!python/object:__main__.Document 
otherstuff: blah 
name: obj-20111227 

Answer 1

，他带我穿过PyYAML文档和门票挖了几个小时，但我最终发现this comment，规定了证据的概念有些代码序列化OrderedDict作为一个正常的YAML地图（但保持顺序） 。

例如适用于我的原代码，该解决方案看起来是这样的：

>>> import yaml 
>>> from collections import OrderedDict 
>>> def dump_anydict_as_map(anydict): 
...  yaml.add_representer(anydict, _represent_dictorder) 
... 
>>> def _represent_dictorder(self, data): 
...  if isinstance(data, Document): 
...   return self.represent_mapping('tag:yaml.org,2002:map', data.__getstate__().items()) 
...  else: 
...   return self.represent_mapping('tag:yaml.org,2002:map', data.items()) 
... 
>>> class Document(object): 
...  def __init__(self, name): 
...   self.name = name 
...   self.otherstuff = 'blah' 
...  def __getstate__(self): 
...   d = OrderedDict() 
...   d['name'] = self.name 
...   d['otherstuff'] = self.otherstuff 
...   return d 
... 
>>> dump_anydict_as_map(Document) 
>>> doc = Document('obj-20111227') 
>>> print yaml.dump(doc, indent=4) 
!!python/object:__main__.Document 
name: obj-20111227 
otherstuff: blah 

Answer 2

上次我查了一下，Python的字典没有订购。如果你真的想要它们，我强烈建议使用键/值对列表。

[ 
    ('key', 'value'), 
    ('key2', 'value2') 
] 

或者，用键定义一个列表并将它们按正确的顺序排列。

keys = ['key1', 'name', 'price', 'key2']; 
for key in keys: 
    print obj[key]