bpo-33649: Add a high-level section about Futures; few quick fixes (GH-9403)
Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
(cherry picked from commit 471503954a91d86cf04228c38134108c67a263b0)
Co-authored-by: Yury Selivanov <yury@magic.io>
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 92506e7..90d7cea 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -163,6 +163,13 @@
return ret
+class PyAwaitableMixin(object):
+ def handle_signature(self, sig, signode):
+ ret = super(PyAwaitableMixin, self).handle_signature(sig, signode)
+ signode.insert(0, addnodes.desc_annotation('awaitable ', 'awaitable '))
+ return ret
+
+
class PyCoroutineFunction(PyCoroutineMixin, PyModulelevel):
def run(self):
self.name = 'py:function'
@@ -175,6 +182,18 @@
return PyClassmember.run(self)
+class PyAwaitableFunction(PyAwaitableMixin, PyClassmember):
+ def run(self):
+ self.name = 'py:function'
+ return PyClassmember.run(self)
+
+
+class PyAwaitableMethod(PyAwaitableMixin, PyClassmember):
+ def run(self):
+ self.name = 'py:method'
+ return PyClassmember.run(self)
+
+
class PyAbstractMethod(PyClassmember):
def handle_signature(self, sig, signode):
@@ -394,6 +413,8 @@
app.add_directive_to_domain('py', 'decoratormethod', PyDecoratorMethod)
app.add_directive_to_domain('py', 'coroutinefunction', PyCoroutineFunction)
app.add_directive_to_domain('py', 'coroutinemethod', PyCoroutineMethod)
+ app.add_directive_to_domain('py', 'awaitablefunction', PyAwaitableFunction)
+ app.add_directive_to_domain('py', 'awaitablemethod', PyAwaitableMethod)
app.add_directive_to_domain('py', 'abstractmethod', PyAbstractMethod)
app.add_directive('miscnews', MiscNews)
return {'version': '1.0', 'parallel_read_safe': True}