Source code for aws_resource_search.code.gen_code

# -*- coding: utf-8 -*-

import typing as T
import json
import importlib

import jinja2
from pathlib import Path

from ..paths import dir_project_root, dir_python_lib, path_searchers_json
from ..base_searcher import BaseSearcher
from ..searcher_metadata import SearcherMetadata

dir_here = Path(__file__).absolute().parent
path_searchers_enum_json = dir_here.joinpath("searcher_enum.json")


def load_searchers_enum_json() -> T.List[SearcherMetadata]:
    """
    Parse the ``aws_resource_search/code/searchers_enum.json`` file.
    """
    data = json.loads(path_searchers_enum_json.read_text())
    sr_meta_list = list()
    for id, dct in data.items():
        desc, ngram = dct["desc"], dct["ngram"]
        sr_meta = SearcherMetadata(id=id, desc=desc, ngram=ngram)
        sr_meta_list.append(sr_meta)
    return sr_meta_list


def sort_searcher_metadata_list(sr_meta_list: T.List[SearcherMetadata]):
    """
    Sort searcher_metadata by id.
    """
    sr_meta_list = list(sorted(sr_meta_list, key=lambda x: x.id))
    return sr_meta_list


def dump_searchers_enum_json(sr_meta_list: T.List[SearcherMetadata]):
    """
    Dump searcher metadata list to the
    ``aws_resource_search/code/searchers_enum.json`` file.
    """
    data = {}
    for sr_meta in sr_meta_list:
        data[sr_meta.id] = {
            "desc": sr_meta.desc,
            "ngram": sr_meta.ngram,
        }
    path_searchers_enum_json.write_text(json.dumps(data, indent=4, sort_keys=True))


def generate_searchers_enum_py_module(sr_meta_list: T.List[SearcherMetadata]):
    """
    Create the ``aws_resource_search/searchers_enum.py``
    """
    path_tpl = dir_here.joinpath("searcher_enum.py.jinja")
    path_py = dir_python_lib.joinpath("searcher_enum.py")
    tpl = jinja2.Template(path_tpl.read_text())
    path_py.write_text(tpl.render(sr_meta_list=sr_meta_list))


def enrich_searcher_metadata(
    sr_meta_list: T.List[SearcherMetadata],
) -> T.List[SearcherMetadata]:
    """
    Recursively scan all modules in ``aws_resource_search.res`` package,
    try to locate all subclass of the :class:`aws_resource_search.base_searcher.BaseSearcher` to extract
    all searcher metadata.

    Also if the searcher is defined in the ``searcher_enum.json`` but not
    implemented in the ``aws_resource_search.res`` module, then it will
    be removed from the ``sr_meta_list``.
    """
    sr_meta_dct_view: T.Dict[str, SearcherMetadata] = {
        sr_meta.id: sr_meta for sr_meta in sr_meta_list
    }
    for p in dir_python_lib.joinpath("res").iterdir():
        if p.name.startswith("__"):
            continue
        module_name = p.stem
        module = importlib.import_module(f"aws_resource_search.res.{module_name}")
        for var_name, value in module.__dict__.items():
            if isinstance(value, BaseSearcher):
                sr_meta_dct_view[value.resource_type].module = module_name
                sr_meta_dct_view[value.resource_type].klass = value.__class__.__name__
                sr_meta_dct_view[value.resource_type].var = var_name

    valid_sr_meta_list = [
        sr_meta for sr_meta in sr_meta_dct_view.values() if sr_meta.klass is not None
    ]
    return valid_sr_meta_list


def dump_searchers_json(sr_meta_list: T.List[SearcherMetadata]):
    """
    Dump enriched searcher metadata list to the
    ``aws_resource_search/searchers.json`` file.
    """
    data = {}
    for sr_meta in sr_meta_list:
        data[sr_meta.id] = {
            "desc": sr_meta.desc,
            "ngram": sr_meta.ngram,
            "module": sr_meta.module,
            "klass": sr_meta.klass,
            "var": sr_meta.var,
        }
    path_searchers_json.write_text(json.dumps(data, indent=4, sort_keys=True))


def generate_implemented_resource_types(sr_meta_list: T.List[SearcherMetadata]):
    dir_folder = dir_project_root.joinpath(
        "docs",
        "source",
        "03-User-Guide-Implemented-AWS-Resource-Types",
    )
    path_tpl = dir_here.joinpath("implemented_aws_resource_types.rst.jinja")
    path_index = dir_folder.joinpath("index.rst")
    tpl = jinja2.Template(path_tpl.read_text())
    path_index.write_text(tpl.render(sr_meta_list=sr_meta_list))


def generate_ars_py_module(sr_meta_list: T.List[SearcherMetadata]):
    """
    Generate ``aws_resource_search/ars_v2.py`` module.
    """
    path_tpl = dir_here.joinpath("ars_mixin.py.jinja")
    path_py = dir_python_lib.joinpath("ars_mixin.py")
    tpl = jinja2.Template(path_tpl.read_text())
    path_py.write_text(tpl.render(sr_meta_list=sr_meta_list))