Python:pickling locals()，或者 locals 有一个更轻量级的表兄弟吗？

Question

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

这通常效果很好，并且可以避免大量令人 NumPy 的重复。

我正在使用 django-notifications 在某些事件发生时发送电子邮件 - 假设您收到一条私有(private)消息。 Django 通知带有一个内置的排队功能，我现在正在集成该功能。

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

我看到三个选项:1)重写 django-notifications 的排队方法以在存储模板之前渲染模板(简单但有点乏味并且破坏可升级性)2)停止使用本地技巧并开始重复自己3)尝试找到一个轻量级版本的 locals(或者一种腌制 locals 的方法)。

我在这里希望有人能引导我们朝着#3 的方向前进。

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

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'>
}

Answer 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

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

编辑: 您应该使用第二个版本。我确信使用上下文字典(结果或ctx 或其他)感觉不是很 DRY，但让我告诉你，这实际上是一件好事。 Python 的禅宗指出“显式优于隐式。”当您返回 locals() 的值时，谁知道您正在返回什么。全局命名空间中的所有内容、嵌套命名空间中的所有内容、您可能进行的每个中间计算，所有这些内容都会隐式返回给调用者。

如果您为希望返回的值创建一个容器，那么您就明确了您的意图，在两者之间划了一条清晰的界限

this_is_for_me = 'foo'

和

result['this_is_for_you'] = 'bar'

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

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