fixtures 4.1.0

setUp 中的错误

上述示例使用了 _setUp 而不是 setUp，因为基类的 setUp 实现旨在降低在从 _setUp 中引发错误时泄漏外部资源的机会。具体来说，setUp 包含一个 try/except 块，该块捕获所有异常，捕获任何已注册的详细对象，并在传播错误之前调用 self.cleanUp。只要您在调用可能失败的代码之前注册任何清理操作，这就会导致它们被清理。捕获的详细对象将提供给引发异常的参数。

如果发生的错误是 Exception 的子类，则 setUp 将引发包含包含详细对象的 SetupError 的 MultipleExceptions。否则，为了防止在调用层不恰当地捕获通常不可捕获的错误，如 KeyboardInterrupt，原始异常将原样引发，并且除了原始异常之外没有其他诊断数据可用。

共享依赖

在复杂环境中，一个常见的用例是某些固定装置被其他装置共享。

考虑使用 TempDir 和在其之上构建的两个固定装置进行测试的情况；比如说一个小型数据库和一个网络服务器。编写其中任何一个都几乎是微不足道的。然而，正确处理 reset() 是困难的：数据库和网络服务器都合理地期望能够在临时目录被删除之前丢弃它们在临时目录中可能打开的操作系统资源。递归的 reset() 实现对一个工作，但对另一个则不行。在每次测试之间对 TempDir 实例调用 reset() 可能是可取的，但我们不想必须对较高层级的固定装置进行完整的 cleanUp（这将使 TempDir 无用并且可以轻易重置。我们有几个可用的选项。

想象一下，网络服务器在没有任何方式上依赖于数据库固定装置 - 我们只想让网络服务器和数据库固定装置共存于同一个临时目录中。

一个简单的选项是为较高层级的固定装置提供一个显式的依赖固定装置以供使用。这把复杂性从核心推到了固定装置的用户身上

>>> class WithDep(fixtures.Fixture):
...     def __init__(self, tempdir, dependency_fixture):
...         super(WithDep, self).__init__()
...         self.tempdir = tempdir
...         self.dependency_fixture = dependency_fixture
...     def setUp(self):
...         super(WithDep, self).setUp()
...         self.addCleanup(self.dependency_fixture.cleanUp)
...         self.dependency_fixture.setUp()
...         # we assume that at this point self.tempdir is usable.
>>> DB = WithDep
>>> WebServer = WithDep
>>> tempdir = fixtures.TempDir()
>>> db = DB(tempdir, tempdir)
>>> server = WebServer(tempdir, db)
>>> server.setUp()
>>> server.cleanUp()

另一个选项是编写固定装置以优雅地处理在其下方重置的依赖项。如果固定装置会阻止依赖项重置（例如，通过在临时目录中保持文件锁打开 - 在 Windows 上，这将阻止目录被删除），则这不足以解决问题。

另一种方法是，在重置固定装置之前为每个固定装置的用户发出某种类型的信号。在这个例子中，TempDir 可能会提供一个订阅者属性，数据库和网络服务器都会在其中注册。在临时目录上调用 reset 或 cleanUp 将触发所有订阅者的回调；数据库和网络服务器重置方法可能看起来像这样

>>> def reset(self):
...     if not self._cleaned:
...         self._clean()

（它们对临时目录回调的操作是执行所需的工作并设置 self._cleaned。）这种方法（可能）具有出人意料的效果，即重置网络服务器可能会重置数据库 - 如果网络服务器依赖于 tempdir.reset 作为重置网络服务器状态的方法。

另一种尚未实现的方案是提供一个依赖对象图和重置机制，它可以遍历该图，以及“重置开始”和“重置完成”之间的分离——数据库和Web服务器都会调用其 reset_starting 方法，然后重置tempdir，最后数据库和Web服务器将调用 reset_finishing。

字节流

一个简单的适配器，用于将 BytesIO（尽管它可能在未来自动溢出到磁盘以处理大量内容）公开为详细信息对象，以便在测试失败描述中自动包含。与 MonkeyPatch 结合使用非常有用。

>>> fixture = fixtures.StringStream('my-content')
>>> fixture.setUp()
>>> with fixtures.MonkeyPatch('sys.something', fixture.stream):
...     pass
>>> fixture.cleanUp()

这需要 fixtures[streams] 额外组件。

环境变量

将您的代码与环境变量隔离开来，删除它们或将它们设置为新的值

>>> fixture = fixtures.EnvironmentVariable('HOME')

模拟记录器

将您的代码与外部日志配置隔离开来，这样您的测试就可以获取日志消息的输出，但它们不会输出到例如控制台

