用装饰器修改python文档字符串:这是个好主意吗？
用装饰器修改python文档字符串:这是个好主意吗？
提问于 2012-03-16 21:35:19
python docstring必须给出一个文字字符串；但是有时对于几个函数(例如，不同的构造函数)有类似的docstring很有用，或者几个访问方法可能接受相同的参数列表(然后依赖相同的隐藏方法)，所以最好到处使用相同的描述。对于这种情况，我可以通过向__doc__赋值来构造docstring，这是通过简单的修饰器完成的。这个系统运行得非常好(在python 2中)，我对它的简单、清晰和良好封装感到高兴。
问题是:这是个好主意吗？特别是，是否有一些工具会被这种设置所混淆(例如，任何从源而不是字节码中提取文档字符串的工具)。这个解决方案在python 3中仍然有效吗？是否有其他原因或情况会使这种做法不可取？
回答 1
Stack Overflow用户
回答已采纳
发布于 2012-03-16 22:10:27
它不应该破坏任何工具，它应该在Python 3上工作。
如果它不损害源代码的可读性--也就是说，您仍然可以了解该函数的功能以及如何使用它。
问题可能在于它掩盖了一个糟糕的设计。如果几个方法使用相同的参数列表，那么代码应该被重构(创建一个与列表一起工作的对象)，而不是通过生成重复的docstring进行修补。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/9744806
复制相关文章
相似问题
腾讯云开发者
