python - 使用装饰器修改 python 文档字符串 : Is it a good idea?

Question

python 文档字符串必须作为文字字符串给出；但有时为多个函数(例如，不同的构造函数)提供相似的文档字符串是很有用的，或者多个访问方法可能接受相同的参数列表(然后依赖相同的隐藏方法)，所以使用 相同描述无处不在。对于这种情况，我可以通过分配给 __doc__ 来构造一个文档字符串，这是我通过一个简单的装饰器来完成的。该系统运行良好(在 python 2 中)，我对它的简单、清晰和封装良好感到满意。

问题:这是个好主意吗？特别是，是否有工具会被此设置混淆(例如，任何从源而不是字节码中提取文档字符串的工具)。该解决方案是否仍适用于 python 3？是否有其他原因或情况不建议这样做？

Answer 1

它不应该破坏任何工具，它应该可以在 Python 3 上运行。

没关系，如果它不影响源代码的可读性，也就是说，您仍然可以找出函数的作用以及如何使用它。

问题可能在于它掩盖了糟糕的设计。如果多个方法使用相同的参数列表，则应重构代码(创建一个使用该列表的对象)而不是通过生成重复的文档字符串来修补。