generate_missing_docs 2.0

29-generic-entities-support
Fabio Manganiello 2 months ago
parent 6e5f746dbe
commit d5de38975d
Signed by: blacklight
GPG Key ID: D90FBA7F76362774

@ -1,4 +1,5 @@
import os
from typing import Iterable, Optional
from platypush.backend import Backend
from platypush.context import get_plugin
@ -13,25 +14,11 @@ def _get_inspect_plugin():
def get_all_plugins():
manifests = {mf.component_name for mf in get_manifests(Plugin)}
return {
plugin_name: plugin_info
for plugin_name, plugin_info in _get_inspect_plugin()
.get_all_plugins()
.output.items()
if plugin_name in manifests
}
return sorted([mf.component_name for mf in get_manifests(Plugin)])
def get_all_backends():
manifests = {mf.component_name for mf in get_manifests(Backend)}
return {
backend_name: backend_info
for backend_name, backend_info in _get_inspect_plugin()
.get_all_backends()
.output.items()
if backend_name in manifests
}
return sorted([mf.component_name for mf in get_manifests(Backend)])
def get_all_events():
@ -42,190 +29,122 @@ def get_all_responses():
return _get_inspect_plugin().get_all_responses().output
# noinspection DuplicatedCode
def generate_plugins_doc():
plugins_index = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'plugins.rst'
)
plugins_dir = os.path.join(
def _generate_components_doc(
index_name: str,
package_name: str,
components: Iterable[str],
doc_dir: Optional[str] = None,
):
if not doc_dir:
doc_dir = index_name
index_file = os.path.join(
os.path.dirname(os.path.abspath(__file__)),
'docs',
'source',
'platypush',
'plugins',
f'{index_name}.rst',
)
all_plugins = sorted(plugin for plugin in get_all_plugins().keys())
for plugin in all_plugins:
plugin_file = os.path.join(plugins_dir, plugin + '.rst')
if not os.path.exists(plugin_file):
plugin = 'platypush.plugins.' + plugin
header = '``{}``'.format('.'.join(plugin.split('.')[2:]))
divider = '=' * len(header)
body = '\n.. automodule:: {}\n :members:\n'.format(plugin)
out = '\n'.join([header, divider, body])
with open(plugin_file, 'w') as f:
f.write(out)
with open(plugins_index, 'w') as f:
f.write(
'''
Plugins
=======
.. toctree::
:maxdepth: 1
:caption: Plugins:
'''
)
for plugin in all_plugins:
f.write(' platypush/plugins/' + plugin + '.rst\n')
# noinspection DuplicatedCode
def generate_backends_doc():
backends_index = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'backends.rst'
)
backends_dir = os.path.join(
docs_dir = os.path.join(
os.path.dirname(os.path.abspath(__file__)),
'docs',
'source',
'platypush',
'backend',
doc_dir,
)
all_backends = sorted(backend for backend in get_all_backends().keys())
for backend in all_backends:
backend_file = os.path.join(backends_dir, backend + '.rst')
if not os.path.exists(backend_file):
backend = 'platypush.backend.' + backend
header = '``{}``'.format('.'.join(backend.split('.')[2:]))
for comp in components:
comp_file = os.path.join(docs_dir, comp + '.rst')
if not os.path.exists(comp_file):
comp = f'platypush.{package_name}.{comp}'
header = '``' + '.'.join(comp.split('.')[2:]) + '``'
divider = '=' * len(header)
body = '\n.. automodule:: {}\n :members:\n'.format(backend)
body = f'\n.. automodule:: {comp}\n :members:\n'
out = '\n'.join([header, divider, body])
with open(backend_file, 'w') as f:
with open(comp_file, 'w') as f:
f.write(out)
with open(backends_index, 'w') as f:
with open(index_file, 'w') as f:
f.write(
'''
Backends
========
f'''
{index_name.title()}
{''.join(['='] * len(index_name))}
.. toctree::
:maxdepth: 1
:caption: Backends:
:caption: {index_name.title()}:
'''
)
for backend in all_backends:
f.write(' platypush/backend/' + backend + '.rst\n')
# noinspection DuplicatedCode
def generate_events_doc():
from platypush.message import event as event_module
events_index = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'events.rst'
)
events_dir = os.path.join(
os.path.dirname(os.path.abspath(__file__)),
'docs',
'source',
'platypush',
'events',
)
all_events = sorted(event for event in get_all_events().keys() if event)
for comp in components:
f.write(f' platypush/{doc_dir}/{comp}.rst\n')
for event in all_events:
event_file = os.path.join(events_dir, event + '.rst')
if not os.path.exists(event_file):
header = '``{}``'.format(event)
divider = '=' * len(header)
body = '\n.. automodule:: {}.{}\n :members:\n'.format(
event_module.__name__, event
)
out = '\n'.join([header, divider, body])
_cleanup_removed_components_docs(docs_dir, components)
with open(event_file, 'w') as f:
f.write(out)
with open(events_index, 'w') as f:
f.write(
'''
Events
======
def _cleanup_removed_components_docs(docs_dir: str, components: Iterable[str]):
new_components = set(components)
existing_files = {
os.path.join(root, file)
for root, _, files in os.walk(docs_dir)
for file in files
if file.endswith('.rst')
}
.. toctree::
:maxdepth: 1
:caption: Events:
files_to_remove = {
file
for file in existing_files
if os.path.basename(file).removesuffix('.rst') not in new_components
}
'''
)
for file in files_to_remove:
print(f'Removing unlinked component {file}')
os.unlink(file)
for event in all_events:
f.write(' platypush/events/' + event + '.rst\n')
def generate_plugins_doc():
_generate_components_doc(
index_name='plugins', package_name='plugins', components=get_all_plugins()
)
# noinspection DuplicatedCode
def generate_responses_doc():
from platypush.message import response as response_module
responses_index = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'responses.rst'
)
responses_dir = os.path.join(
os.path.dirname(os.path.abspath(__file__)),
'docs',
'source',
'platypush',
'responses',
)
all_responses = sorted(
response for response in get_all_responses().keys() if response
def generate_backends_doc():
_generate_components_doc(
index_name='backends',
package_name='backend',
components=get_all_backends(),
doc_dir='backend',
)
for response in all_responses:
response_file = os.path.join(responses_dir, response + '.rst')
if not os.path.exists(response_file):
header = '``{}``'.format(response)
divider = '=' * len(header)
body = '\n.. automodule:: {}.{}\n :members:\n'.format(
response_module.__name__, response
)
out = '\n'.join([header, divider, body])
with open(response_file, 'w') as f:
f.write(out)
def generate_events_doc():
_generate_components_doc(
index_name='events',
package_name='message.event',
components=sorted(event for event in get_all_events().keys() if event),
)
with open(responses_index, 'w') as f:
f.write(
'''
Responses
=========
.. toctree::
:maxdepth: 1
:caption: Responses:
def generate_responses_doc():
_generate_components_doc(
index_name='responses',
package_name='message.response',
components=sorted(
response for response in get_all_responses().keys() if response
),
)
'''
)
for response in all_responses:
f.write(' platypush/responses/' + response + '.rst\n')
def main():
generate_plugins_doc()
generate_backends_doc()
generate_events_doc()
generate_responses_doc()
generate_plugins_doc()
generate_backends_doc()
generate_events_doc()
generate_responses_doc()
if __name__ == '__main__':
main()
# vim:sw=4:ts=4:et:

Loading…
Cancel
Save