python - 如何打破第一个文档字符串中的链接以满足 pep8？

Question

我正在使用 Sphinxdoc 生成 api 文档，并且在编写文档字符串时遇到了 pep8 一致性问题。

正如您在下面看到的，指向 OWASP 站点的链接在第 105 列结束，远远超过 pep8 规定的 maximum-line-length

def handle_csrf(...):
    """The general recommendation by people in the know [OWASP]_, is
       'to implement the Synchronizer Token Pattern (STP_)'.

       .. [OWASP] The Open Web Application Security Project
          (https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet)
       .. _STP: http://www.corej2eepatterns.com/Design/PresoDesign.htm

    """

有没有办法包装 url，同时在生成的文档中仍将其保留为 url？

插入反斜杠不起作用。

Answer 1

反斜杠 \ 可以完成这项工作，但会破坏漂亮的缩进。

def handle_csrf():
    """The general recommendation by people in the know [OWASP]_, is
       'to implement the Synchronizer Token Pattern (STP_)'.

       .. [OWASP] The Open Web Application Security Project
          (https://www.owasp.org/index.php/Cross-\
Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet)
       .. _STP: http://www.corej2eepatterns.com/Design/PresoDesign.htm

    """

结果(长线也一样):

>>> print handle_csrf.__doc__
The general recommendation by people in the know [OWASP]_, is
       'to implement the Synchronizer Token Pattern (STP_)'.

       .. [OWASP] The Open Web Application Security Project
          (https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet)
       .. _STP: http://www.corej2eepatterns.com/Design/PresoDesign.htm

此外，PEP8 是一个指南，而不是法律 - 这似乎是一个(罕见的)可以忽略它的情况。