x

Author: soburi

alt_core_api/tools/protoc_gen_arduinoif/common.py

@@ -7,7 +7,7 @@
 import types
 from functools import lru_cache
 from pathlib import Path
-from typing import List, NamedTuple, Tuple
+from typing import TYPE_CHECKING, List, NamedTuple, Tuple
 
 from google.protobuf.descriptor_pb2 import EnumDescriptorProto, ServiceDescriptorProto
 
@@ -17,46 +17,12 @@
     "full_service_name",
     "get_arduino_opts_pb2",
     "ServiceDescriptor",
-    "OptionsView",
     "MethodSpec",
-    "PlannedMethod",
     "ServiceModel",
 ]
 
-
-class OptionsView:
-    def __init__(self, options) -> None:
-        self._options = options
-
-    def has(self, extension) -> bool:
-        try:
-            return self._options.HasExtension(extension)
-        except (AttributeError, KeyError):
-            return False
-
-    def string(self, extension) -> str:
-        if not self.has(extension):
-            return ""
-        return str(self._options.Extensions[extension])
-
-    def string_list(self, extension) -> List[str]:
-        try:
-            values = self._options.Extensions[extension]
-        except (AttributeError, KeyError):
-            return []
-        return [text for text in (str(value).strip() for value in values) if text]
-
-    def bool(self, extension, default: bool = False) -> bool:
-        if not self.has(extension):
-            return default
-        return bool(self._options.Extensions[extension])
-
-class PlannedMethod(NamedTuple):
-    spec: MethodSpec
-    in_ifc: bool
-    in_api: bool
-    in_service: bool
-    in_service_impl: bool
+if TYPE_CHECKING:
+    from .service_model_builder import _PlannedMethod
 
 
 class ServiceModel(NamedTuple):
@@ -76,7 +42,7 @@ class ServiceModel(NamedTuple):
     api_header: str
     service_header: str
     service_impl_header: str
-    methods: List[PlannedMethod]
+    methods: List["_PlannedMethod"]
     generate_api: bool
     generate_service: bool
     generate_service_impl: bool

alt_core_api/tools/protoc_gen_arduinoif/service_model_builder.py

@@ -9,8 +9,6 @@
 
 from .common import (
     MethodSpec,
-    OptionsView,
-    PlannedMethod,
     ServiceModel,
     full_service_name,
     get_arduino_opts_pb2,
@@ -22,6 +20,42 @@
 ]
 
 
+class _OptionsView:
+    def __init__(self, options) -> None:
+        self._options = options
+
+    def has(self, extension) -> bool:
+        try:
+            return self._options.HasExtension(extension)
+        except (AttributeError, KeyError):
+            return False
+
+    def string(self, extension) -> str:
+        if not self.has(extension):
+            return ""
+        return str(self._options.Extensions[extension])
+
+    def string_list(self, extension) -> List[str]:
+        try:
+            values = self._options.Extensions[extension]
+        except (AttributeError, KeyError):
+            return []
+        return [text for text in (str(value).strip() for value in values) if text]
+
+    def bool(self, extension, default: bool = False) -> bool:
+        if not self.has(extension):
+            return default
+        return bool(self._options.Extensions[extension])
+
+
+class _PlannedMethod(NamedTuple):
+    spec: MethodSpec
+    in_ifc: bool
+    in_api: bool
+    in_service: bool
+    in_service_impl: bool
+
+
 class ServiceModelBuilder:
     class _ResolvedServiceOptions(NamedTuple):
         ifc_name: str
