buildzr 0.0.12__py3-none-any.whl → 0.0.14__py3-none-any.whl

buildzr/dsl/explorer.py

@@ -3,6 +3,10 @@ from buildzr.dsl.dsl import (
     SoftwareSystem,
     Container,
     Component,
+    DeploymentNode,
+    InfrastructureNode,
+    SoftwareSystemInstance,
+    ContainerInstance,
 )
 
 from buildzr.dsl.relations import (
@@ -27,10 +31,32 @@ from buildzr.dsl.interfaces import (
 
 class Explorer:
 
-    def __init__(self, workspace_or_element: Union[Workspace, Person, SoftwareSystem, Container, Component]):
+    def __init__(
+        self,
+        workspace_or_element: Union[
+            Workspace,
+            Person,
+            SoftwareSystem,
+            Container,
+            Component,
+            DeploymentNode,
+            InfrastructureNode,
+            SoftwareSystemInstance,
+            ContainerInstance,
+        ]
+    ):
         self._workspace_or_element = workspace_or_element
 
-    def walk_elements(self) -> Generator[Union[Person, SoftwareSystem, Container, Component], None, None]:
+    def walk_elements(self) -> Generator[Union[
+        Person,
+        SoftwareSystem,
+        Container,
+        Component,
+        DeploymentNode,
+        InfrastructureNode,
+        SoftwareSystemInstance,
+        ContainerInstance
+    ], None, None]:
         if self._workspace_or_element.children:
             for child in self._workspace_or_element.children:
                 explorer = Explorer(child).walk_elements()

buildzr/dsl/expression.py

@@ -10,6 +10,11 @@ from buildzr.dsl.dsl import (
     SoftwareSystem,
     Container,
     Component,
+    DeploymentNode,
+    InfrastructureNode,
+    SoftwareSystemInstance,
+    ContainerInstance,
+    TypedDynamicAttribute,
 )
 
 from buildzr.dsl.relations import _Relationship
@@ -19,7 +24,22 @@ from typing import Set, Union, Optional, List, Dict, Any, Callable, Tuple, Seque
 from typing_extensions import TypeIs
 
 def _has_technology_attribute(obj: DslElement) -> TypeIs[Union[Container, Component]]:
-    if isinstance(obj, (Person, SoftwareSystem, Workspace)):
+    if isinstance(obj, (Person, SoftwareSystem, Workspace, SoftwareSystemInstance, ContainerInstance)):
+        return False
+    return True
+
+def _has_group_attribute(obj: DslElement) -> TypeIs[Union[Person, SoftwareSystem, Container, Component]]:
+    if isinstance(obj, (Workspace, DeploymentNode, InfrastructureNode, SoftwareSystemInstance, ContainerInstance)):
+        return False
+    return True
+
+def _has_name_attribute(obj: DslElement) -> TypeIs[Union[Person, SoftwareSystem, Container, Component, DeploymentNode, InfrastructureNode]]:
+    if isinstance(obj, (Workspace, SoftwareSystemInstance, ContainerInstance)):
+        return False
+    return True
+
+def _has_environment_attribute(obj: DslElement) -> TypeIs[Union[ContainerInstance, SoftwareSystemInstance]]:
+    if isinstance(obj, (Workspace, Person, SoftwareSystem, Container, Component)):
         return False
     return True
 
@@ -37,7 +57,19 @@ class FlattenElement:
 
     @property
     def names(self) -> Set[Union[str]]:
-        return set([str(element.model.name) for element in self._elements])
+
+        """
+        Returns the names of the elements.
+
+        If the element is a `SoftwareSystemInstance` or `ContainerInstance`,
+        which has no name attribute, it will be excluded from the result.
+        """
+
+        name_set: Set[str] = set()
+        for element in self._elements:
+            if _has_name_attribute(element):
+                name_set.add(str(element.model.name))
+        return name_set
 
     @property
     def tags(self) -> Set[Union[str]]:
@@ -47,12 +79,37 @@ class FlattenElement:
             all_tags = all_tags.union(tags)
         return all_tags
 
-class Element:
+class WorkspaceExpression:
+
+    """
+    A class used to filter the allowable methods and properties of the
+    `Structurizr DSL` workspace. This is used to filter the elements and
+    relationships in the workspace.
+    """
+
+    def __init__(self, workspace: Workspace):
+        self._workspace = workspace
+        self._dynamic_attributes = self._workspace._dynamic_attrs
+
+    def software_system(self) -> TypedDynamicAttribute['SoftwareSystem']:
+        """
+        Returns the software system of the workspace. This is used to filter the
+        elements and relationships in the workspace.
+        """
+        return TypedDynamicAttribute['SoftwareSystem'](self._dynamic_attributes)
+
+    def person(self) -> TypedDynamicAttribute['Person']:
+        """
+        Returns the person of the workspace. This is used to filter the elements
+        and relationships in the workspace.
+        """
+        return TypedDynamicAttribute['Person'](self._dynamic_attributes)
+
+class ElementExpression:
 
     def __init__(self, element: DslElement):
         self._element = element
 
-    # TODO: Make a test for this in `tests/test_expression.py`
     @property
     def id(self) -> str:
         return cast(str, self._element.model.id)
@@ -76,6 +133,10 @@ class Element:
     def parent(self) -> Optional[Union[DslWorkspaceElement, DslElement]]:
         return self._element.parent
 
+    @property
+    def children(self) -> FlattenElement:
+        return FlattenElement(self._element.children)
+
     @property
     def sources(self) -> FlattenElement:
         return FlattenElement(self._element.sources)
@@ -86,23 +147,52 @@ class Element:
 
     @property
     def properties(self) -> Dict[str, Any]:
-        return self._element.model.properties
+        if self._element.model.properties is not None:
+            return self._element.model.properties
+        return dict()
 
     @property
     def group(self) -> Optional[str]:
+
         """
-        Returns the group of the element. The group is a string that is used to
+        Returns the group of the element (if applicable). The group is a string that is used to
         group elements in the Structurizr DSL.
         """
-        if not isinstance(self._element.model, buildzr.models.Workspace):
+
+        if _has_group_attribute(self._element):
             return self._element.model.group
         return None
 
+    @property
+    def environment(self) -> Optional[str]:
+
+        """
+        Returns the environment of the element (if applicable). The environment
+        is a string that is used to group deployment nodes and instances in the
+        Structurizr DSL.
+        """
+
+        if _has_environment_attribute(self._element):
+            return self._element.model.environment
+        return None
+
+    def is_instance_of(self, other: DslElement) -> bool:
+
+        """
+        Returns `True` if the element is an instance of the other element.
+        """
+
+        if isinstance(self._element, SoftwareSystemInstance):
+            return self._element.model.softwareSystemId == other.model.id
+        elif isinstance(self._element, ContainerInstance):
+            return self._element.model.containerId == other.model.id
+        return False
+
     def __eq__(self, element: object) -> bool:
         return isinstance(element, type(self._element)) and\
                element.model.id == self._element.model.id
 
-class Relationship:
+class RelationshipExpression:
 
     def __init__(self, relationship: DslRelationship):
         self._relationship = relationship
@@ -121,12 +211,12 @@ class Relationship:
         return self._relationship.model.technology
 
     @property
-    def source(self) -> Element:
-        return Element(self._relationship.source)
+    def source(self) -> ElementExpression:
+        return ElementExpression(self._relationship.source)
 
     @property
-    def destination(self) -> Element:
-        return Element(self._relationship.destination)
+    def destination(self) -> ElementExpression:
+        return ElementExpression(self._relationship.destination)
 
     @property
     def properties(self) -> Dict[str, Any]:
@@ -146,10 +236,10 @@ class Expression:
 
     def __init__(
         self,
-        include_elements: Iterable[Union[DslElement, Callable[[Workspace, Element], bool]]]=[lambda w, e: True],
-        exclude_elements: Iterable[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        include_relationships: Iterable[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[lambda w, e: True],
-        exclude_relationships: Iterable[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
+        include_elements: Iterable[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[lambda w, e: True],
+        exclude_elements: Iterable[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        include_relationships: Iterable[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[lambda w, e: True],
+        exclude_relationships: Iterable[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
     ) -> 'None':
         self._include_elements = include_elements
         self._exclude_elements = exclude_elements
@@ -171,12 +261,12 @@ class Expression:
                 if isinstance(f, DslElement):
                     includes.append(f == element)
                 else:
-                    includes.append(f(workspace, Element(element)))
+                    includes.append(f(WorkspaceExpression(workspace), ElementExpression(element)))
             for f in self._exclude_elements:
                 if isinstance(f, DslElement):
                     excludes.append(f == element)
                 else:
-                    excludes.append(f(workspace, Element(element)))
+                    excludes.append(f(WorkspaceExpression(workspace), ElementExpression(element)))
             if any(includes) and not any(excludes):
                 filtered_elements.append(element)
 
@@ -198,9 +288,9 @@ class Expression:
         filtered_relationships: List[DslRelationship] = []
 
         def _is_relationship_of_excluded_elements(
-            workspace: Workspace,
-            relationship: Relationship,
-            exclude_element_predicates: Iterable[Union[DslElement, Callable[[Workspace, Element], bool]]],
+            workspace: WorkspaceExpression,
+            relationship: RelationshipExpression,
+            exclude_element_predicates: Iterable[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]],
         ) -> bool:
             for f in exclude_element_predicates:
                 if isinstance(f, DslElement):
@@ -222,20 +312,20 @@ class Expression:
                 if isinstance(f, DslElement):
                     includes.append(f == relationship)
                 else:
-                    includes.append(f(workspace, Relationship(relationship)))
+                    includes.append(f(WorkspaceExpression(workspace), RelationshipExpression(relationship)))
 
             for f in self._exclude_relationships:
                 if isinstance(f, DslElement):
                     excludes.append(f == relationship)
                 else:
-                    excludes.append(f(workspace, Relationship(relationship)))
+                    excludes.append(f(WorkspaceExpression(workspace), RelationshipExpression(relationship)))
 
             # Also exclude relationships whose source or destination elements
             # are excluded.
             excludes.append(
                 _is_relationship_of_excluded_elements(
-                    workspace,
-                    Relationship(relationship),
+                    WorkspaceExpression(workspace),
+                    RelationshipExpression(relationship),
                     self._exclude_elements,
                 )
             )

buildzr/dsl/interfaces/__init__.py

@@ -3,6 +3,10 @@ from .interfaces import (
     DslRelationship,
     DslWorkspaceElement,
     DslViewElement,
+    DslDeploymentEnvironment,
+    DslInfrastructureNodeElement,
+    DslDeploymentNodeElement,
+    DslElementInstance,
     BindLeft,
     BindRight,
     BindLeftLate,

buildzr/dsl/interfaces/interfaces.py

@@ -25,6 +25,10 @@ Model = Union[
     buildzr.models.SoftwareSystem,
     buildzr.models.Container,
     buildzr.models.Component,
+    buildzr.models.DeploymentNode,
+    buildzr.models.InfrastructureNode,
+    buildzr.models.SoftwareSystemInstance,
+    buildzr.models.ContainerInstance,
 ]
 
 TSrc = TypeVar('TSrc', bound='DslElement', contravariant=True)
@@ -205,4 +209,77 @@ class DslViewElement(ABC):
     @property
     @abstractmethod
     def model(self) -> ViewModel:
+        pass
+
+class DslElementInstance(DslElement):
+
+    Model = Union[
+        buildzr.models.SoftwareSystemInstance,
+        buildzr.models.ContainerInstance,
+    ]
+
+    @property
+    @abstractmethod
+    def model(self) -> Model:
+        pass
+
+    @property
+    def parent(self) -> Optional['DslDeploymentNodeElement']:
+        pass
+
+    @property
+    def tags(self) -> Set[str]:
+        pass
+
+    @property
+    def element(self) -> DslElement:
+        pass
+
+class DslInfrastructureNodeElement(DslElement):
+
+    @property
+    @abstractmethod
+    def model(self) -> buildzr.models.InfrastructureNode:
+        pass
+
+    @property
+    def tags(self) -> Set[str]:
+        pass
+
+    @property
+    @abstractmethod
+    def parent(self) -> Optional['DslDeploymentNodeElement']:
+        pass
+
+class DslDeploymentNodeElement(DslElement):
+
+    @property
+    @abstractmethod
+    def model(self) -> buildzr.models.DeploymentNode:
+        pass
+
+    @property
+    def tags(self) -> Set[str]:
+        pass
+
+    @property
+    @abstractmethod
+    def parent(self) -> Optional['DslWorkspaceElement']:
+        pass
+
+    @property
+    @abstractmethod
+    def children(self) -> Optional[Sequence[Union[DslElementInstance, 'DslInfrastructureNodeElement', 'DslDeploymentNodeElement']]]:
+        pass
+
+class DslDeploymentEnvironment(ABC):
+
+    @property
+    @abstractmethod
+    def parent(self) -> Optional[DslWorkspaceElement]:
+        pass
+
+    @property
+    @abstractmethod
+    def children(self) -> Sequence[DslDeploymentNodeElement]:
         pass

buildzr/models/generate.sh

@@ -5,6 +5,15 @@ curl $schema_url > structurizr.yaml
 # Change from 'long' (unsupported) to 'integer'
 yq -i -y '.components.schemas.Workspace.properties.id.type = "integer"' structurizr.yaml
 
+# Add `deploymentGroups: List[str]` to the following dataclasses:
+# - `SoftwareSystemInstance`
+# - `ContainerInstance`
+# Because the `deploymentGroups` property is not in the schema, but it's
+# something that is present in the JSON output if we convert the DSL into JSON
+# (when using the `deploymentGroup` keyword).
+yq -i -y '.components.schemas.ContainerInstance.properties.deploymentGroups = {"type": "array", "items": {"type": "string"}}' structurizr.yaml
+yq -i -y '.components.schemas.SoftwareSystemInstance.properties.deploymentGroups = {"type": "array", "items": {"type": "string"}}' structurizr.yaml
+
 # Type 'integer' doesn't support 'number' type, but supports the following:
 # int32, int64, default, date-time, unix-time
 # yq -i 'select(.components.schemas.*.properties.*.format=="integer" and .components.schemas.*.properties.*.type=="number") .components.schemas.*.properties.*.format="default"' structurizr.yaml

buildzr/models/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  structurizr.yaml
-#   timestamp: 2024-07-06T09:38:20+00:00
+#   timestamp: 2025-05-20T13:19:11+00:00
 
 from __future__ import annotations
 
@@ -1098,6 +1098,7 @@ class SoftwareSystemInstance:
     """
     The set of HTTP-based health checks for this software system instance.
     """
+    deploymentGroups: Optional[List[str]] = None
 
 
 @dataclass
@@ -1142,6 +1143,7 @@ class ContainerInstance:
     """
     The set of HTTP-based health checks for this container instance.
     """
+    deploymentGroups: Optional[List[str]] = None
 
 
 @dataclass

{buildzr-0.0.12.dist-info → buildzr-0.0.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildzr
-Version: 0.0.12
+Version: 0.0.14
 Summary: Structurizr for the `buildzr`s 🧱⚒️
 Project-URL: homepage, https://github.com/amirulmenjeni/buildzr
 Project-URL: issues, https://github.com/amirulmenjeni/buildzr/issues
@@ -11,12 +11,10 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: pyhumps==3.8.0
 Requires-Dist: pytest>=8.3.3
 Provides-Extra: dev

buildzr-0.0.14.dist-info/RECORD

@@ -0,0 +1,24 @@
+buildzr/__about__.py,sha256=Re70LR9m7cAhH54rssYyZTF_NDTijR8Lo_1hWF3ofTI,19
+buildzr/__init__.py,sha256=hY-cOdjBQcz0v2m8cBF1oEJFIbcR3sWI-xww--0RKSo,99
+buildzr/dsl/__init__.py,sha256=qJ41IXcabKUjvwMzgfUCFdmDnSBBK7VFADpoVdOYLKQ,538
+buildzr/dsl/color.py,sha256=at5lo3WgLEDCjrnbu37ra1p1TjzdB51sxeW7pBMC_7U,4019
+buildzr/dsl/dsl.py,sha256=qqKlz8KNzAxdwsdPM5YhVE2JhwYMRJ9o7KbMMarQGlw,83579
+buildzr/dsl/explorer.py,sha256=m1nI0Rd0bXGj1uXDgTC4DJhc2FMma522IepPNvQF07E,1853
+buildzr/dsl/expression.py,sha256=TLSe-uGlHhNqMPQU_5IRLIP-ZGsQ_ts3DquBMcYlwBg,11777
+buildzr/dsl/relations.py,sha256=GBs5epr9uuExU_H6VcP4XY76iJPQ__rz_d8tZlhhWQ4,11891
+buildzr/dsl/factory/__init__.py,sha256=niaYqvNPUWJejoPyRyABUtzVsoxaV8eSjzS9dta4bMI,30
+buildzr/dsl/factory/gen_id.py,sha256=LnaeOCMngSvYkcGnuARjQYoUVWdcOoNHO2EHe6PMGco,538
+buildzr/dsl/interfaces/__init__.py,sha256=3InvtLOyYNm9nCPFAkYVbunBQ4AVSdHZ46Ah0CkoLNM,294
+buildzr/dsl/interfaces/interfaces.py,sha256=hLISS0cAfhHqhTWRI5UPKKzqmsPuHmFgdx3JjzBA01U,6750
+buildzr/encoders/__init__.py,sha256=suID63Ay-023T0uKD25EAoGYmAMTa9AKxIjioccpiPM,32
+buildzr/encoders/encoder.py,sha256=n8WLVMrisykBTLTr1z6PAxgqhqW2dFRZhSupOuMdx_A,3235
+buildzr/models/__init__.py,sha256=SRfF7oDVlOOAi6nGKiJIUK6B_arqYLO9iSMp-2IZZps,21
+buildzr/models/generate.sh,sha256=EJ63d4cYmRnMFzc3hIR6bro44PXYEOt3EE9BxY4F8cU,1670
+buildzr/models/models.py,sha256=NJOFYiRQ2i_1gP2ajPNpEfVLAz-1iCqqt1gPOHDPIks,42587
+buildzr/sinks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+buildzr/sinks/interfaces.py,sha256=LOZekP4WNjomD5J5f3FnZTwGj0aXMr6RbrvyFV5zn0E,383
+buildzr/sinks/json_sink.py,sha256=onKOZTpwOQfeMEj1ONkuIEHBAQhx4yQSqqI_lgZBaP8,777
+buildzr-0.0.14.dist-info/METADATA,sha256=CkcJWUlnCfXDHZQwMZWhbnxTgCkOIWDdoJI4n2dl4ZM,6480
+buildzr-0.0.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+buildzr-0.0.14.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
+buildzr-0.0.14.dist-info/RECORD,,

buildzr-0.0.12.dist-info/RECORD

@@ -1,24 +0,0 @@
-buildzr/__about__.py,sha256=BCu0JmKIBuKGzB3jxd2V1AqofeA6ZLJuDN4qaEsLYbg,18
-buildzr/__init__.py,sha256=hY-cOdjBQcz0v2m8cBF1oEJFIbcR3sWI-xww--0RKSo,99
-buildzr/dsl/__init__.py,sha256=k0G9blhA3NSzCBs1dSfBNzCh0iDS_ylkzS_5a3pqrSY,375
-buildzr/dsl/color.py,sha256=at5lo3WgLEDCjrnbu37ra1p1TjzdB51sxeW7pBMC_7U,4019
-buildzr/dsl/dsl.py,sha256=7OEz2JXm_1s7RN5G3wauwuBNly6odi19wPfpwC1FQI4,52601
-buildzr/dsl/explorer.py,sha256=GuQihoEvmTwiriXT3X8oasJ_U65ERyKJeJ2WW-S9D84,1389
-buildzr/dsl/expression.py,sha256=j847pBVQTvLbpxU1SB8ZYPbXO24SN-evprjAfkS6AGo,8258
-buildzr/dsl/relations.py,sha256=GBs5epr9uuExU_H6VcP4XY76iJPQ__rz_d8tZlhhWQ4,11891
-buildzr/dsl/factory/__init__.py,sha256=niaYqvNPUWJejoPyRyABUtzVsoxaV8eSjzS9dta4bMI,30
-buildzr/dsl/factory/gen_id.py,sha256=LnaeOCMngSvYkcGnuARjQYoUVWdcOoNHO2EHe6PMGco,538
-buildzr/dsl/interfaces/__init__.py,sha256=GRzfjdDxAUaZ-2n-eP4YaGLy3b0_giHhMshGqoj9rbo,176
-buildzr/dsl/interfaces/interfaces.py,sha256=OYOS-eGlkadGWXvcLSP1Qs9AnJfhtoJGh9UqJRC8gDk,5079
-buildzr/encoders/__init__.py,sha256=suID63Ay-023T0uKD25EAoGYmAMTa9AKxIjioccpiPM,32
-buildzr/encoders/encoder.py,sha256=n8WLVMrisykBTLTr1z6PAxgqhqW2dFRZhSupOuMdx_A,3235
-buildzr/models/__init__.py,sha256=SRfF7oDVlOOAi6nGKiJIUK6B_arqYLO9iSMp-2IZZps,21
-buildzr/models/generate.sh,sha256=924UoEXr5WBZ926TZfRgEQGHwBqtLGU5k0G2UfExLEg,1061
-buildzr/models/models.py,sha256=0LhLG1wmbt4dvROV5MEBZLLoxPbMpkUsOqNz525cynE,42489
-buildzr/sinks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-buildzr/sinks/interfaces.py,sha256=LOZekP4WNjomD5J5f3FnZTwGj0aXMr6RbrvyFV5zn0E,383
-buildzr/sinks/json_sink.py,sha256=onKOZTpwOQfeMEj1ONkuIEHBAQhx4yQSqqI_lgZBaP8,777
-buildzr-0.0.12.dist-info/METADATA,sha256=W2raGn9MDY9YAWC5wbwm8mwfwUbF8RQ2VXDaLsqLjPk,6579
-buildzr-0.0.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-buildzr-0.0.12.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
-buildzr-0.0.12.dist-info/RECORD,,