style: more PR feedback

Author: yt-ms

src/structurizr/model/container.py

@@ -154,8 +154,7 @@ def __iadd__(self, component: Component) -> "Container":
                 f"{component.parent}. Cannot add to {self}."
             )
         self._components.add(component)
-        model = self.get_model()
-        model += component
+        self.model.add(component)
         return self
 
     def get_component_with_name(self, name: str) -> Component:

src/structurizr/model/model.py

@@ -118,12 +118,12 @@ def __contains__(self, element: Element):
     @property
     def software_systems(self) -> Set[SoftwareSystem]:
         """Return the software systems in the model."""
-        return set([e for e in self.get_elements() if isinstance(e, SoftwareSystem)])
+        return {e for e in self.get_elements() if isinstance(e, SoftwareSystem)}
 
     @property
     def people(self) -> Set[Person]:
         """Return the people in the model."""
-        return set([e for e in self.get_elements() if isinstance(e, Person)])
+        return {e for e in self.get_elements() if isinstance(e, Person)}
 
     @classmethod
     def hydrate(cls, model_io: ModelIO) -> "Model":
@@ -199,6 +199,11 @@ def add_software_system(self, **kwargs) -> SoftwareSystem:
         return software_system
 
     def __iadd__(self, element: Element) -> "Model":
+        """Add a newly constructed element to the model."""
+        self.add(element)
+        return self
+
+    def add(self, element: Element):
         """Add a newly constructed element to the model."""
         if isinstance(element, Person):
             if any(element.name == p.name for p in self.people):
@@ -218,7 +223,6 @@ def __iadd__(self, element: Element) -> "Model":
                 f"you have added it to the parent element."
             )
         self._add_element(element)
-        return self
 
     def add_container_instance(
         self,

src/structurizr/model/software_system.py

@@ -63,7 +63,7 @@ class SoftwareSystem(StaticStructureElement):
     """
 
     def __init__(self, *, location: Location = Location.Unspecified, **kwargs) -> None:
-        """"""
+        """Initialise a new SoftwareSystem."""
         super().__init__(**kwargs)
         self.location = location
         self.containers: Set[Container] = set()
@@ -85,10 +85,10 @@ def add_container(
         return container
 
     def __iadd__(self, container: Container) -> "SoftwareSystem":
-        """Add a newly constructed container to this system and register with its model."""
-        # TODO: once we move past python 3.6 change to proper return type via __future__.annotations
+        """Add a new container to this system and register with its model."""
+        # TODO: once we move past python 3.6 change to proper return type via
+        # __future__.annotations
         if container in self.containers:
-            # Nothing to do
             return self
 
         if self.get_container_with_name(container.name):
@@ -104,8 +104,7 @@ def __iadd__(self, container: Container) -> "SoftwareSystem":
                 f"{container.parent}. Cannot add to {self}."
             )
         self.containers.add(container)
-        model = self.get_model()
-        model += container
+        self.model.add(container)
         return self
 
     def get_container_with_name(self, name: str) -> Container:
@@ -116,7 +115,7 @@ def get_container_with_name(self, name: str) -> Container:
     def hydrate(
         cls, software_system_io: SoftwareSystemIO, model: "Model"
     ) -> "SoftwareSystem":
-        """"""
+        """Create a new SoftwareSystem instance and hydrate it from its IO."""
         software_system = cls(
             **cls.hydrate_arguments(software_system_io),
             location=software_system_io.location,

tests/unit/model/test_container.py

@@ -27,12 +27,11 @@ def __init__(self):
         self.empty_container = Container(name="Container", description="Description")
         self.empty_container.set_model(self)
 
-    def __iadd__(self, component):
+    def add(self, component):
         """Simulate the model assigning IDs to new elements."""
         if not component.id:
             component.id = "id"
         component.set_model(self)
-        return self
 
 
 @pytest.fixture(scope="function")

tests/unit/model/test_software_system.py

@@ -30,12 +30,11 @@ def __init__(self):
         self.empty_system = SoftwareSystem(name="Sys")
         self.empty_system.set_model(self)
 
-    def __iadd__(self, container):
+    def add(self, container):
         """Simulate the model assigning IDs to new elements."""
         if not container.id:
             container.id = "id"
         container.set_model(self)
-        return self
 
 
 @pytest.fixture(scope="function")