>>> fixture = fixtures.FakeLogger()

模拟Popen

模拟运行外部命令，而不是需要它来运行测试

>>> from io import BytesIO
>>> fixture = fixtures.FakePopen(lambda _:{'stdout': BytesIO('foobar')})

日志处理程序

替换或扩展记录器的处理程序。此配置项的行为取决于 nuke_handlers 参数的值：如果为 true，则删除记录器现有的处理程序并替换为提供的处理程序；如果为 false，则通过提供的处理程序扩展记录器的处理程序集合

>>> from logging import StreamHandler
>>> fixture = fixtures.LogHandler(StreamHandler())

模拟对象修补程序

将 mock.patch.object 适配为配置项

>>> class Fred:
...     value = 1
>>> fixture = fixtures.MockPatchObject(Fred, 'value', 2)
>>> with fixture:
...     Fred().value
2
>>> Fred().value
1

模拟修补程序

将 mock.patch 适配为配置项

>>> fixture = fixtures.MockPatch('subprocess.Popen.returncode', 3)

模拟修补程序多

将 mock.patch.multiple 适配为 fixture

>>> fixture = fixtures.MockPatchMultiple('subprocess.Popen', returncode=3)

猴子修补程序

控制命名Python属性的值

>>> def fake_open(path, mode):
...     pass
>>> fixture = fixtures.MonkeyPatch('__builtin__.open', fake_open)

请注意，修补方法时存在一些复杂性 - 请参阅API文档以获取详细信息。

嵌套临时文件

更改 tempfile 模块放置临时文件和目录的默认目录。这对于包含代码产生的噪音很有用，该代码未清理其临时文件。这不会影响提供显式包含目录的临时文件创建

>>> fixture = fixtures.NestedTempfile()

包路径条目

将单个目录添加到现有Python包的路径中。这添加到 package.__path__ 列表。如果目录已在路径中，则不会发生任何操作；如果没有，则在其 setUp 时添加，并在 cleanUp 时删除

>>> fixture = fixtures.PackagePathEntry('package/name', '/foo/bar')

Python包

创建Python包目录。特别适用于测试动态加载包/模块的代码，或模拟Python程序的命令行入口点

>>> fixture = fixtures.PythonPackage('foo.bar', [('quux.py', '')])

Python路径条目

将单个目录添加到 sys.path。如果目录已在路径中，则不会发生任何操作；如果没有，则在其 setUp 时添加，并在 cleanUp 时删除

>>> fixture = fixtures.PythonPathEntry('/foo/bar')

流

一个简单的适配器，用于将文件对象公开为详细信息对象，以便在测试失败描述中自动包含。提供了 StringStream 和 BytesStream 作为此配置项的具体用户。

这需要 fixtures[streams] 额外组件。

字符串流

一个简单的适配器，将（虽然未来可能会自动将大量内容写入磁盘）暴露为一个细节对象，以便自动包含在测试失败描述中。与结合使用非常有用。

>>> fixture = fixtures.StringStream('stdout')
>>> fixture.setUp()
>>> with fixtures.MonkeyPatch('sys.stdout', fixture.stream):
...     pass
>>> fixture.cleanUp()

这需要 fixtures[streams] 额外组件。

TempDir

创建一个临时目录并在之后清理它

>>> fixture = fixtures.TempDir()

在之后，创建的目录存储在 fixtures 的 属性中。

TempHomeDir

创建一个临时目录并将其设置为环境中的 $HOME

>>> fixture = fixtures.TempHomeDir()

在之后，创建的目录存储在 fixtures 的 属性中。

现在环境中 $HOME 将设置为相同的路径，并在 tearDown 后恢复到之前值。

Timeout

如果被覆盖的代码执行时间超过指定的整秒数，则终止。

有两种可能性，由 gentle 参数控制：当 gentle 时，将引发异常并使测试（或其它被覆盖的代码）失败。当不 gentle 时，整个过程将终止，这不太整洁，但更有可能打破没有 Python 代码运行的挂起。

WarningsCapture

捕获警告以供后续分析

>>> fixture = fixtures.WarningsCapture()

捕获的警告存储在 fixtures 的 captures 属性中，在 setUp 之后。

WarningsFilter

在测试运行期间配置警告过滤器

>>> fixture = fixtures.WarningsFilter(
...     [
...         {
...             'action': 'ignore',
...             'message': 'foo',
...             'category': DeprecationWarning,
...         },
...     ]
... )

顺序很重要：列表前面的条目会覆盖列表后面的条目，如果两者都匹配特定的警告。