Python：腌制本地人（），还是本地人有一个轻量级的表亲？答案

【问题标题】：Python: pickling locals(), or does locals have a lighterweight cousin?Python：腌制本地人（），还是本地人有一个轻量级的表亲？
【发布时间】：2011-07-26 18:03:26
【问题描述】：

我在 Django 中工作。在 Django 中，当你渲染一个模板时，你会发送一个上下文字典来替换它。因为我很懒/干，我经常使用 locals() 作为快捷方式，而不是发送看起来像 {'my_var': my_var, 'var2': var2} 的字典。

这通常效果很好，并且可以节省大量令人麻木的重复。

当某些事件发生时，我正在使用 django-notifications 发送电子邮件 - 比如说您收到一条私人消息。 Django-notifications 带有一个我现在正在集成的内置队列功能。

但是，问题在于 django-notifications 在排队时腌制上下文字典。这就是 locals() 技巧失败的地方——来自 locals 的字典除了局部变量之外还有很多废话（例如，它有 import 和 int()）。当地人创建的字典不会腌制。

我看到三个选项：1）重写 django-notifications 的排队方法以在模板存储之前呈现模板（直截了当，但有点乏味并且破坏了可升级性）2）停止使用本地技巧并开始重复自己 3）尝试找到更轻量级的本地人（或腌制本地人的方法）。

我在这里希望有人能在#3 的方向上取得领先。

如果它可能相关，这是我尝试使用 locals() 快捷方式腌制时遇到的错误：

TypeError: can't pickle ellipsis objects

进一步，locals()的字典输出：

