python弃用工厂确保针对不同弃用提供有用的警告和文档字符串。
deprecation-factor的Python项目详细描述
折旧工厂
Python3折旧厂。自动编写多种样板代码 通过python装饰器的依赖关系。
动机
打破东西很重要！打破别人的东西就是卑鄙！
抨击的目的是警告其他库编写者他们的代码是 就要崩溃了，所以你可以继续对你自己进行激烈的改变。
通常，当您想要否决某个特性时，您最终会遵循一个过程 类似于
- 对代码进行有用的修改。
- 决定何时改变旧的行为。
- 在函数中添加警告以警告用户。
- 将函数签名更改为非感官的，以检测 违约行为。
- 在文档中添加消息（与numpydoc兼容）
最后，当行为被官方否决时，你需要做所有这些 又变了。
- 删除警告。
- 删除文档消息。
- 改掉旧习惯。
- 将函数签名改回有用的内容。
此库的目标是允许您简化步骤3-9。你不应该 在完成新的 特征。您编写的代码应该是，这个库， makes确保您的用户有足够的时间更新他们的代码。
这个库
- 修改函数签名以确保当前 版本。这将有助于自动完成。
- 将警告节添加到docstrings。试图正确地 缩进docstring。
- 将用户指向他们的代码行，以便他们知道 做出适当的修改。
- 在达到所需阈值后保留deprecator会导致noop。 这意味着您可以懒得将它们从代码中删除。 抨击不应该成为你发展的障碍。
- 如果安装了numpydoc>；0.7，则“警告”部分将合并为 一个单独的部分，允许您链接deprecator。
安装
虽然您可以依赖于此，但我强烈建议您将 在你的项目中的需要，因为api很可能会改变和破坏你的代码。
当前折旧率
- 反对更改
kwargs中的默认值。句柄kwargs也作为位置参数传递！ - 转换为仅关键字参数。
未来折旧率
kwarg重命名- 交换位置参数的顺序
- 使一个旧的
kwarg成为下颌骨的位置arg - 欢迎功能要求！
开发主管
- 马克·哈福奇
贡献者
可能是你！
如何贡献
准备好了吗？我们使用标准的github贡献模型。 Scikit图像有一个很好的 writeup关于如何设置 你的环境。适应我们的环境。
炊具
此包是用 Cookiecutter和 audreyr/cookiecutter-pypackage 项目模板。
历史记录
0.2.2（2018.08.13）
- 检查numpydoc 0.7
- 修复docstring消息中的错误
0.2.2（2018.08.12）
- API变更。change_default_参数现在为 使参数名不发生冲突的旧参数
0.2.1（2018.08.12）
- 与其他numpydocs合并，以便sphinx中的文档不会崩溃
0.2.0（2018.08.11）
- 提供用于更改仅关键字参数数的deprecator。
0.1.1（2018.08.09）
- 对于Python3.5，也会按顺序显示不推荐使用的参数。
0.1.0（2018.08.09）
- 用于更改
kwards默认值的新deprecator。处理参数 也作为位置argumnets传递。
0.0.1（2018-07-29）
- pypi上的第一个版本
欢迎加入QQ群-->： 979659372
