Question

在Python中，我经常生成一个pickle文件来保存我在编程过程中所做的工作。

是否有可能在泡菜中存储诸如文档字符串之类的内容，以解释该泡菜的产生方式及其含义。

Answer 1

因为您可以在腌制它们之前将各种项目组合到字典，元组和列表中，所以我想说，最直接的解决方案是使用带有文档字符串键的字典。

pickle_dict = {'objs': [some, stuff, inhere],
               'docstring': 'explanation of those objects'}

当然，根据您要腌制的内容，可能需要每个对象的键值对而不是对象列表。

当您打开泡菜后，您只需阅读文档字符串即可记住该泡菜的样子。

作为一种替代解决方案，我通常只需要保存一个或两个关于泡菜的整数值。在这种情况下，我选择保存在pickle文件的标题中。根据您的操作，可能会更喜欢此方法，这样您就可以读取“ docstring”而无需解开它。

Answer 2

DataFrame和列表通常没有文档字符串，因为它们是数据。 docstring规范说：

文档字符串是一个字符串文字，它作为模块，函数，类或方法定义中的第一条语句出现。这样的文档字符串成为该对象的__doc__特殊属性。

您可以创建任何这些文件，以创建与使用您的数据的流程相关联的文档字符串。例如，模块的主class。

class MyClass:
    """My docstring"""

    def __init__(self, df):
        self.df = df # Your dataframe
    ...

像这样的事情似乎最接近您在语言惯例中的要求。