Skip to content

api

Classes

ApiRenderInputsSchema

Bases: RenderInputsSchema

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
28
29
30
31
32
33
class ApiRenderInputsSchema(RenderInputsSchema):

    filter: Union[str, Iterable[str]] = Field(
        description="One or a list of filter tokens -- if provided -- all of which must match for the api endpoing to be in the render result.",
        default_factory=list,
    )

Attributes

filter: Union[str, Iterable[str]] = Field(description='One or a list of filter tokens -- if provided -- all of which must match for the api endpoing to be in the render result.', default_factory=list) class-attribute instance-attribute

ApiRendererConfig

Bases: KiaraRendererConfig

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
36
37
38
class ApiRendererConfig(KiaraRendererConfig):

    pass

ApiRenderer

Bases: KiaraRenderer[KiaraAPI, ApiRenderInputsSchema, RenderValueResult, ApiRendererConfig]

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
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
class ApiRenderer(
    KiaraRenderer[KiaraAPI, ApiRenderInputsSchema, RenderValueResult, ApiRendererConfig]
):
    _inputs_schema = ApiRenderInputsSchema
    _renderer_config_cls = ApiRendererConfig

    def __init__(
        self,
        kiara: "Kiara",
        renderer_config: Union[None, Mapping[str, Any], KiaraRendererConfig] = None,
    ):

        self._api_endpoints: ApiEndpoints = ApiEndpoints(api_cls=KiaraAPI)
        super().__init__(kiara=kiara, renderer_config=renderer_config)

    @property
    def api_endpoints(self) -> ApiEndpoints:
        return self._api_endpoints

    def get_renderer_alias(self) -> str:
        return f"api_to_{self.get_target_type()}"

    def retrieve_supported_render_sources(self) -> str:
        return "kiara_api"

    def retrieve_doc(self) -> Union[str, None]:

        return f"Render the kiara (of a supported type) to: '{self.get_target_type()}'."

    @abc.abstractmethod
    def get_target_type(self) -> str:
        pass

Attributes

api_endpoints: ApiEndpoints property

Functions

get_renderer_alias() -> str
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
61
62
def get_renderer_alias(self) -> str:
    return f"api_to_{self.get_target_type()}"
retrieve_supported_render_sources() -> str
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
64
65
def retrieve_supported_render_sources(self) -> str:
    return "kiara_api"
retrieve_doc() -> Union[str, None]
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
67
68
69
def retrieve_doc(self) -> Union[str, None]:

    return f"Render the kiara (of a supported type) to: '{self.get_target_type()}'."
get_target_type() -> str abstractmethod
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
71
72
73
@abc.abstractmethod
def get_target_type(self) -> str:
    pass

ApiDocRenderer

Bases: ApiRenderer

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
class ApiDocRenderer(ApiRenderer):

    _renderer_name = "api_doc_renderer"

    def get_target_type(self) -> str:
        return "html"

    def retrieve_supported_render_targets(self) -> Union[Iterable[str], str]:
        return "html"

    def _render(self, instance: KiaraAPI, render_config: ApiRenderInputsSchema) -> Any:

        # details = self.api_endpoints.get_api_endpoint("get_value")
        details = self.api_endpoints.get_api_endpoint("retrieve_aliases_info")

        # for k, v in details.arg_schema.items():
        #     print(k)
        #     print(type(v))

        terminal_print(create_table_from_base_model_cls(details.arg_model))

        return "xxx"

Functions

get_target_type() -> str
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
80
81
def get_target_type(self) -> str:
    return "html"
retrieve_supported_render_targets() -> Union[Iterable[str], str]
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
83
84
def retrieve_supported_render_targets(self) -> Union[Iterable[str], str]:
    return "html"

ApiDocTextRenderer

Bases: ApiRenderer

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
class ApiDocTextRenderer(ApiRenderer):

    _renderer_name = "api_doc_markdown_renderer"

    def get_target_type(self) -> str:
        return "markdown"

    def retrieve_supported_render_targets(self) -> Union[Iterable[str], str]:
        return "markdown"

    def _render(self, instance: KiaraAPI, render_config: ApiRenderInputsSchema) -> Any:

        template = self._kiara.render_registry.get_template(
            "kiara_api/api_doc.md.j2", "kiara"
        )

        result = ""
        for ep in self.api_endpoints.api_endpint_names:
            doc = self.api_endpoints.get_api_endpoint(ep).doc
            rendered = template.render(endpoint_name=ep, doc=doc)
            result += rendered

        # details = self.api_endpoints.get_api_endpoint("get_value")
        # dbg(details.validated_func.__dict__)

        # for k, v in details.arg_schema.items():
        #     print(k)
        #     print(type(v))

        # inputs = {
        #     "value": "tm.date_array"
        # }
        # result = details.execute(instance, **inputs)
        # print(result)

        return result

Functions

get_target_type() -> str
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
104
105
def get_target_type(self) -> str:
    return "markdown"
retrieve_supported_render_targets() -> Union[Iterable[str], str]
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/renderers/included_renderers/api.py 
107
108
def retrieve_supported_render_targets(self) -> Union[Iterable[str], str]:
    return "markdown"

Functions