PEP 257说:
然后在PEP中显示实现该算法的函数trim
。
在人们问如何格式化文档字符串并被引用到PEP 257上时,我会发现一些问题(例如this)。我还看到一些有关工具的信息,这些工具可确保您的文档字符串遵循PEP 257(例如this)。我找不到任何实际上是“文档字符串处理工具”的Python库,该库以PEP 257中定义的方式处理文档字符串---至少,我找不到能直接实现此文档字符串处理功能的工具可用的。
标准库中是否存在PEP 257中显示的trim
函数?显然,我可以自己将该功能粘贴到文件中,但是如果我要使用其他需要此功能的计算机,则我希望从标准库中使用它,而不是总是从PEP复制和粘贴。鉴于该功能是由BDFL共同编写的PEP中的内容,我以为会有一些官方或半官方的库来执行此操作。
我想要这样做的原因是编写一个装饰器,该装饰器对类/函数的文档字符串进行一些Python内部重新格式化。我不想生成HTML或其他任何东西;我只想更改实际对象的实际文档字符串。我想采用Python对象的纯文本__doc__
属性并将其重新格式化为将用作Python对象的纯文本__doc__
属性的东西。
最佳答案
在寻找相关问题的答案时,我设法找到了这个问题的答案。 trim
算法在所有位置的 inspect.cleandoc
中实现。
关于python - PEP 257文档字符串修剪在标准库中吗?,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/16534246/