如何取消 github/pypi 项目上的功能

Posted 2023-02-24

【中文标题】如何取消 github/pypi 项目上的功能

【英文标题】：How to abolish functions on github/pypi project

【发布时间】：2020-01-30 21:33:10

【问题描述】：

我有一个 GitHub/Pypi 项目 (wexpect)。这个项目中有一些方法应该是未使用的。我想通过删除这些功能来清理我的项目，但是我不确定它们是否真的未使用。我最好的想法是打印出巨大的 deprecated 消息（然后我等待反馈，如果它们正在使用，然后删除它们）

但是有没有更好的方法来取消这些功能？

有没有办法收集实际（最终用户）使用中所有功能的覆盖率/使用情况？

【问题讨论】：

弃用的标准方法是使用docs.python.org/3/library/warnings.html。如果您将其设为电话回家，您只能获取最终用户的使用信息，这可能并不受欢迎。或者，我想您可以搜索已知用户的代码库（例如github.com/raczben/wexpect/network/dependents）以使用这些方法。

【参考方案1】：

理想情况下，您会制作一个次要/补丁版本，添加警告这些功能是内部的或已弃用的，然后制作一个实际删除它们的主要版本。

但是，如果您有文档化的 API（看起来确实如此），那么更改任何不属于该文档化 API 的函数是合理的。开发人员不应依赖内部或未记录的特性或功能。