forked from apache/skywalking-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplugin_doc_gen.py
More file actions
91 lines (73 loc) · 3.54 KB
/
Copy pathplugin_doc_gen.py
File metadata and controls
91 lines (73 loc) · 3.54 KB
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
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""
A tool to generate test matrix report for SkyWalking Python Plugins
"""
import pkgutil
from skywalking.plugins import __path__ as plugins_path
doc_head = """# Supported Libraries
This document is **automatically** generated from the SkyWalking Python testing matrix.
The column of versions only indicates the set of library versions tested in a best-effort manner.
If you find newer major versions that are missing from the following table, and it's not documented as a limitation,
please PR to update the test matrix in the plugin.
Versions marked as NOT SUPPORTED may be due to
an incompatible version with Python in the original library
or a limitation of SkyWalking auto-instrumentation (welcome to contribute!)
"""
table_head = """### Plugin Support Table
| Library | Python Version - Lib Version | Plugin Name |
| :--- | :--- | :--- |
"""
def generate_plugin_doc():
"""
Generates a test matrix table to the current dir
Returns: None
"""
table_entries = []
note_entries = []
for importer, modname, _ispkg in pkgutil.iter_modules(plugins_path):
plugin = importer.find_module(modname).load_module(modname)
try:
plugin_support_matrix = plugin.support_matrix # type: dict
plugin_support_links = plugin.link_vector # type: list
libs_tested = list(plugin_support_matrix.keys())
links_tested = plugin_support_links # type: list
if plugin.note:
note_entries.append(plugin.note)
except AttributeError:
raise AttributeError(f'Missing attribute in {modname}, please follow the correct plugin style.')
for lib, link in zip(libs_tested, links_tested): # NOTE: maybe a two lib support like http.server + werkzeug
lib_entry = str(lib)
lib_link = link
version_vector = plugin_support_matrix[lib_entry] # type: dict
pretty_vector = ''
for python_version in version_vector: # e.g. {'>=3.10': ['2.5', '2.6'], '>=3.6': ['2.4.1', '2.5', '2.6']}
lib_versions = version_vector[python_version]
pretty_vector += f'Python {python_version} ' \
f"- {str(lib_versions) if lib_versions else 'NOT SUPPORTED YET'}; "
table_entry = f'| [{lib_entry}]({lib_link}) | {pretty_vector} | `{modname}` |'
table_entries.append(table_entry)
with open('docs/en/setup/Plugins.md', 'w') as plugin_doc:
plugin_doc.write(doc_head)
plugin_doc.write(table_head)
for table_entry in table_entries:
plugin_doc.write(f'{table_entry}\n')
plugin_doc.write('### Notes\n')
for note_entry in note_entries:
plugin_doc.write(f'- {note_entry}\n')
if __name__ == '__main__':
generate_plugin_doc()