acex-devkit 2.0.0__tar.gz → 2.1.1__tar.gz

{acex_devkit-2.0.0 → acex_devkit-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acex-devkit
-Version: 2.0.0
+Version: 2.1.1
 Summary: ACE-X DevKit - Development kit for building ACE-X drivers and plugins
 License: AGPL-3.0
 Keywords: automation,devkit,sdk,drivers,plugins
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: deepdiff (>=8.6.1,<9.0.0)
 Requires-Dist: ipaddress (>=1.0.23,<2.0.0)
 Requires-Dist: pydantic (>=2.12.5,<3.0.0)
+Requires-Dist: sqlmodel (>=0.0.27,<0.0.28)
 Requires-Dist: typing-extensions (>=4.0.0,<5.0.0)
 Project-URL: Homepage, https://github.com/acex-labs/acex
 Project-URL: Repository, https://github.com/acex-labs/acex
@@ -37,41 +38,45 @@ pip install acex-devkit
 from acex_devkit.drivers import NetworkElementDriver, TransportBase, RendererBase, ParserBase
 from acex_devkit.models import ComposedConfiguration
 
+
 class MyRenderer(RendererBase):
     def render(self, model: dict) -> str:
         # Implement your rendering logic
         pass
 
+
 class MyTransport(TransportBase):
     def connect(self) -> None:
         # Implement connection logic
         pass
-    
+
     def send(self, payload: Any) -> None:
         # Implement send logic
         pass
-    
+
     def verify(self) -> bool:
         # Implement verification logic
         return True
-    
+
     def rollback(self) -> None:
         # Implement rollback logic
         pass
 
+
 class MyParser(ParserBase):
     def parse(self, configuration: str) -> ComposedConfiguration:
         # Implement parsing logic
         pass
 
+
 class MyDriver(NetworkElementDriver):
     renderer_class = MyRenderer
     transport_class = MyTransport
     parser_class = MyParser
-    
+
     def render(self, configuration: ComposedConfiguration, asset):
         return self.renderer.render(configuration, asset)
-    
+
     def parse(self, configuration: str) -> ComposedConfiguration:
         return self.parser.parse(configuration)
 ```

{acex_devkit-2.0.0 → acex_devkit-2.1.1}/README.md

@@ -16,41 +16,45 @@ pip install acex-devkit
 from acex_devkit.drivers import NetworkElementDriver, TransportBase, RendererBase, ParserBase
 from acex_devkit.models import ComposedConfiguration
 
+
 class MyRenderer(RendererBase):
     def render(self, model: dict) -> str:
         # Implement your rendering logic
         pass
 
+
 class MyTransport(TransportBase):
     def connect(self) -> None:
         # Implement connection logic
         pass
-    
+
     def send(self, payload: Any) -> None:
         # Implement send logic
         pass
-    
+
     def verify(self) -> bool:
         # Implement verification logic
         return True
-    
+
     def rollback(self) -> None:
         # Implement rollback logic
         pass
 
+
 class MyParser(ParserBase):
     def parse(self, configuration: str) -> ComposedConfiguration:
         # Implement parsing logic
         pass
 
+
 class MyDriver(NetworkElementDriver):
     renderer_class = MyRenderer
     transport_class = MyTransport
     parser_class = MyParser
-    
+
     def render(self, configuration: ComposedConfiguration, asset):
         return self.renderer.render(configuration, asset)
-    
+
     def parse(self, configuration: str) -> ComposedConfiguration:
         return self.parser.parse(configuration)
 ```

{acex_devkit-2.0.0 → acex_devkit-2.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acex-devkit"
-version = "2.0.0"
+version = "2.1.1"
 description = "ACE-X DevKit - Development kit for building ACE-X drivers and plugins"
 authors = ["Johan Lahti <johan.lahti@acebit.se>"]
 readme = "README.md"
@@ -18,6 +18,7 @@ pydantic = "^2.12.5"
 typing-extensions = "^4.0.0"
 deepdiff = "^8.6.1"
 ipaddress = "^1.0.23"
+sqlmodel = "^0.0.27"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0.0"

acex_devkit-2.1.1/src/acex_devkit/configdiffer/__init__.py

@@ -0,0 +1,4 @@
+from .configdiffer import ConfigDiffer
+from .diff import AttributeChange, ComponentChange, ComponentDiffOp, Diff
+
+__all__ = ["ConfigDiffer", "AttributeChange", "ComponentChange", "ComponentDiffOp", "Diff"]

{acex_devkit-2.0.0 → acex_devkit-2.1.1}/src/acex_devkit/configdiffer/command.py

@@ -1,15 +1,15 @@
 from pydantic import BaseModel, Field
-from typing import Optional, Tuple
 
 
 class Context(BaseModel):
-    path: Tuple[str, ...] = Field(default_factory=tuple)
+    path: tuple[str, ...] = Field(default_factory=tuple)
     # priority: int = 100 även här??
 
     model_config = {
         "frozen": True,  # immutable
     }
 
+
 class Command(BaseModel):
     context: Context
     command: str
@@ -18,4 +18,3 @@ class Command(BaseModel):
     model_config = {
         "frozen": True,
     }
-

{acex_devkit-2.0.0 → acex_devkit-2.1.1}/src/acex_devkit/configdiffer/configdiffer.py

@@ -1,15 +1,15 @@
 from collections import defaultdict
+from typing import get_args
+
 from pydantic import BaseModel
-from typing import Any, Dict, List, get_args
 
-from acex_devkit.models.composed_configuration import ComposedConfiguration
+from acex_devkit.configdiffer.diff import AttributeChange, ComponentChange, ComponentDiffOp, Diff
 from acex_devkit.models.attribute_value import AttributeValue
+from acex_devkit.models.composed_configuration import ComposedConfiguration
 from acex_devkit.models.container_entry import ContainerEntry
-from acex_devkit.configdiffer.diff import Diff, ComponentChange, AttributeChange, ComponentDiffOp
 
 
 class ConfigDiffer:
-
     def _is_leaf(self, model: BaseModel) -> bool:
         """A model is a leaf if it has at least one direct AttributeValue field."""
         for field_info in model.model_fields.values():
@@ -21,13 +21,15 @@ class ConfigDiffer:
                     return True
         return False
 
-    def _flatten(self, model: BaseModel, path: tuple = ()) -> Dict[tuple, BaseModel]:
+    def _flatten(self, model: BaseModel, path: tuple = ()) -> dict[tuple, BaseModel]:
         """
         Recursively walk a model tree, collecting leaf nodes.
         A leaf is any BaseModel that has direct AttributeValue fields.
         A model can be both a leaf (stored) and have children (recursed into).
         Returns a flat mapping of path → leaf instance.
         """
+        if model is None:
+            return {}
         result = {}
 
         # Store this model if it has AttributeValue fields (e.g. SystemConfig, NtpServer, NetworkInstance)
@@ -57,8 +59,7 @@ class ConfigDiffer:
 
         return result
 
-
-    def _attribute_changes(self, before: BaseModel, after: BaseModel) -> List[AttributeChange]:
+    def _attribute_changes(self, before: BaseModel, after: BaseModel) -> list[AttributeChange]:
         """Compare two component instances and return a list of changed attributes."""
         changes = []
         all_fields = set(before.model_fields.keys()) | set(after.model_fields.keys())
@@ -97,7 +98,9 @@ class ConfigDiffer:
             changed_attributes=self._attribute_changes(before, after) if (before and after) else [],
         )
 
-    def _diff_singletons(self, desired: Dict[tuple, BaseModel], observed: Dict[tuple, BaseModel]) -> List[ComponentChange]:
+    def _diff_singletons(
+        self, desired: dict[tuple, BaseModel], observed: dict[tuple, BaseModel]
+    ) -> list[ComponentChange]:
         """Diff leaves that are not ContainerEntry — matched by exact path."""
         changes = []
         all_paths = set(desired) | set(observed)
@@ -113,13 +116,13 @@ class ConfigDiffer:
                 changes.append(self._make_change(ComponentDiffOp.REMOVE, path, before=o))
         return changes
 
-    def _diff_entries(self, desired: Dict[tuple, BaseModel], observed: Dict[tuple, BaseModel]) -> List[ComponentChange]:
+    def _diff_entries(self, desired: dict[tuple, BaseModel], observed: dict[tuple, BaseModel]) -> list[ComponentChange]:
         """Diff ContainerEntry leaves — matched by identity_fields within each container scope."""
         changes = []
 
         # Group by container path (parent = path[:-1]) so identity matching is scoped
-        desired_by_container: Dict[tuple, Dict[str, BaseModel]] = defaultdict(dict)
-        observed_by_container: Dict[tuple, Dict[str, BaseModel]] = defaultdict(dict)
+        desired_by_container: dict[tuple, dict[str, BaseModel]] = defaultdict(dict)
+        observed_by_container: dict[tuple, dict[str, BaseModel]] = defaultdict(dict)
 
         for path, model in desired.items():
             desired_by_container[path[:-1]][path[-1]] = model
@@ -133,8 +136,8 @@ class ConfigDiffer:
             o_components = observed_by_container.get(container_path, {})
 
             # Build identity → (key, model) lookup for observed
-            o_by_identity: Dict[tuple, tuple[str, BaseModel]] = {}
-            o_by_key: Dict[str, BaseModel] = dict(o_components)
+            o_by_identity: dict[tuple, tuple[str, BaseModel]] = {}
+            o_by_key: dict[str, BaseModel] = dict(o_components)
             for key, model in o_components.items():
                 identity = self._identity_key(model)
                 if identity:  # non-empty identity_fields — match by field values
@@ -159,23 +162,33 @@ class ConfigDiffer:
                 if o_model:
                     matched_o_keys.add(o_key)
                     if d_model != o_model:
-                        changes.append(self._make_change(
-                            ComponentDiffOp.CHANGE, container_path + (d_key,),
-                            before=o_model, after=d_model,
-                        ))
+                        changes.append(
+                            self._make_change(
+                                ComponentDiffOp.CHANGE,
+                                container_path + (d_key,),
+                                before=o_model,
+                                after=d_model,
+                            )
+                        )
                 else:
-                    changes.append(self._make_change(
-                        ComponentDiffOp.ADD, container_path + (d_key,),
-                        after=d_model,
-                    ))
+                    changes.append(
+                        self._make_change(
+                            ComponentDiffOp.ADD,
+                            container_path + (d_key,),
+                            after=d_model,
+                        )
+                    )
 
             # Remaining observed entries that weren't matched → removed
             for o_key, o_model in o_components.items():
                 if o_key not in matched_o_keys:
-                    changes.append(self._make_change(
-                        ComponentDiffOp.REMOVE, container_path + (o_key,),
-                        before=o_model,
-                    ))
+                    changes.append(
+                        self._make_change(
+                            ComponentDiffOp.REMOVE,
+                            container_path + (o_key,),
+                            before=o_model,
+                        )
+                    )
 
         return changes
 

{acex_devkit-2.0.0 → acex_devkit-2.1.1}/src/acex_devkit/configdiffer/diff.py

@@ -6,15 +6,15 @@ added, removed, or changed when comparing two configurations. This enables drive
 to render device-specific command patches based on the component changes.
 """
 
-from pydantic import BaseModel, Field, field_serializer, computed_field
-from typing import Any, Dict, List, Optional, Type
-from enum import Enum
+from enum import StrEnum
+from typing import Any
 
-from acex_devkit.models.attribute_value import AttributeValue
+from pydantic import BaseModel, Field, computed_field, field_serializer
 
 
-class ComponentDiffOp(str, Enum):
+class ComponentDiffOp(StrEnum):
     """Operation type for a component change"""
+
     ADD = "add"
     REMOVE = "remove"
     CHANGE = "change"
@@ -22,17 +22,18 @@ class ComponentDiffOp(str, Enum):
 
 class AttributeChange(BaseModel):
     """Represents a change to a single attribute within a component"""
+
     model_config = {"arbitrary_types_allowed": True}
 
     attribute_name: str
-    before: Optional[Any] = None
-    after: Optional[Any] = None
+    before: Any | None = None
+    after: Any | None = None
 
 
 class ComponentChange(BaseModel):
     """
     Represents a change to a ConfigComponent.
-    
+
     This is the core structure that drivers will use to render patches.
     It contains:
     - The component path (e.g., ['interfaces', 'GigabitEthernet0-0-1'])
@@ -42,26 +43,27 @@ class ComponentChange(BaseModel):
     - The actual ConfigComponent objects (for driver access)
     - Individual attribute changes (for CHANGE operations)
     """
+
     op: ComponentDiffOp
-    path: List[str]  # e.g., ['interfaces', 'GigabitEthernet0-0-1']
-    component_type: Type[Any]  # e.g., 'FrontpanelPort', 'Loopback', 'Vlan'
+    path: list[str]  # e.g., ['interfaces', 'GigabitEthernet0-0-1']
+    component_type: type[Any]  # e.g., 'FrontpanelPort', 'Loopback', 'Vlan'
     component_name: str  # e.g., 'GigabitEthernet0-0-1', 'Lo0', '100'
-    
+
     # Actual ConfigComponent objects
-    before: Optional[Any] = None
-    after: Optional[Any] = None
+    before: Any | None = None
+    after: Any | None = None
 
     # Raw dict representations (for formatters and generic processing)
-    before_dict: Optional[Dict[str, Any]] = None
-    after_dict: Optional[Dict[str, Any]] = None
-    
+    before_dict: dict[str, Any] | None = None
+    after_dict: dict[str, Any] | None = None
+
     # For CHANGE operations: list of changed attributes
-    changed_attributes: List[AttributeChange] = Field(default_factory=list)
-    
+    changed_attributes: list[AttributeChange] = Field(default_factory=list)
+
     model_config = {"arbitrary_types_allowed": True}
 
     @field_serializer("component_type")
-    def serialize_component_type(self, v: Type[Any]) -> str:
+    def serialize_component_type(self, v: type[Any]) -> str:
         return v.__name__
 
     @property
@@ -77,13 +79,14 @@ class ComponentChange(BaseModel):
 class Diff(BaseModel):
     """
     Result of comparing two ComposedConfiguration objects.
-    
+
     This provides a component-centric view of what changed, suitable for
     rendering device-specific patches.
     """
-    added: List[ComponentChange] = Field(default_factory=list)
-    removed: List[ComponentChange] = Field(default_factory=list)
-    changed: List[ComponentChange] = Field(default_factory=list)
+
+    added: list[ComponentChange] = Field(default_factory=list)
+    removed: list[ComponentChange] = Field(default_factory=list)
+    changed: list[ComponentChange] = Field(default_factory=list)
 
     # Total number of config points in desired/observed configs — populated by ConfigDiffer
     total_desired: int = 0
@@ -114,7 +117,7 @@ class Diff(BaseModel):
         """Check if there are no changes"""
         return not (self.added or self.removed or self.changed)
 
-    def summary(self) -> Dict[str, Any]:
+    def summary(self) -> dict[str, Any]:
         """Get a summary of changes and compliance metadata"""
         return {
             "added": len(self.added),
@@ -127,26 +130,20 @@ class Diff(BaseModel):
             "compliance_percentage": self.compliance_percentage,
         }
 
-    def get_all_changes(self) -> List[ComponentChange]:
+    def get_all_changes(self) -> list[ComponentChange]:
         """Get all changes in a single list"""
         return self.added + self.removed + self.changed
 
-    def get_changes_by_type(self, component_type: str) -> List[ComponentChange]:
+    def get_changes_by_type(self, component_type: str) -> list[ComponentChange]:
         """Get all changes for a specific component type (e.g., 'Loopback')"""
-        return [
-            change for change in self.get_all_changes()
-            if change.component_type.__name__ == component_type
-        ]
+        return [change for change in self.get_all_changes() if change.component_type.__name__ == component_type]
 
-    def get_changes_by_path_prefix(self, path_prefix: List[str]) -> List[ComponentChange]:
+    def get_changes_by_path_prefix(self, path_prefix: list[str]) -> list[ComponentChange]:
         """
         Get all changes under a specific path prefix.
-        
+
         Example:
             get_changes_by_path_prefix(['interfaces']) -> all interface changes
             get_changes_by_path_prefix(['network_instances', 'default']) -> changes in default VRF
         """
-        return [
-            change for change in self.get_all_changes()
-            if change.path[:len(path_prefix)] == path_prefix
-        ]
+        return [change for change in self.get_all_changes() if change.path[: len(path_prefix)] == path_prefix]