stsci.distutils 0.3.7

钩子脚本

目前本包的主要功能是几个设置钩子脚本。在distutils2中，设置钩子是一种在运行任何pysetup命令开始时执行的脚本，可以修改从setup.cfg读取的包配置。还有命令前和命令后钩子，仅在运行特定设置命令（例如build_ext、install）之前/之后执行。

pre-hook.numpy-extension-hook = stsci.distutils.hooks.numpy_extension_hook

命令

build_optional_ext

这作为默认built_ext命令的可选替代品，用于编译C扩展模块。它的目的是允许扩展模块是可选的，以便如果它们的构建失败，其余的包仍可以构建和安装。当扩展模块不是绝对必需使用包时，可以使用此功能。

要使用此自定义命令，请将以下内容添加到

commands = stsci.distutils.command.build_optional_ext.build_optional_ext

在您的包的setup.cfg的[global]部分下。然后，为了将单个扩展模块标记为可选，在该扩展的setup.cfg部分下添加

optional = True

可选地，您还可以通过添加以下内容来添加自定义失败消息

fail_message = The foobar extension module failed to compile.
               This could be because you lack such and such headers.
               This package will still work, but such and such features
               will be disabled.

0.3.7 (2013-12-23)

• 在版本.py SVN版本自动更新脚本中避免直接使用Popen.stdout以避免Python >= 3.2时可能出现的ResourceWarnings。请参阅https://github.com/spacetelescope/PyFITS/issues/45

0.3.6 (2013-11-21)

• 修复了在0.3.5中引入的Python 3语法错误。这可能发生在设置很早的时候，以至于在2to3运行包的其余部分之前就放弃了。

0.3.5 (2013-11-18)

• 修复了在Python 2系统上尝试使用已安装但从未使用过的lib2to3安装easy_install时可能出现的神秘问题。

0.3.4 (2013-07-31)

• 将v0.3.3中添加的__loader__检查更新为仅在Python >= 3.3上执行，因为该问题不适用于较旧的Python版本。

0.3.3 (2013-07-25)

• 更新了由version_setup_hook生成的version.py模块中的导入时SVN版本更新机制，以避免在不是包的开发版本中运行。这节省了在用户系统上安装已发布包时导入的时间。

• 为Python 3.3上的一个可能导致stsci.distutils在安装期间崩溃的错误添加了一个解决方案。

0.3.2 (2013-03-27)

• 修复了版本钩子中的错误，该错误可能发生在svnversion命令失败时。

• 更新了由版本钩子生成的version.py模块的模板，以便from .version import *对应用程序有效。

• 在version.py中添加了一个__vdate__变量，它可能包含通过在setup.cfg的[metadata]部分中指定vdate选项指定的发布日期字符串。

• 在version.py中添加了一个stsci_distutils_version变量，其中包含生成该文件的stsci.distutils的版本——主要用于调试目的。

• 0.3.1版本中添加了新的zest.releaser钩子，以确保创建源分发为tar.gz文件而不是zip文件——这在0.3.1的变更日志中省略了。

• 0.3.2中将tar.gz zest.releaser钩子更新为仅适用于stsci包。

0.3.1 (2012-06-28)

• 修复了一个bug，该bug导致svn相关程序的console输出被假定为ASCII，导致在非英语系统上可能发生崩溃。

0.3 (2012-02-20)

• 将glob_data_files钩子改为install_data命令的预命令钩子，而不是设置钩子。这是为了支持需要数据文件具有相对目标路径的附加功能，以便相对于软件包的安装路径（即site-packages）进行安装。

• 放弃了对easier_install自定义命令的支持，并已弃用。尽管它仍然可以使用，但可能不再用于stsci_python软件包。

• 添加了对build_optional_ext命令的支持，该命令替换/扩展了默认的build_ext命令。有关更多详细信息，请参阅README。

• 添加了tag_svn_revision设置钩子，作为egg_info命令中setuptools特定tag_svn_revision选项的替代。这个新钩子比旧的tag_svn_revision选项更容易使用：如果版本字符串中包含.dev，它将自动启用，否则将禁用。

• 已用version_pre_command_hook和version_post_command_hook分别替换了svn_info_pre_hook和svn_info_post_hook。但是，还添加了一个具有相同目的的新version_setup_hook。它通常更容易使用，并且将提供更一致的结果，因为它会在每次运行setup.py时运行，而不管使用哪个命令。stsci.distutils本身使用此钩子–请参阅setup.cfg文件和stsci/distutils/__init__.py中的示例用法。

• 不是创建一个svninfo.py模块，新的version_钩子创建了一个名为version.py的文件。除了包含在svninfo.py中的SVN信息外，它还包括一个__version__变量，供软件包的__init__.py使用。这允许在源代码中包含一个硬编码的__version__变量，而不是使用pkg_resources获取版本。

• 在version.py中，以前命名为__svn_version__和__full_svn_info__的变量现在命名为__svn_revision__和__svn_full_info__。

• 修复了在安装stsci.*命名空间包中的其他包时使用stsci.distutils的bug。如果stsci.distutils尚未安装，并且通过setup_requires选项由distribute自动下载，那么stsci.distutils将无法导入。这是因为当前nspkg（nspkg）机制的工作方式，属于nspkg的所有包都必须在初始导入时位于导入路径上。

  例如，当安装stsci.tools时，如果在安装时间从源代码中导入stsci.tools，但在下载并添加到路径之前导入stsci.distutils，则stsci包已被导入并且无法事后扩展以包括stsci.distutils的路径。处理这个问题似乎最简单的方法是删除stsci从sys.modules，这将强制它重新导入，现在它的__path__扩展到包括stsci.distutil的路径。

• 添加了zest.releaser钩子，用于调整开发版本字符串模板，并将新版本上传到STScI的本地包索引。

0.2.2 (2011-11-09)

• 修复了实际setuptools安装中关于issue205 bug的检查；在此之前它只在distribute上工作。setuptools在版本0.6c10之前的版本中都有issue205 bug。

• 改进了针对issue205错误的修复，特别是在setuptools方面。在0.6c10之前，setuptools在沙箱化之前也没有备份sys.modules，这导致严重问题。事实上，问题如此严重，仅向当前沙箱添加sys.modules备份是不够的：实际上需要monkeypatch setuptools.sandbox.run_setup，以便任何后续调用也备份sys.modules。

0.2.1 (2011-09-02)

• 修复了依赖关系，以便setuptools是必需的，但具体是'distribute'。之前，如果用户已安装plain setuptools但没有安装distribute，则安装可能会失败。

0.2 (2011-08-23)

• 首次公开发布