使用yaml.dump时如何忽略属性?

时间:2018-04-18 17:05:22

标签: python serialization deserialization pyyaml

我试图在对象上执行YAML转储时隐藏某些属性。我试过this回答,它允许你转储,但加载不起作用。

import yaml
from copy import deepcopy

class SecretYamlObject(yaml.YAMLObject):
    hidden_fields = []

    @classmethod
    def to_yaml(cls, dumper, data):
        new_data = deepcopy(data)
        for item in cls.hidden_fields:
            del new_data.__dict__[item]
        return dumper.represent_yaml_object(cls.yaml_tag, new_data, cls,
                                            flow_style=cls.yaml_flow_style)

class Trivial(SecretYamlObject):
    hidden_fields = ["_ignore"]
    yaml_tag = u'!!Trivial'
    def __init__(self):
        self.a = 1
        self.b = 2
        self._ignore = 3

运行此代码

import yaml
yaml.load('!Trivial {a: 1, b: 2}')

我收到以下错误:

  

ConstructorError:无法确定标记的构造函数   '!Trivial'在“”,第1行第1列:       !琐碎的{a:1,b:2}

我试图'破解'它,以便yaml可以使用classproperty使用类似的东西找到构造函数:

class SecretYamlObject(yaml.YAMLObject):
    # ... same as before... remove for brevity

class Trivial(SecretYamlObject):
    hidden_fields = ["_ignore"]

    @classproperty # decorator definition not shown here for brevity 
    def yaml_tag(cls):
        return ('!!')+'python/object:'+'{}.{}'.format(cls.__module__, cls.__name__)

    def __init__(self):
        self.a = 1
        self.b = 2
        self._ignore = 3

这会产生错误的yaml字符串:

import yaml
from secret_yaml2 import Trivial
print yaml.dump(Trivial())
  

!%21python / object:secret_yaml2.Trivial {a:1,b:   2}

出于某种原因,它会将第二个!转换为%21 ...这会再次导致构造函数错误。

顺便说一句,下面的工作原理,但我需要在加载yaml之前知道对象的类,我可能不会。

import yaml
from secret_yaml import Trivial
yaml.load(yaml.dump(Trivial()))

我正在尝试创建一个知道如何正确地将自己转储到yaml的类,但我仍然可以通过正常的yaml.load调用来加载它。

1 个答案:

答案 0 :(得分:1)

您可以定义__getstate__,Python本地的pickle和PyYaml都使用:

class A(object):
    def __init__(self):
        self.hidden = 42
        self.visible = 5

    def __getstate__(self):
        state = self.__dict__.copy()
        del state['hidden']
        return state

a = A()
d = yaml.dump(a)
print(d)

此打印:

!!python/object:__main__.A
visible: 5

这是忽略或隐藏诸如PyYaml或Pickle之类的序列化程序属性的最佳方法。