1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
from docutils import nodes
from docutils.parsers.rst import directives
from sphinx import addnodes
from sphinx.domains.python import PyFunction, PyMethod
from sphinx.ext.autodoc import FunctionDocumenter, MethodDocumenter, \
bool_option
try:
from asyncio import iscoroutinefunction
except ImportError:
def iscoroutinefunction(func):
"""Return True if func is a decorated coroutine function."""
return getattr(func, '_is_coroutine', False)
__version__ = '0.3.0'
def merge_dicts(*dcts):
ret = {}
for d in dcts:
for k, v in d.items():
ret[k] = v
return ret
class PyCoroutineMixin(object):
option_spec = {'coroutine': directives.flag,
'async-with': directives.flag,
'async-for': directives.flag}
def get_signature_prefix(self, sig):
ret = []
if 'staticmethod' in self.options:
ret += [nodes.Text('staticmethod'), addnodes.desc_sig_space()]
if 'classmethod' in self.options:
ret += [nodes.Text('classmethod'), addnodes.desc_sig_space()]
if 'coroutine' in self.options:
coroutine = True
else:
coroutine = ('async-with' not in self.options and
'async-for' not in self.options)
if coroutine:
ret += [nodes.Text('coroutine'), addnodes.desc_sig_space()]
if 'async-with' in self.options:
ret += [nodes.Text('async-with'), addnodes.desc_sig_space()]
if 'async-for' in self.options:
ret += [nodes.Text('async-for'), addnodes.desc_sig_space()]
return ret
class PyCoroutineFunction(PyCoroutineMixin, PyFunction):
option_spec = merge_dicts(PyCoroutineMixin.option_spec,
PyFunction.option_spec)
def run(self):
self.name = 'py:function'
return super(PyCoroutineFunction, self).run()
class PyCoroutineMethod(PyCoroutineMixin, PyMethod):
option_spec = merge_dicts(PyCoroutineMixin.option_spec,
PyMethod.option_spec,
{'staticmethod': directives.flag,
'classmethod': directives.flag})
def run(self):
self.name = 'py:method'
return super(PyCoroutineMethod, self).run()
class CoFunctionDocumenter(FunctionDocumenter):
"""
Specialized Documenter subclass for functions and coroutines.
"""
objtype = "cofunction"
directivetype = "cofunction"
priority = 2
option_spec = merge_dicts(
MethodDocumenter.option_spec,
{'async-with': bool_option,
'async-for': bool_option,
'coroutine': bool_option
})
@classmethod
def can_document_member(cls, member, membername, isattr, parent):
"""Called to see if a member can be documented by this documenter."""
if not super().can_document_member(member, membername, isattr, parent):
return False
return iscoroutinefunction(member)
def add_directive_header(self, sig):
super().add_directive_header(sig)
sourcename = self.get_sourcename()
if self.options.async_with:
self.add_line(' :async-with:', sourcename)
if self.options.async_for:
self.add_line(' :async-for:', sourcename)
if self.options.coroutine:
self.add_line(' :coroutine:', sourcename)
class CoMethodDocumenter(MethodDocumenter):
"""
Specialized Documenter subclass for methods and coroutines.
"""
objtype = "comethod"
priority = 3 # Higher than CoFunctionDocumenter
option_spec = merge_dicts(
MethodDocumenter.option_spec,
{'staticmethod': bool_option,
'classmethod': bool_option,
'async-with': bool_option,
'async-for': bool_option,
'coroutine': bool_option
})
@classmethod
def can_document_member(cls, member, membername, isattr, parent):
"""Called to see if a member can be documented by this documenter."""
if not super().can_document_member(member, membername, isattr, parent):
return False
return iscoroutinefunction(member)
def import_object(self):
ret = super().import_object()
# Was overridden by method documenter, return to default
self.directivetype = "comethod"
return ret
def add_directive_header(self, sig):
super().add_directive_header(sig)
sourcename = self.get_sourcename()
if self.options.staticmethod:
self.add_line(' :staticmethod:', sourcename)
if self.options.staticmethod:
self.add_line(' :classmethod:', sourcename)
if self.options.async_with:
self.add_line(' :async-with:', sourcename)
if self.options.async_for:
self.add_line(' :async-for:', sourcename)
if self.options.coroutine:
self.add_line(' :coroutine:', sourcename)
def setup(app):
app.add_directive_to_domain('py', 'coroutinefunction', PyCoroutineFunction)
app.add_directive_to_domain('py', 'coroutinemethod', PyCoroutineMethod)
app.add_directive_to_domain('py', 'corofunction', PyCoroutineFunction)
app.add_directive_to_domain('py', 'coromethod', PyCoroutineMethod)
app.add_directive_to_domain('py', 'cofunction', PyCoroutineFunction)
app.add_directive_to_domain('py', 'comethod', PyCoroutineMethod)
app.add_autodocumenter(CoFunctionDocumenter)
app.add_autodocumenter(CoMethodDocumenter)
return {'version': '1.0', 'parallel_read_safe': True}
|
