diff options
| author | Dan Rose <rotu@users.noreply.github.com> | 2019-05-24 06:38:01 -0500 |
|---|---|---|
| committer | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-05-24 04:38:01 -0700 |
| commit | 2a37f8f55b543589cc77a67b5cd17cbd9d0311c9 (patch) | |
| tree | 7bf4242f52dd92ffb0c8a731fe7d2e0f1864556e /Lib/pydoc.py | |
| parent | cf7d5ef49b1d28f35af137d23ec1a94f3eae090d (diff) | |
| download | cpython-git-2a37f8f55b543589cc77a67b5cd17cbd9d0311c9.tar.gz | |
bpo-36045: builtins.help() now prefixes `async` for async functions (GH-12010)
Previously, it was hard to tell whether a function should be awaited. It was also incorrect (per PEP 484) to put this in the type hint for coroutine functions. Added this info to the output of builtins.help and pydoc.
https://bugs.python.org/issue36045
Diffstat (limited to 'Lib/pydoc.py')
| -rw-r--r-- | Lib/pydoc.py | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/Lib/pydoc.py b/Lib/pydoc.py index 679a596821..9a22e56686 100644 --- a/Lib/pydoc.py +++ b/Lib/pydoc.py @@ -951,6 +951,12 @@ class HTMLDoc(Doc): else: note = ' unbound %s method' % self.classlink(imclass,mod) + if (inspect.iscoroutinefunction(object) or + inspect.isasyncgenfunction(object)): + asyncqualifier = 'async ' + else: + asyncqualifier = '' + if name == realname: title = '<a name="%s"><strong>%s</strong></a>' % (anchor, realname) else: @@ -979,8 +985,8 @@ class HTMLDoc(Doc): if not argspec: argspec = '(...)' - decl = title + self.escape(argspec) + (note and self.grey( - '<font face="helvetica, arial">%s</font>' % note)) + decl = asyncqualifier + title + self.escape(argspec) + (note and + self.grey('<font face="helvetica, arial">%s</font>' % note)) if skipdocs: return '<dl><dt>%s</dt></dl>\n' % decl @@ -1382,6 +1388,12 @@ location listed above. else: note = ' unbound %s method' % classname(imclass,mod) + if (inspect.iscoroutinefunction(object) or + inspect.isasyncgenfunction(object)): + asyncqualifier = 'async ' + else: + asyncqualifier = '' + if name == realname: title = self.bold(realname) else: @@ -1405,7 +1417,7 @@ location listed above. argspec = argspec[1:-1] # remove parentheses if not argspec: argspec = '(...)' - decl = title + argspec + note + decl = asyncqualifier + title + argspec + note if skipdocs: return decl + '\n' |