{
    '__builtins__': 
    {
        'bytearray': <type 'bytearray'>,
         'IndexError': <type 'exceptions.IndexError'>,
         'all': <built-in function all>,
         'help': Type help() for interactive help,
         or help(object) for help about object.,
         'vars': <built-in function vars>,
         'SyntaxError': <type 'exceptions.SyntaxError'>,
         'unicode': <type 'unicode'>,
         'UnicodeDecodeError': <type 'exceptions.UnicodeDecodeError'>,
         'isinstance': <built-in function isinstance>,
         'copyright': Copyright (c) 2001-2010 Python Software Foundation.
All Rights Reserved.

Copyright (c) 2000 BeOpen.com.
All Rights Reserved.

Copyright (c) 1995-2001 Corporation for National Research Initiatives.
All Rights Reserved.

Copyright (c) 1991-1995 Stichting Mathematisch Centrum,
         Amsterdam.
All Rights Reserved.,
         'NameError': <type 'exceptions.NameError'>,
         'BytesWarning': <type 'exceptions.BytesWarning'>,
         'dict': <type 'dict'>,
         'input': <built-in function input>,
         'oct': <built-in function oct>,
         'bin': <built-in function bin>,
         'SystemExit': <type 'exceptions.SystemExit'>,
         'StandardError': <type 'exceptions.StandardError'>,
         'format': <built-in function format>,
         'repr': <built-in function repr>,
         'sorted': <built-in function sorted>,
         'False': False,
         'RuntimeWarning': <type 'exceptions.RuntimeWarning'>,
         'list': <type 'list'>,
         'iter': <built-in function iter>,
         'reload': <built-in function reload>,
         'Warning': <type 'exceptions.Warning'>,
         '__package__': None,
         'round': <built-in function round>,
         'dir': <built-in function dir>,
         'cmp': <built-in function cmp>,
         'set': <type 'set'>,
         'bytes': <type 'str'>,
         'reduce': <built-in function reduce>,
         'intern': <built-in function intern>,
         'issubclass': <built-in function issubclass>,
         'Ellipsis': Ellipsis,
         'EOFError': <type 'exceptions.EOFError'>,
         'locals': <built-in function locals>,
         'BufferError': <type 'exceptions.BufferError'>,
         'slice': <type 'slice'>,
         'FloatingPointError': <type 'exceptions.FloatingPointError'>,
         'sum': <built-in function sum>,
         'getattr': <built-in function getattr>,
         'abs': <built-in function abs>,
         'exit': Use exit() or Ctrl-D (i.e. EOF) to exit,
         'print': <built-in function print>,
         'True': True,
         'FutureWarning': <type 'exceptions.FutureWarning'>,
         'ImportWarning': <type 'exceptions.ImportWarning'>,
         'None': None,
         'hash': <built-in function hash>,
         'ReferenceError': <type 'exceptions.ReferenceError'>,
         'len': <built-in function len>,
         'credits':     Thanks to CWI,
         CNRI,
         BeOpen.com,
         Zope Corporation and a cast of thousands
    for supporting Python development.  See www.python.org for more information.,
         'frozenset': <type 'frozenset'>,
         '__name__': '__builtin__',
         'ord': <built-in function ord>,
         'super': <type 'super'>,
         '_': None,
         'TypeError': <type 'exceptions.TypeError'>,
         'license': Type license() to see the full license text,
         'KeyboardInterrupt': <type 'exceptions.KeyboardInterrupt'>,
         'UserWarning': <type 'exceptions.UserWarning'>,
         'filter': <built-in function filter>,
         'range': <built-in function range>,
         'staticmethod': <type 'staticmethod'>,
         'SystemError': <type 'exceptions.SystemError'>,
         'BaseException': <type 'exceptions.BaseException'>,
         'pow': <built-in function pow>,
         'RuntimeError': <type 'exceptions.RuntimeError'>,
         'float': <type 'float'>,
         'MemoryError': <type 'exceptions.MemoryError'>,
         'StopIteration': <type 'exceptions.StopIteration'>,
         'globals': <built-in function globals>,
         'divmod': <built-in function divmod>,
         'enumerate': <type 'enumerate'>,
         'apply': <built-in function apply>,
         'LookupError': <type 'exceptions.LookupError'>,
         'open': <built-in function open>,
         'quit': Use quit() or Ctrl-D (i.e. EOF) to exit,
         'basestring': <type 'basestring'>,
         'UnicodeError': <type 'exceptions.UnicodeError'>,
         'zip': <built-in function zip>,
         'hex': <built-in function hex>,
         'long': <type 'long'>,
         'next': <built-in function next>,
         'ImportError': <type 'exceptions.ImportError'>,
         'chr': <built-in function chr>,
         'xrange': <type 'xrange'>,
         'type': <type 'type'>,
         '__doc__': "Built-in functions,
         exceptions,
         and other objects.\n\nNoteworthy: None is the `nil' object; Ellipsis represents `...' in slices.",
         'Exception': <type 'exceptions.Exception'>,
         'tuple': <type 'tuple'>,
         'UnicodeTranslateError': <type 'exceptions.UnicodeTranslateError'>,
         'reversed': <type 'reversed'>,
         'UnicodeEncodeError': <type 'exceptions.UnicodeEncodeError'>,
         'IOError': <type 'exceptions.IOError'>,
         'hasattr': <built-in function hasattr>,
         'delattr': <built-in function delattr>,
         'setattr': <built-in function setattr>,
         'raw_input': <built-in function raw_input>,
         'SyntaxWarning': <type 'exceptions.SyntaxWarning'>,
         'compile': <built-in function compile>,
         'ArithmeticError': <type 'exceptions.ArithmeticError'>,
         'str': <type 'str'>,
         'property': <type 'property'>,
         'GeneratorExit': <type 'exceptions.GeneratorExit'>,
         'int': <type 'int'>,
         '__import__': <built-in function __import__>,
         'KeyError': <type 'exceptions.KeyError'>,
         'coerce': <built-in function coerce>,
         'PendingDeprecationWarning': <type 'exceptions.PendingDeprecationWarning'>,
         'file': <type 'file'>,
         'EnvironmentError': <type 'exceptions.EnvironmentError'>,
         'unichr': <built-in function unichr>,
         'id': <built-in function id>,
         'OSError': <type 'exceptions.OSError'>,
         'DeprecationWarning': <type 'exceptions.DeprecationWarning'>,
         'min': <built-in function min>,
         'UnicodeWarning': <type 'exceptions.UnicodeWarning'>,
         'execfile': <built-in function execfile>,
         'any': <built-in function any>,
         'complex': <type 'complex'>,
         'bool': <type 'bool'>,
         'ValueError': <type 'exceptions.ValueError'>,
         'NotImplemented': NotImplemented,
         'map': <built-in function map>,
         'buffer': <type 'buffer'>,
         'max': <built-in function max>,
         'object': <type 'object'>,
         'TabError': <type 'exceptions.TabError'>,
         'callable': <built-in function callable>,
         'ZeroDivisionError': <type 'exceptions.ZeroDivisionError'>,
         'eval': <built-in function eval>,
         '__debug__': True,
         'IndentationError': <type 'exceptions.IndentationError'>,
         'AssertionError': <type 'exceptions.AssertionError'>,
         'classmethod': <type 'classmethod'>,
         'UnboundLocalError': <type 'exceptions.UnboundLocalError'>,
         'NotImplementedError': <type 'exceptions.NotImplementedError'>,
         'AttributeError': <type 'exceptions.AttributeError'>,
         'OverflowError': <type 'exceptions.OverflowError'>
    },
     'notification': <module 'notification.models' from '/home/b/webapps/myapp/notification/models.pyc'>,
     'u': <User: abcd>,
     'User': <class 'django.contrib.auth.models.User'>
}

