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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright (c) 2022, Felix Fontein (@felixfontein) <felix@fontein.de>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
'''
Updates DOCUMENTATION of modules using module_utils._api_data with the correct list of supported paths.
'''
import sys
# Ensure that we can import things from ansible_collections
sys.path.append('../../..')
from ansible_collections.community.routeros.plugins.module_utils._api_data import (
PATHS,
join_path,
)
MODULES = [
'plugins/modules/api_info.py',
'plugins/modules/api_modify.py',
]
def update_file(file, begin_line, end_line, choice_line, path_choices):
with open(file, 'r', encoding='utf-8') as f:
lines = f.read().splitlines()
begin_index = lines.index(begin_line)
end_index = lines.index(end_line, begin_index + 1)
new_lines = lines[:begin_index + 1] + [choice_line.format(choice=choice) for choice in path_choices] + lines[end_index:]
if lines != new_lines:
print(f'{file} has been updated')
with open(file, 'w', encoding='utf-8') as f:
f.write('\n'.join(new_lines) + '\n')
def main():
path_choices = sorted([join_path(path) for path, path_info in PATHS.items() if path_info.fully_understood])
for file in MODULES:
update_file(file, ' # BEGIN PATH LIST', ' # END PATH LIST', ' - {choice}', path_choices)
if __name__ == '__main__':
main()
|