@@ -58,7 +92,7 @@ def build(
         return cls(service, package_name, proto_enums, context)._build()
 
     def _build(self) -> ServiceModel:
-        service_opts = OptionsView(self._service.options)
+        service_opts = _OptionsView(self._service.options)
 
         ifc_header = (
             service_opts.string(self._opts_pb2.ifc_header_name).strip()
@@ -134,7 +168,7 @@ def _build(self) -> ServiceModel:
         base_ifc_headers: List[str] = []
         for ancestor_full_name in lineage[:-1]:
             ancestor_service, _ = self._context.service_index[ancestor_full_name]
-            ancestor_opts = OptionsView(ancestor_service.options)
+            ancestor_opts = _OptionsView(ancestor_service.options)
             base_ifc_names.append(
                 ancestor_opts.string(self._opts_pb2.ifc_class_name).strip()
                 or f"{ancestor_service.name}Interface"
@@ -269,7 +303,7 @@ def _collect_service_lineage(
 
         service, package_name = entry
         inherited: List[str] = []
-        for base_ref in OptionsView(service.options).string_list(
+        for base_ref in _OptionsView(service.options).string_list(
             self._opts_pb2.base_services
         ):
             base_full_name = self._resolve_service_reference(base_ref, package_name)
@@ -309,7 +343,7 @@ def _collect_lineage_includes(self, lineage: List[str]) -> List[str]:
         for service_full_name in lineage:
             service, _ = self._context.service_index[service_full_name]
             includes.extend(
-                OptionsView(service.options).string_list(self._opts_pb2.extra_includes)
+                _OptionsView(service.options).string_list(self._opts_pb2.extra_includes)
             )
         return includes
 
@@ -338,12 +372,12 @@ def _build_planned_methods(
         lineage_method_specs,
         own_virtual_decls,
         service_impl_callable,
-    ) -> List[PlannedMethod]:
-        methods: List[PlannedMethod] = []
+    ) -> List[_PlannedMethod]:
+        methods: List[_PlannedMethod] = []
         for spec in lineage_method_specs:
             in_service = spec.emit_service
             methods.append(
-                PlannedMethod(
+                _PlannedMethod(
                     spec=spec,
                     in_ifc=spec.decl in own_virtual_decls,
                     in_api=spec.emit_api and spec.source_virtual,

alt_core_api/tools/protoc_gen_arduinoif/tests/test_renderer_templates.py

@@ -4,6 +4,7 @@
 
 import sys
 from pathlib import Path
+from typing import NamedTuple
 
 from google.protobuf.descriptor_pb2 import EnumDescriptorProto
 
@@ -12,12 +13,19 @@
 
 from protoc_gen_arduinoif.common import (  # noqa: E402
     MethodSpec,
-    PlannedMethod,
     ServiceModel,
 )
 from protoc_gen_arduinoif.service_renderer import ServiceRenderer  # noqa: E402
 
 
+class _PlannedMethod(NamedTuple):
+    spec: MethodSpec
+    in_ifc: bool
+    in_api: bool
+    in_service: bool
+    in_service_impl: bool
+
+
 def _sample_model() -> ServiceModel:
     enum_desc = EnumDescriptorProto(name="Mode")
     enum_desc.value.add(name="MODE_A", number=0)
@@ -54,9 +62,9 @@ def _sample_model() -> ServiceModel:
     )
 
     methods = [
-        PlannedMethod(foo_spec, True, True, True, True),
-        PlannedMethod(bar_spec, True, True, True, True),
-        PlannedMethod(baz_spec, True, True, True, True),
+        _PlannedMethod(foo_spec, True, True, True, True),
+        _PlannedMethod(bar_spec, True, True, True, True),
+        _PlannedMethod(baz_spec, True, True, True, True),
     ]
 
     return ServiceModel(

documentation/idl_codegen.md

@@ -40,8 +40,8 @@ Only `RequestContext` is global. Service models are built and emitted one-by-one
 Module visibility is intentionally constrained:
 
 1. `request_context.py` exposes `RequestContext`.
-2. `common.py` exposes shared utilities/types (`full_service_name`, `get_arduino_opts_pb2`, `ServiceModel`, `MethodSpec`, `PlannedMethod`).
-3. `service_model_builder.py` exposes `ServiceModelBuilder` as the model-construction entry point.
+2. `common.py` exposes shared utilities/types (`full_service_name`, `get_arduino_opts_pb2`, `ServiceModel`, `MethodSpec`).
+3. `service_model_builder.py` exposes `ServiceModelBuilder`; helper types used there are private.
 4. `service_renderer.py` exposes `ServiceRenderer` for header rendering.
 
 Typical generated header names (per service):