Move protocols template out of ctl dir

Author: dgarros

infrahub_sdk/ctl/cli_commands.py

@@ -20,7 +20,6 @@
 
 from .. import __version__ as sdk_version
 from ..async_typer import AsyncTyper
-from ..code_generator import CodeGenerator
 from ..ctl import config
 from ..ctl.branch import app as branch_app
 from ..ctl.check import run as run_check
@@ -42,6 +41,7 @@
 )
 from ..ctl.validate import app as validate_app
 from ..exceptions import GraphQLError, ModuleImportError
+from ..protocols_generator.generator import CodeGenerator
 from ..schema import MainSchemaTypesAll, SchemaRoot
 from ..template import Jinja2Template
 from ..template.exceptions import JinjaTemplateError

infrahub_sdk/protocols_generator/__init__.py

@@ -0,0 +1,25 @@
+TEMPLATE_FILE_NAME = "template.j2"
+
+ATTRIBUTE_KIND_MAP = {
+    "ID": "String",
+    "Text": "String",
+    "TextArea": "String",
+    "DateTime": "DateTime",
+    "Email": "String",
+    "Password": "String",
+    "HashedPassword": "HashedPassword",
+    "URL": "URL",
+    "File": "String",
+    "MacAddress": "MacAddress",
+    "Color": "String",
+    "Dropdown": "Dropdown",
+    "Number": "Integer",
+    "Bandwidth": "Integer",
+    "IPHost": "IPHost",
+    "IPNetwork": "IPNetwork",
+    "Boolean": "Boolean",
+    "Checkbox": "Boolean",
+    "List": "ListAttribute",
+    "JSON": "JSONAttribute",
+    "Any": "AnyAttribute",
+}

infrahub_sdk/protocols_generator/constants.py

@@ -1,13 +1,13 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
+from pathlib import Path
 from typing import Any
 
 import jinja2
 
-from . import protocols as sdk_protocols
-from .ctl.constants import PROTOCOLS_TEMPLATE
-from .schema import (
+from .. import protocols as sdk_protocols
+from ..schema import (
     AttributeSchemaAPI,
     GenericSchema,
     GenericSchemaAPI,
@@ -17,30 +17,12 @@
     ProfileSchemaAPI,
     RelationshipSchemaAPI,
 )
+from .constants import ATTRIBUTE_KIND_MAP, TEMPLATE_FILE_NAME
 
-ATTRIBUTE_KIND_MAP = {
-    "ID": "String",
-    "Text": "String",
-    "TextArea": "String",
-    "DateTime": "DateTime",
-    "Email": "String",
-    "Password": "String",
-    "HashedPassword": "HashedPassword",
-    "URL": "URL",
-    "File": "String",
-    "MacAddress": "MacAddress",
-    "Color": "String",
-    "Dropdown": "Dropdown",
-    "Number": "Integer",
-    "Bandwidth": "Integer",
-    "IPHost": "IPHost",
-    "IPNetwork": "IPNetwork",
-    "Boolean": "Boolean",
-    "Checkbox": "Boolean",
-    "List": "ListAttribute",
-    "JSON": "JSONAttribute",
-    "Any": "AnyAttribute",
-}
+
+def load_template() -> str:
+    path = Path(__file__).parent / TEMPLATE_FILE_NAME
+    return path.read_text()
 
 
 class CodeGenerator:
@@ -78,7 +60,7 @@ def render(self, sync: bool = True) -> str:
         jinja2_env.filters["render_attribute"] = self._jinja2_filter_render_attribute
         jinja2_env.filters["render_relationship"] = self._jinja2_filter_render_relationship
 
-        template = jinja2_env.from_string(PROTOCOLS_TEMPLATE)
+        template = jinja2_env.from_string(load_template())
         return template.render(
             generics=self.sorted_generics,
             nodes=self.sorted_nodes,

infrahub_sdk/code_generator.py renamed to infrahub_sdk/protocols_generator/generator.py

@@ -1,12 +1,12 @@
-PROTOCOLS_TEMPLATE = """#
+#
 # Generated by "infrahubctl protocols"
 #
 
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Optional
 
-from infrahub_sdk.protocols import CoreNode, {{ base_protocols | join(', ') }}
+from infrahub_sdk.protocols import CoreNode, CoreNodeSync, {{ base_protocols | join(', ') }}
 
 if TYPE_CHECKING:
     {% if sync %}
@@ -111,5 +111,3 @@ class {{ node.namespace + node.name }}({{ node.inherit_from | join(", ") or "Cor
     {% endif %}
     {% endif %}
 {% endfor %}
-
-"""