175 lines
4.3 KiB
Python
175 lines
4.3 KiB
Python
import importlib
|
|
import inspect
|
|
import os
|
|
import sys
|
|
from typing import Iterable, Optional
|
|
|
|
import pkgutil
|
|
|
|
from platypush.backend import Backend
|
|
from platypush.message.event import Event
|
|
from platypush.message.response import Response
|
|
from platypush.plugins import Plugin
|
|
from platypush.utils.manifest import Manifests
|
|
from platypush.utils.mock import auto_mocks
|
|
|
|
|
|
def get_all_plugins():
|
|
return sorted([mf.component_name for mf in Manifests.by_base_class(Plugin)])
|
|
|
|
|
|
def get_all_backends():
|
|
return sorted([mf.component_name for mf in Manifests.by_base_class(Backend)])
|
|
|
|
|
|
def get_all_events():
|
|
return _get_modules(Event)
|
|
|
|
|
|
def get_all_responses():
|
|
return _get_modules(Response)
|
|
|
|
|
|
def _get_modules(base_type: type):
|
|
ret = set()
|
|
base_dir = os.path.dirname(inspect.getfile(base_type))
|
|
package = base_type.__module__
|
|
|
|
for _, mod_name, _ in pkgutil.walk_packages([base_dir], prefix=package + '.'):
|
|
try:
|
|
module = importlib.import_module(mod_name)
|
|
except Exception:
|
|
print('Could not import module', mod_name, file=sys.stderr)
|
|
continue
|
|
|
|
for _, obj_type in inspect.getmembers(module):
|
|
if (
|
|
inspect.isclass(obj_type)
|
|
and issubclass(obj_type, base_type)
|
|
# Exclude the base_type itself
|
|
and obj_type != base_type
|
|
):
|
|
ret.add(obj_type.__module__.replace(package + '.', '', 1))
|
|
|
|
return list(ret)
|
|
|
|
|
|
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',
|
|
f'{index_name}.rst',
|
|
)
|
|
docs_dir = os.path.join(
|
|
os.path.dirname(os.path.abspath(__file__)),
|
|
'docs',
|
|
'source',
|
|
'platypush',
|
|
doc_dir,
|
|
)
|
|
|
|
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 = f'\n.. automodule:: {comp}\n :members:\n'
|
|
out = '\n'.join([header, divider, body])
|
|
|
|
with open(comp_file, 'w') as f:
|
|
f.write(out)
|
|
|
|
with open(index_file, 'w') as f:
|
|
f.write(
|
|
f'''
|
|
{index_name.title()}
|
|
{''.join(['='] * len(index_name))}
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: {index_name.title()}:
|
|
|
|
'''
|
|
)
|
|
|
|
for comp in components:
|
|
f.write(f' platypush/{doc_dir}/{comp}.rst\n')
|
|
|
|
_cleanup_removed_components_docs(docs_dir, components)
|
|
|
|
|
|
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')
|
|
}
|
|
|
|
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)
|
|
|
|
|
|
def generate_plugins_doc():
|
|
_generate_components_doc(
|
|
index_name='plugins', package_name='plugins', components=get_all_plugins()
|
|
)
|
|
|
|
|
|
def generate_backends_doc():
|
|
_generate_components_doc(
|
|
index_name='backends',
|
|
package_name='backend',
|
|
components=get_all_backends(),
|
|
doc_dir='backend',
|
|
)
|
|
|
|
|
|
def generate_events_doc():
|
|
_generate_components_doc(
|
|
index_name='events',
|
|
package_name='message.event',
|
|
components=sorted(event for event in get_all_events() if event),
|
|
)
|
|
|
|
|
|
def generate_responses_doc():
|
|
_generate_components_doc(
|
|
index_name='responses',
|
|
package_name='message.response',
|
|
components=sorted(response for response in get_all_responses() if response),
|
|
)
|
|
|
|
|
|
def main():
|
|
with auto_mocks():
|
|
generate_plugins_doc()
|
|
generate_backends_doc()
|
|
generate_events_doc()
|
|
generate_responses_doc()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|
|
|
|
|
|
# vim:sw=4:ts=4:et:
|