Python 闭包是 __all__ 的一个很好的替代品吗？

Question

使用闭包而不是 __all__ 来限制 Python 模块公开的名称是个好主意吗？这将防止程序员意外使用错误的模块名称 (import urllib; urllib.os.getlogin()) 以及避免“from x import *”命名空间污染为__all__。

def _init_module():
   global foo
   import bar
   def foo():
       return bar.baz.operation()
   class Quux(bar.baz.Splort): pass
_init_module(); del _init_module

对比同一个模块使用__all__:

__all__ = ['foo']
import bar
def foo():
    return bar.baz.operation()
class Quux(bar.baz.Splort): pass

函数可以采用这种风格以避免污染模块命名空间：

def foo():
    import bar
    bar.baz.operation()

这对于希望帮助用户在交互式内省期间帮助用户将其 API 与包对其和其他模块 API 的使用区分开来的大型包很有帮助。另一方面，也许 IPython 应该在制表符补全期间简单区分 __all__ 中的名称，并且更多的用户应该使用允许他们在文件之间跳转以查看每个名称的定义的 IDE。

Answer 1

我喜欢编写尽可能简单的代码。

__all__ 是 Python 的一项功能，明确添加以解决限制模块可见名称的问题。当你使用它时，人们会立即明白你在用它做什么。

你的闭包技巧很不标准，如果我遇到它，我不会立即理解它。你需要写一个长评论来解释它，然后你需要再写一个长评论来解释你为什么这样做而不是使用__all__。

编辑：现在我更好地理解了这个问题，这是一个替代答案。

在 Python 中，在模块中使用下划线作为私有名称前缀被认为是一种很好的做法。如果您使用from the_module_name import *，您将获得所有不以下划线开头的名称。因此，我希望看到正确使用初始下划线习语，而不是关闭技巧。

请注意，如果您使用开头的下划线名称，您甚至不需要使用__all__。

Answer 2

from x import * 的问题在于它可以隐藏NameErrors，这使得微不足道的错误难以追踪。 “命名空间污染”是指在命名空间中添加你不知道它来自哪里的东西。

这也是你的闭包所做的。此外，它可能会混淆 IDE、大纲、pylint 等。

使用“错误”的模块名称也不是真正的问题。模块对象在您导入它们的任何地方都是相同的。如果“错误”名称消失（更新后），应该清楚原因并激励程序员下次正确执行此操作。但它不会导致错误。

Answer 3

好的，我开始对这个问题有了更多了解。关闭确实允许隐藏私人内容。这是一个简单的例子。

没有关闭：

# module named "foo.py"
def _bar():
    return 5

def foo():
    return _bar() - 2 

随着闭包：

# module named "fooclosure.py"
def _init_module():
    global foo
    def _bar():
        return 5

    def foo():
        return _bar() - 2

_init_module(); del _init_module

使用示例：

>>> import foo
>>> dir(foo)
['__builtins__', '__doc__', '__file__', '__name__', '__package__', '_bar', 'foo']
>>>
>>> import fooclosure
>>> dir(fooclosure)
['__builtins__', '__doc__', '__file__', '__name__', '__package__', 'foo']
>>>

这实际上是令人不安的微妙。在第一种情况下，函数foo() 只是引用了名称_bar()，如果您要从名称空间中删除_bar()，foo() 将停止工作。 foo() 每次运行时都会查找 _bar()。

相比之下，foo() 的闭包版本可以在名称空间中不存在_bar() 的情况下工作。我什至不确定它是如何工作的......它是否持有对为_bar() 创建的函数对象的引用，或者它是否持有对仍然存在的命名空间的引用，这样它可以查找名称_bar()并找到它吗？