patchy 2.8.0

patch(func, patch_text)

将补丁 patch_text 应用于函数 func 的源代码。 func 可以是一个函数，也可以是一个字符串，提供导入函数的点路径。

如果补丁无效，例如上下文行不匹配，将引发 ValueError，消息将包含 patch 工具的所有输出。

请注意，patch_text 将被 textwrap.dedent()，但前导空白不会删除。因此，正确包含补丁的方式是使用带有反斜杠 - """\ - 的三引号字符串，它开始字符串并避免包含第一个换行符。最后的换行符不是必需的，如果不存在，将自动添加。

示例

import patchy


def sample():
    return 1


patchy.patch(
    sample,
    """\
    @@ -2,2 +2,2 @@
    -    return 1
    +    return 2""",
)

print(sample())  # prints 2

mc_patchface(func, patch_text)

patch 的别名，因此你可以通过调用 patchy.mc_patchface() 来进行恶搞。

unpatch(func, patch_text)

从函数 func 的源代码中取消应用补丁 patch_text。这是 patch() 的逆操作，并调用 patch --reverse。

patch() 中的相同错误和格式规则也适用。

示例

import patchy


def sample():
    return 2


patchy.unpatch(
    sample,
    """\
    @@ -2,2 +2,2 @@
    -    return 1
    +    return 2""",
)

print(sample())  # prints 1

temp_patch(func, patch_text)

具有与 patch 相同的参数。可作为上下文管理器或函数装饰器使用，在代码周围包裹调用 patch 的代码，并在之后调用 unpatch。

上下文管理器示例

def sample():
    return 1234


patch_text = """\
    @@ -1,2 +1,2 @@
     def sample():
    -    return 1234
    +    return 5678
    """

with patchy.temp_patch(sample, patch_text):
    print(sample())  # prints 5678

装饰器示例，使用相同的 sample 和 patch_text

@patchy.temp_patch(sample, patch_text)
def my_func():
    return sample() == 5678


print(my_func())  # prints True

replace(func, expected_source, new_source)

检查函数或函数的点路径 func 是否具有与 expected_source 匹配的 AST，然后使用从 new_source 编译的源代码替换其内部代码对象。如果 AST 检查失败，将引发带有当前/预期源代码的消息的 ValueError。作者认为，调用 patch() 更好，这样你的调用就能清楚地看出对 func 的更改是什么，但使用 replace() 更简单，因为你不必制作补丁，也没有对 patch 工具的子进程调用。

注意，expected_source 和 new_source 都将被 textwrap.dedent() 处理，因此最好使用带有反斜杠转义的第一行的三引号字符串来包含它们的源，如下例所示。

如果您愿意，可以将 expected_source=None 传递以避免对目标更改的防护，但这非常不推荐，因为这意味着如果原始函数发生变化，对 replace() 的调用将继续无声地成功。

示例

import patchy


def sample():
    return 1


patchy.replace(
    sample,
    """\
    def sample():
        return 1
    """,
    """\
    def sample():
        return 42
    """,
)

print(sample())  # prints 42