如何将文档存储在 pickle 文件中？
How can I store documentation in a pickle file?
在 Python 中，我经常生成一个 pickle 文件来保存我在编程期间所做的工作。
是否有可能在 pickle 中存储类似 docstring 的内容，以解释该 pickle 的生成方式及其含义。
因为您可以在 pickle 之前将各种项目组合到字典、元组和列表中，所以我认为最直接的解决方案是使用具有文档字符串键的字典。
pickle_dict = {'objs': [some, stuff, inhere],
'docstring': 'explanation of those objects'}
当然，根据您要腌制的内容，您可能希望每个 object 有 key-value 对，而不是 object 的列表。
当你打开 pickle 备份时，你可以阅读文档字符串来记住这个 pickle 是怎么来的。
作为替代解决方案，我通常只需要保存一个或两个关于泡菜的整数值。在这种情况下，我选择保存在 pickle 文件的标题中。根据你在做什么，这可能是首选，这样你就可以阅读 "docstring" 而不必解开它。
DataFrame 和列表通常没有文档字符串，因为它们是数据。文档字符串规范说：
A docstring is a string literal that occurs as the first statement in a module, function, class, or method definition. Such a docstring becomes the __doc__ special attribute of that object.
您可以创建其中任何一个来创建与使用您的数据的过程相关联的文档字符串。例如模块的主要 class。
class MyClass:
"""My docstring"""
def __init__(self, df):
self.df = df # Your dataframe
...
这样的事情看起来最接近您在语言约定范围内的要求。
在 Python 中，我经常生成一个 pickle 文件来保存我在编程期间所做的工作。
是否有可能在 pickle 中存储类似 docstring 的内容，以解释该 pickle 的生成方式及其含义。
因为您可以在 pickle 之前将各种项目组合到字典、元组和列表中，所以我认为最直接的解决方案是使用具有文档字符串键的字典。
pickle_dict = {'objs': [some, stuff, inhere],
'docstring': 'explanation of those objects'}
当然，根据您要腌制的内容，您可能希望每个 object 有 key-value 对，而不是 object 的列表。
当你打开 pickle 备份时，你可以阅读文档字符串来记住这个 pickle 是怎么来的。
作为替代解决方案，我通常只需要保存一个或两个关于泡菜的整数值。在这种情况下，我选择保存在 pickle 文件的标题中。根据你在做什么，这可能是首选，这样你就可以阅读 "docstring" 而不必解开它。
DataFrame 和列表通常没有文档字符串，因为它们是数据。文档字符串规范说：
A docstring is a string literal that occurs as the first statement in a module, function, class, or method definition. Such a docstring becomes the
__doc__special attribute of that object.
您可以创建其中任何一个来创建与使用您的数据的过程相关联的文档字符串。例如模块的主要 class。
class MyClass:
"""My docstring"""
def __init__(self, df):
self.df = df # Your dataframe
...
这样的事情看起来最接近您在语言约定范围内的要求。