Pythonでは、YAMLマッピングをOrderedDictsとしてどのようにロードできますか？
PyYAML のローダーを取得して、マッピング（および順序付けされたマッピング）をPython 2.7+ OrderedDict typeバニラdictおよび現在使用しているペアのリスト。
それを行う最良の方法は何ですか？
注：次の答えに基づいて、CLoaderとCDumpersも実装するライブラリがあります： Phynix/yamlloader
これが最善の方法だとは非常に疑っていますが、これが私が思いついた方法であり、機能します。 要点 も利用できます。
import yaml
import yaml.constructor
try:
# included in standard lib from Python 2.7
from collections import OrderedDict
except ImportError:
# try importing the backported drop-in replacement
# it's available on PyPI
from ordereddict import OrderedDict
class OrderedDictYAMLLoader(yaml.Loader):
"""
A YAML loader that loads mappings into ordered dictionaries.
"""
def __init__(self, *args, **kwargs):
yaml.Loader.__init__(self, *args, **kwargs)
self.add_constructor(u'tag:yaml.org,2002:map', type(self).construct_yaml_map)
self.add_constructor(u'tag:yaml.org,2002:omap', type(self).construct_yaml_map)
def construct_yaml_map(self, node):
data = OrderedDict()
yield data
value = self.construct_mapping(node)
data.update(value)
def construct_mapping(self, node, deep=False):
if isinstance(node, yaml.MappingNode):
self.flatten_mapping(node)
else:
raise yaml.constructor.ConstructorError(None, None,
'expected a mapping node, but found %s' % node.id, node.start_mark)
mapping = OrderedDict()
for key_node, value_node in node.value:
key = self.construct_object(key_node, deep=deep)
try:
hash(key)
except TypeError, exc:
raise yaml.constructor.ConstructorError('while constructing a mapping',
node.start_mark, 'found unacceptable key (%s)' % exc, key_node.start_mark)
value = self.construct_object(value_node, deep=deep)
mapping[key] = value
return mapping
更新：python 3.6+では、おそらくOrderedDictはまったく必要ありません。 新しいdict実装 これはしばらくの間pypyで使用されてきました（CPython実装の詳細は今のところ考慮されていますが）。
更新：python 3.7+、dictオブジェクトの挿入順序保存の性質Python言語仕様の公式部分であると宣言されています。 What's New In Python 3.7 。
@James ' solution が好きです。ただし、デフォルトのグローバル_yaml.Loader_クラスが変更されるため、面倒な副作用が発生する可能性があります。特に、ライブラリコードを書くとき、これは悪い考えです。また、yaml.safe_load()では直接機能しません。
幸いなことに、多くの労力をかけずにソリューションを改善できます。
_import yaml
from collections import OrderedDict
def ordered_load(stream, Loader=yaml.Loader, object_pairs_hook=OrderedDict):
class OrderedLoader(Loader):
pass
def construct_mapping(loader, node):
loader.flatten_mapping(node)
return object_pairs_hook(loader.construct_pairs(node))
OrderedLoader.add_constructor(
yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG,
construct_mapping)
return yaml.load(stream, OrderedLoader)
# usage example:
ordered_load(stream, yaml.SafeLoader)
_シリアライゼーションについては、明白な一般化はわかりませんが、少なくともこれには副作用はありません。
_def ordered_dump(data, stream=None, Dumper=yaml.Dumper, **kwds):
class OrderedDumper(Dumper):
pass
def _dict_representer(dumper, data):
return dumper.represent_mapping(
yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG,
data.items())
OrderedDumper.add_representer(OrderedDict, _dict_representer)
return yaml.dump(data, stream, OrderedDumper, **kwds)
# usage:
ordered_dump(data, Dumper=yaml.SafeDumper)
_Yamlモジュールを使用すると、カスタムの 'representers'を指定してPythonオブジェクトをテキストに変換し、 'constructors'を使用してプロセスを逆にすることができます。
_mapping_tag = yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG
def dict_representer(dumper, data):
return dumper.represent_dict(data.iteritems())
def dict_constructor(loader, node):
return collections.OrderedDict(loader.construct_pairs(node))
yaml.add_representer(collections.OrderedDict, dict_representer)
yaml.add_constructor(_mapping_tag, dict_constructor)
2015（以降）オプション：
ruamel.yaml は、PyYAMLの代替品です（免責事項：私はそのパッケージの作成者です）。マッピングの順序を維持することは、2015年に最初のバージョン（0.1）で追加されたものの1つです。辞書の順序を維持するだけでなく、コメント、アンカー名、タグも保持し、YAML 1.2をサポートします仕様（2009年リリース）
仕様では順序は保証されていませんが、もちろんYAMLファイルには順序があり、適切なパーサーがそれを保持し、順序を保持するオブジェクトを透過的に生成できます。適切なパーサー、ローダー、ダンパー¹を選択するだけです。
import sys
from ruamel.yaml import YAML
yaml_str = """\
3: abc
conf:
10: def
3: gij # h is missing
more:
- what
- else
"""
yaml = YAML()
data = yaml.load(yaml_str)
data['conf'][10] = 'klm'
data['conf'][3] = 'jig'
yaml.dump(data, sys.stdout)
あなたに与えます：
3: abc
conf:
10: klm
3: jig # h is missing
more:
- what
- else
data型はCommentedMap型で、dictと同様に機能しますが、ダンプされるまで保持される追加情報があります（保存されたコメントを含む！）
Update：ライブラリは yamlloader （yamlordereddictloaderに基づいています）の代わりに廃止されました
Pythonライブラリ（ https://pypi.python.org/pypi/yamlordereddictloader/0.1.1 ）を見つけました。これは、この質問と使用するのは非常に簡単です：
import yaml
import yamlordereddictloader
datas = yaml.load(open('myfile.yml'), Loader=yamlordereddictloader.Loader)
For PyYamlのインストールでPython 2.7を更新しました。
__init__.py
$ diff __init__.py Original
64c64
< def load(stream, Loader=Loader, **kwds):
---
> def load(stream, Loader=Loader):
69c69
< loader = Loader(stream, **kwds)
---
> loader = Loader(stream)
75c75
< def load_all(stream, Loader=Loader, **kwds):
---
> def load_all(stream, Loader=Loader):
80c80
< loader = Loader(stream, **kwds)
---
> loader = Loader(stream)
constructor.py
$ diff constructor.py Original
20,21c20
< def __init__(self, object_pairs_hook=dict):
< self.object_pairs_hook = object_pairs_hook
---
> def __init__(self):
27,29d25
< def create_object_hook(self):
< return self.object_pairs_hook()
<
54,55c50,51
< self.constructed_objects = self.create_object_hook()
< self.recursive_objects = self.create_object_hook()
---
> self.constructed_objects = {}
> self.recursive_objects = {}
129c125
< mapping = self.create_object_hook()
---
> mapping = {}
400c396
< data = self.create_object_hook()
---
> data = {}
595c591
< dictitems = self.create_object_hook()
---
> dictitems = {}
602c598
< dictitems = value.get('dictitems', self.create_object_hook())
---
> dictitems = value.get('dictitems', {})
loader.py
$ diff loader.py Original
13c13
< def __init__(self, stream, **constructKwds):
---
> def __init__(self, stream):
18c18
< BaseConstructor.__init__(self, **constructKwds)
---
> BaseConstructor.__init__(self)
23c23
< def __init__(self, stream, **constructKwds):
---
> def __init__(self, stream):
28c28
< SafeConstructor.__init__(self, **constructKwds)
---
> SafeConstructor.__init__(self)
33c33
< def __init__(self, stream, **constructKwds):
---
> def __init__(self, stream):
38c38
< Constructor.__init__(self, **constructKwds)
---
> Constructor.__init__(self)
5年前に開かれた件名に PyYAMLチケット があります。この質問へのリンクを含むいくつかの関連リンクが含まれています:)私は個人的に Gist 317164 をつかみ、使用するために少し変更しました OrderedDict Python 2.7から。含まれている実装ではありません（クラスをfrom collections import OrderedDictに置き換えただけです）。
これは、マップ内の重複したトップレベルキーもチェックする簡単なソリューションです。
import yaml
import re
from collections import OrderedDict
def yaml_load_od(fname):
"load a yaml file as an OrderedDict"
# detects any duped keys (fail on this) and preserves order of top level keys
with open(fname, 'r') as f:
lines = open(fname, "r").read().splitlines()
top_keys = []
duped_keys = []
for line in lines:
m = re.search(r'^([A-Za-z0-9_]+) *:', line)
if m:
if m.group(1) in top_keys:
duped_keys.append(m.group(1))
else:
top_keys.append(m.group(1))
if duped_keys:
raise Exception('ERROR: duplicate keys: {}'.format(duped_keys))
# 2nd pass to set up the OrderedDict
with open(fname, 'r') as f:
d_tmp = yaml.load(f)
return OrderedDict([(key, d_tmp[key]) for key in top_keys])