【问题讨论】：

我认为你的问题开始于有点太聪明了。仅仅因为您可以做某事（例如，使用locals() 作为上下文的字典）并不意味着这是一个好主意。直接构建 dict 并在其中明确说明您想要的值，不会花费大量时间，并且完全避免了其他“创建”问题。研究Zen of Python 并注意第 2 项。
当你有 15 个对象时，locals() 的时间节省是可观的。上帝的这种重复更糟的是加权储蓄。
是的，但是看看你在 SO 上浪费了多少时间。在我做过的所有 Django 站点中，我很少有一个特定于视图的上下文具有超过 6 个值。另一方面，我确实有一个通用的context processor，它为我们的模板提供各种普遍有用的信息。
这可能是通知，因为它在渲染之前有中间步骤，是 locals() 有用性的一个例外。 render_to_response 也不适用于通知。但是，不使用通知并不意味着任一快捷方式都是浪费时间

标签： python django django-templates

【解决方案1】：

请允许我提出使用 locals() 的替代方案

class Object(object):
    pass

def foo():
    result = Object()
    result.my_var = 'bar'
    your_var = 'not to be returned'
    result.var2 = 'baz' + result.my_var + len(your_var)
    return result.__dict__

另一种选择是在创建对象时将对象添加到上下文中。

def foo():
    result = {}
    result['my_var'] = my_var = 'bar'
    your_var = 'not to be returned'
    result['var2'] = var2 = 'baz' + my_var + len(your_var)
    return result

尽管如此，请确保每次修改变量时（或至少最后一次）都发生多重赋值。

编辑： 你应该使用第二个版本。我确定使用上下文字典（result 或 ctx 或其他）的额外击键感觉不是很干，但让我告诉你，这实际上是一件好事。 Python 的禅宗声明“显式优于隐式。” 当您返回 locals() 的值时，您返回的结果谁知道呢。全局命名空间中的所有内容，嵌套命名空间中的所有内容，您可能进行的每个中间计算，所有这些都隐式返回给调用者。

如果你为你希望返回的值创建一个容器，你就是在明确你的意图，在它们之间画一条清晰的界线

this_is_for_me = 'foo'

和

result['this_is_for_you'] = 'bar'

代码中的区别很明显，什么是公开的，供他人使用；和私有的，可能会发生变化，具体实施。调用者也很清楚，因为这些私有值根本不可用。

如果您正在集成一个从不使用locals() 魔法的外部库，您应该非常犹豫在哪里以及如何使用它。我可能更愿意修补执行此操作的代码，而不是任何其他可用选项。

【讨论】：

或者更简单，直接写入上下文字典（即，无论您使用本地a，请改用ctx['a']）。
我原本打算使用一个普通的字典，但我认为发帖人可能会反对必须输入三个额外的字符，result['my_var'] 而不是result.my_var。是的，我真的更喜欢只使用普通的字典。
这是一个很好的解决方案，但在 django 的上下文中 object.variable 不是社区标准，它并没有真正起作用。这意味着如果我引入一个社区应用程序，我必须通过并重做它们的所有功能以将局部变量存储在一个本地对象中——这对我来说是一个非首发。
为什么要更改外部应用程序？应用程序没有返回正确的数据吗？

【解决方案2】：

我在locals() 的代码 sn-p 中没有看到任何与dill 'un-pickleable' 的内容。 Dill 可以在 python 中序列化几乎任何东西，并且还有some good tools 可以帮助您了解在代码失败时导致酸洗失败的原因。只要django 使用pickle 而不是cPickle，你所要做的就是扩展pickle 来序列化EllipsisType 之类的东西：

>>> import dill
>>> # this will enable python's pickle to pickle almost everything dill can pickle
>>> 
>>> # on the full set of dill's types, this usually works unless there's a generator
>>> # or an interator-type or something odd like a traceback object in locals
>>> dill.loads(dill.dumps(locals()))
>>> ...
>>> # if you get a pickling error, use dill's tools to figure out a workaround
>>> dill.detect.badobjects(your_bad_object, depth=0)
>>> dill.detect.badobjects(your_bad_object, depth=1)
>>> ...

如果你绝对想要，你可以使用 dill 的 badobjects（或其他检测函数之一）递归地深入到 locals() 引用链中的所有内容，并弹出不可腌制的对象，而不是在在每个深度，如上所述。

【讨论】：

【解决方案3】：

您可能可以将所有内容存储在本地而不是全局。

【讨论】：

【解决方案4】：

没有。如果你要泡菜，值得重复一遍。许多对象，其中一些不直观，无法腌制（即表单输入）。

只有当您确定模板会立即呈现时，才应使用 locals() 快捷方式。

【讨论】：