crawlee-python/website/generate_module_shortcuts.py

61 lines
1.8 KiB
Python

#!/usr/bin/env python3
from __future__ import annotations
import importlib
import inspect
import json
from pathlib import Path
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from types import ModuleType
def get_module_shortcuts(module: ModuleType, parent_classes: list | None = None) -> dict:
"""Traverse a module and its submodules to identify and register shortcuts for classes."""
shortcuts = {}
if parent_classes is None:
parent_classes = []
parent_module_name = '.'.join(module.__name__.split('.')[:-1])
module_classes = []
for classname, cls in inspect.getmembers(module, inspect.isclass):
module_classes.append(cls)
if cls in parent_classes:
shortcuts[f'{module.__name__}.{classname}'] = f'{parent_module_name}.{classname}'
for _, submodule in inspect.getmembers(module, inspect.ismodule):
if submodule.__name__.startswith('apify'):
shortcuts.update(get_module_shortcuts(submodule, module_classes))
return shortcuts
def resolve_shortcuts(shortcuts: dict) -> None:
"""Resolve linked shortcuts.
For example, if there are shortcuts A -> B and B -> C, resolve them to A -> C.
"""
for source, target in shortcuts.items():
while target in shortcuts:
shortcuts[source] = shortcuts[target]
target = shortcuts[target] # noqa: PLW2901
shortcuts = {}
for module_name in ['crawlee']:
try:
module = importlib.import_module(module_name)
module_shortcuts = get_module_shortcuts(module)
shortcuts.update(module_shortcuts)
except ModuleNotFoundError: # noqa: PERF203
pass
resolve_shortcuts(shortcuts)
with Path('module_shortcuts.json').open('w', encoding='utf-8') as shortcuts_file:
json.dump(shortcuts, shortcuts_file, indent=4, sort_keys=True)