codecrumbs

codecrumbs是一个Python库（pytest插件），用于跨库边界重构源代码。它允许您更改库的API，并将这些更改传播到使用您的库的每个人。

更多内容请参阅文档。

示例

简单示例：重命名一个参数

class Example:
    # old code ...
    # def method(self,v):
    #    print(v)

    @renamed_argument("v", "value")
    def method(self, value):
        print(value)


# some where else
e = Example()

e.method(v=5)

并在之后应用重构

# if you have a standalone script
codecrumbs example.py
# or if you have tests
pytest --codecrumbs-fix test_example.py

这将重命名参数

e.method(value=5)

您可以使用codecrumbs代替python执行代码，或使用pytest运行测试并自动应用重命名。

这可以用来修复您想修复的库中的小问题，但因为没有想保持向后兼容或不想让用户在自己的代码中修复1000个重命名而从未执行。

安装

您可以通过PyPI使用pip安装codecrumbs。

pip install codecrumbs

pytest支持是开箱即用的，任何依赖您的库的人都可以使用pytest --codecrumbs-fix应用您声明的更改。

特性

使用codecrumbs，您可以修复：

• 方法/属性名称
• 重命名函数的命名参数

贡献

欢迎贡献。可以使用tox运行测试，请在提交拉取请求之前确保覆盖率至少保持不变。

问题

如果在使用过程中遇到任何问题，请提交问题，并提供详细描述。

许可证

在MIT许可条款下发行，"pytest-codecrumbs"是免费且开源的软件