ruamel.yaml可以编码枚举吗?

时间:2017-12-29 04:14:44

标签: python enums ruamel.yaml

以下对我来说不起作用,使用Python 3.4.7,ruamel.yaml版本0.15.35:

import sys
import enum

import ruamel.yaml
from ruamel.yaml import yaml_object
yaml = ruamel.yaml.YAML()

@yaml_object(yaml)
class Speed(enum.IntEnum):
    Reverse = 0
    Neutral = 1
    Low = 2
    Drive = 3
    Park = 999

print("Neutral:", repr(Speed.Neutral))

yaml.dump(Speed.Neutral, sys.stdout)

我得到一个完全合理的repr

Neutral: <Speed.Neutral: 1>

.dump()加注:

ruamel.yaml.representer.RepresenterError: cannot represent an object: <enum 'Speed'>

如果不支持enum,我可以做些什么来扩展我正在使用的enum类(或我创建的子类enum.IntEnum),例如一个dunder方法?

2 个答案:

答案 0 :(得分:5)

enum不支持开箱即用,主要是因为默认的dump方法是安全的,因此不支持任意Python对象。该安全性也将标准库中的类型排除为enum

您应该按照ruamel.yaml documentation中的说明向to_yaml课程添加classmethod Speed

import sys
import enum

import ruamel.yaml
from ruamel.yaml import yaml_object
yaml = ruamel.yaml.YAML()

@yaml_object(yaml)
class Speed(enum.IntEnum):
    Reverse = 0
    Neutral = 1
    Low = 2
    Drive = 3
    Park = 999

    @classmethod
    def to_yaml(cls, representer, node):
        return representer.represent_scalar(
            u'!Speed',
            '{}-{}'.format(node._name_, node._value_)
        )

yaml.dump(Speed.Neutral, sys.stdout)

给出:

!Speed Neutral-1
...

您当然可以根据自己的喜好调整字符串表示(并添加from_yaml以便能够将输出加载回来)。

请注意,您无法在文档示例中添加yaml_tag,因为这会干扰enum值。

答案 1 :(得分:1)

我认为你需要按值传递枚举。

https://docs.python.org/3/library/enum.html#programmatic-access-to-enumeration-members-and-their-attributes

yaml.dump(Speed.Neutral.value, sys.stdout)

添加@classmethod的扩展答案,在传递

时调用.value

http://yaml.readthedocs.io/en/latest/dumpcls.html

import sys
import enum
import ruamel.yaml
from ruamel.yaml import yaml_object
yaml = ruamel.yaml.YAML()

@yaml_object(yaml)
class Speed(enum.IntEnum):
    Reverse = 0
    Neutral = 1
    Low = 2
    Drive = 3
    Park = 999

    @classmethod
    def to_yaml(cls, representer, node):
        return representer.represent_scalar(u'!enum:', u'{.value}'.format(node))