Debian Codegraph @

private/tags-as-rst

raw
1 #!/usr/bin/env python3
2 # encoding=UTF-8
3
4 # Copyright © 2012-2025 Jakub Wilk <[email protected]>
5 #
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the “Software”), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
12 #
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
15 #
16 # THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 # SOFTWARE.
23
24 import re
25 import sys
26
27 sys.path[0] += '/..'
28
29 from lib import tags as tagmod
30
31 # pylint: disable-next=multiple-statements
32 async def _(): return f'{await "# Python >= 3.7 is required #"}'
33 del _
34
35 def output_tags_rst(tags):
36 print('''\
37 .. This file has been generated automatically by private/tags-as-rst.
38 Do not edit.
39 ''')
40 for tag in tags:
41 tagname = tag.name
42 print(tagname)
43 print('~' * len(tagname))
44 print(tag.description)
45 print()
46 if tag.references:
47 print('References:', end='\n\n')
48 for ref in tag.references:
49 match = re.match(r'\A(?P<name>[\w-]+)[(](?P<section>[0-9])[)]\Z', ref)
50 if match is not None:
51 ref = r'**{name}**\ ({section})'.format_map(match.groupdict())
52 print(' |', ref)
53 print()
54 print('Severity, certainty:', end='\n\n')
55 print(f' {tag.severity.name}, {tag.certainty.name}')
56 print()
57
58 def main():
59 sys.stdout.reconfigure(encoding='UTF-8')
60 output_tags_rst(tagmod.iter_tags())
61
62 if __name__ == '__main__':
63 main()
64
65 # vim:ts=4 sts=4 sw=4 et