自定义 distutils 命令

Question

我有一个名为“example”的库，我正在将其安装到我的全局站点包目录中。但是，我希望能够安装两个版本，一个用于生产，一个用于测试（我有一个 Web 应用程序和其他以这种方式进行版本控制的东西）。

有没有一种方法可以指定“python setup.py stage”，它不仅可以将不同的egg安装到站点包中，而且还可以将模块从“example”重命名为“example_stage”或类似的名称？

如果 distutils 不能做到这一点，还有其他工具可以吗？

Answer 1

通过在 setup.py 内部子类化 distutils.core.Command ，可以使用 distutils 轻松完成此操作。

例如：

from distutils.core import setup, Command
import os, sys

class CleanCommand(Command):
    description = "custom clean command that forcefully removes dist/build directories"
    user_options = []
    def initialize_options(self):
        self.cwd = None
    def finalize_options(self):
        self.cwd = os.getcwd()
    def run(self):
        assert os.getcwd() == self.cwd, 'Must be in package root: %s' % self.cwd
        os.system('rm -rf ./build ./dist')  

要启用该命令，您必须在 setup() 中引用它：

setup(
     # stuff omitted for conciseness.
     cmdclass={
        'clean': CleanCommand
}

请注意，您也可以通过这种方式覆盖内置命令，例如我对“clean”所做的操作。 （我不喜欢内置版本如何留下“dist”和“build”目录。）

% python setup.py --help-commands | grep clean
  clean            custom clean command that forcefully removes dist/build dirs.

使用了许多约定：

• 您可以使用 user_options。
• 您可以通过 initialize_options() 方法声明要使用的任何变量，该方法在初始化后调用，以便为子类设置自定义命名空间。
• finalize_options() 方法在 run() 之前调用。
• 命令本身的核心内容将发生在 run() 中，因此请务必在此之前完成任何其他准备工作。

最好的使用示例就是查看在 PYTHON_DIR/distutils/command 中找到的默认命令之一的源代码，例如 install.py 或 build .py。

Answer 2

当然，您可以使用新命令扩展 distutils。在您的 distutil 配置文件中，添加：

 [global]
 command-packages=foo.bar

这可以位于 distutils 包本身的 distutils.cfg 中，也可以位于您家中的 ..pydistutils.cfg 中目录（Windows 上没有前导点），或当前目录中的 setup.cfg。

然后，您的 Python 站点包目录中需要有一个 foo.bar 包。

然后在该包中添加实现新所需命令的类，例如 stage，子类化 distutils.cmd - 文档很弱，但有很多示例，因为所有现有的 distutils 命令也是以这种方式构建的。

Answer 3

如果您想使用多个版本，则将 virtualenv 与 virtualenvwrapper 可以提供帮助。

Answer 4

如果您想要一种使用 distutils 执行此操作的方法，请参阅 Alex 的答案，但我发现 < a href="http://www.blueskyonmars.com/projects/paver/" rel="nofollow noreferrer">Paver 更适合这种事情。它使创建自定义命令或覆盖现有命令变得更加容易。另外，如果您习惯使用 distutils 或 setuptools，那么转换并不是非常困难。