如何保护我的 Python 代码库，以便访客看不到某些模块，但它仍然可以工作？

Question

我们正在用 Python 启动一个新项目，其中包含一些我们希望保密的专有算法和敏感逻辑。我们还将有一些外部人员（精选的公众成员）参与代码工作。我们不能授予外部人员访问小型私有代码的权限，但我们希望公共版本能够为他们提供足够好的工作空间。

假设我们的项目 Foo 有一个模块 bar，其中包含一个函数 get_sauce()。 get_sauce() 中实际发生的情况是秘密的，但我们希望 get_sauce() 的公共版本返回可接受的（尽管不正确）结果。

我们还运行自己的 Subversion 服务器，因此我们可以完全控制谁可以访问什么。

符号链接

我的第一个想法是符号链接 - 向所有人提供 bar_public.py 和 bar_private.py<，而不是 bar.py /code> 仅限内部开发人员。不幸的是，创建符号链接是一项乏味的手动工作——尤其是当确实有大约两打这样的私有模块时。

更重要的是，它使 Subversion authz 文件的管理变得困难，因为对于我们想要保护的每个模块，必须在服务器上添加例外。有人可能会忘记执行此操作并意外地检查机密...然后该模块位于存储库中，我们必须在没有它的情况下重建存储库，并希望外部人员在此期间没有下载它。

多个存储库

接下来的想法是拥有两个存储库：

private
└── trunk/
    ├── __init__.py
    └── foo/
        ├── __init__.py
        └── bar.py
public
└── trunk/
    ├── __init__.py
    └── foo/
        ├── __init__.py
        ├── bar.py
        ├── baz.py
        └── quux.py

这个想法是只有内部开发人员才能签出 private/ 和 public/ 。内部开发人员将设置他们的 PYTHONPATH=private/trunk:public/trunk，但其他人只会设置 PYTHONPATH=public/trunk。那么，内部人员和外部人员都可以 from foo import bar 并获得正确的模块，对吗？

让我们试试这个：

% PYTHONPATH=private/trunk:public/trunk python
Python 2.5.1
Type "help", "copyright", "credits" or "license" for more information.
>>> import foo.bar
>>> foo.bar.sauce()
'a private bar'
>>> import foo.quux
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named quux

我不是 Python 专家，但似乎 Python 已经对模块 foo 做出了决定，并进行了相关搜索：

>>> foo
<module 'foo' from '/path/to/private/trunk/foo/__init__.py'>

甚至不删除 foo帮助：

>>> import sys
>>> del foo
>>> del sys.modules['foo']
>>> import foo.quux
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named quux

您能给我提供更好的解决方案或建议吗？

Answer 1

在 __init__ 方法中code>foo 包中，您可以更改 __path__ 以使其在其他目录中查找其模块。

因此，创建一个名为 secret 的目录并将其放入在您的私人 Subversion 存储库中。在 secret 中放入您专有的 bar.py。在公共 foo 包的 __init__.py 中，输入如下内容：

__path__.insert(0,'secret')

这对于拥有私有存储库的用户来说意味着，因此 secret他们将获得专有的 bar.py 作为 foo.bar，因为 secret 是搜索路径中的第一个目录。对于其他用户，Python 将找不到 secret 并将其视为 __path__ 中的下一个目录，因此将从以下位置加载正常的 bar.py foo。

所以它看起来像这样：

   private
    └── trunk/
        └── secret/
            └── bar.py
    public
    └── trunk/
        ├── __init__.py
        └── foo/
            ├── __init__.py
            ├── bar.py
            ├── baz.py
            └── quux.py

Answer 2

使用某种插件系统，并保留您的插件，但也可以使用开放代码附带的公开可用的插件。

插件系统比比皆是。您可以轻松地自己制作非常简单的东西。如果您想要更高级的东西，我更喜欢 Zope 组件架构，但也有像 setuptools entry_points 等选项。

在您的情况下使用哪一个将是一个很好的第二个问题。

Answer 3

这是我在阅读 Flask 的文档时注意到的替代解决方案：

flaskext/__init__.py

此文件的唯一目的是将包标记为名称空间包。这是必需的，以便来自不同 PyPI 包的多个模块可以驻留在同一个 Python 包中：

__import__('pkg_resources').declare_namespace(__name__)

如果您想确切了解那里发生了什么，请查看分发或设置工具文档，其中解释了其工作原理。