diff options
author | robot-piglet <robot-piglet@yandex-team.com> | 2024-08-28 17:49:28 +0300 |
---|---|---|
committer | robot-piglet <robot-piglet@yandex-team.com> | 2024-08-28 17:58:46 +0300 |
commit | 05f1a7bca5400633bcb52b58affe23880df1fd0e (patch) | |
tree | 87744c3c5cb786fddbe15004779b941988a0b7d7 /contrib/python/zope.interface/py3/zope/interface/document.py | |
parent | dc1a94ab8d6985d2dcf888fa1881e7b80f7042b1 (diff) | |
download | ydb-05f1a7bca5400633bcb52b58affe23880df1fd0e.tar.gz |
Intermediate changes
Diffstat (limited to 'contrib/python/zope.interface/py3/zope/interface/document.py')
-rw-r--r-- | contrib/python/zope.interface/py3/zope/interface/document.py | 42 |
1 files changed, 25 insertions, 17 deletions
diff --git a/contrib/python/zope.interface/py3/zope/interface/document.py b/contrib/python/zope.interface/py3/zope/interface/document.py index 2595c569d2..3725037720 100644 --- a/contrib/python/zope.interface/py3/zope/interface/document.py +++ b/contrib/python/zope.interface/py3/zope/interface/document.py @@ -24,7 +24,8 @@ __all__ = [ 'asStructuredText', ] -def asStructuredText(I, munge=0, rst=False): + +def asStructuredText(iface, munge=0, rst=False): """ Output structured text format. Note, this will whack any existing 'structured' format of the text. @@ -33,19 +34,21 @@ def asStructuredText(I, munge=0, rst=False): """ if rst: - inline_literal = lambda s: "``{}``".format(s) + def inline_literal(s): + return f"``{s}``" else: - inline_literal = lambda s: s + def inline_literal(s): + return s - r = [inline_literal(I.getName())] + r = [inline_literal(iface.getName())] outp = r.append level = 1 - if I.getDoc(): - outp(_justify_and_indent(_trim_doc_string(I.getDoc()), level)) + if iface.getDoc(): + outp(_justify_and_indent(_trim_doc_string(iface.getDoc()), level)) bases = [base - for base in I.__bases__ + for base in iface.__bases__ if base is not zope.interface.Interface ] if bases: @@ -56,14 +59,16 @@ def asStructuredText(I, munge=0, rst=False): outp(_justify_and_indent(_trim_doc_string(item), level, munge)) level -= 1 - namesAndDescriptions = sorted(I.namesAndDescriptions()) + namesAndDescriptions = sorted(iface.namesAndDescriptions()) outp(_justify_and_indent("Attributes:", level, munge)) level += 1 for name, desc in namesAndDescriptions: if not hasattr(desc, 'getSignatureString'): # ugh... - item = "{} -- {}".format(inline_literal(desc.getName()), - desc.getDoc() or 'no documentation') + item = "{} -- {}".format( + inline_literal(desc.getName()), + desc.getDoc() or 'no documentation' + ) outp(_justify_and_indent(_trim_doc_string(item), level, munge)) level -= 1 @@ -71,18 +76,21 @@ def asStructuredText(I, munge=0, rst=False): level += 1 for name, desc in namesAndDescriptions: if hasattr(desc, 'getSignatureString'): # ugh... - _call = "{}{}".format(desc.getName(), desc.getSignatureString()) - item = "{} -- {}".format(inline_literal(_call), - desc.getDoc() or 'no documentation') + _call = f"{desc.getName()}{desc.getSignatureString()}" + item = "{} -- {}".format( + inline_literal(_call), + desc.getDoc() or 'no documentation' + ) outp(_justify_and_indent(_trim_doc_string(item), level, munge)) return "\n\n".join(r) + "\n\n" -def asReStructuredText(I, munge=0): - """ Output reStructuredText format. Note, this will whack any existing - 'structured' format of the text.""" - return asStructuredText(I, munge=munge, rst=True) +def asReStructuredText(iface, munge=0): + """ Output reStructuredText format. + + Note, this will whack any existing 'structured' format of the text.""" + return asStructuredText(iface, munge=munge, rst=True) def _trim_doc_string(text): |