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
|
#!/usr/bin/env python3
#
# Output rst doc for defined pkgcheck keywords.
"""
Keywords
========
List of result keywords that can be produced by pkgcheck.
"""
import sys
from textwrap import dedent
from pkgcheck import base
from pkgcheck.scripts.pkgcheck import _known_keywords
def main(f=sys.stdout, **kwargs):
def out(s, **kwargs):
print(s, file=f, **kwargs)
def _rst_header(char, text, newline=True):
if newline:
out('\n', end='')
out(text)
out(char * len(text))
# add module docstring to output doc
if __doc__ is not None:
out(__doc__.strip())
scope_map = {
base.versioned_feed: base.version_scope,
base.package_feed: base.package_scope,
base.category_feed: base.category_scope,
base.repository_feed: base.repository_scope,
}
d = {}
for keyword in _known_keywords:
d.setdefault(scope_map[keyword.threshold], set()).add(keyword)
scopes = ('version', 'package', 'category', 'repository')
for scope in reversed(sorted(d)):
_rst_header('-', scopes[scope].capitalize() + ' scope')
keywords = sorted(d[scope], key=lambda x: x.__name__)
for keyword in keywords:
if keyword.__doc__ is not None:
try:
summary, explanation = keyword.__doc__.split('\n', 1)
except ValueError:
summary = keyword.__doc__
explanation = None
else:
summary = None
out('\n{}'.format(keyword.__name__))
if summary:
out('\t' + ' '.join(dedent(summary).strip().split('\n')))
if explanation:
out('\n\t' + ' '.join(dedent(explanation).strip().split('\n')))
if __name__ == '__main__':
main()
|
GitWeb
