docs(model): fix flake8 warnings

Author: yt-ms

src/structurizr/model/container_instance.py

@@ -36,12 +36,7 @@
 
 
 class ContainerInstanceIO(DeploymentElementIO):
-    """
-    Represents a container instance which can be added to a deployment node.
-
-    Attributes:
-
-    """
+    """Represents a container instance which can be added to a deployment node."""
 
     container: "ContainerIO"
     container_id: str
@@ -50,12 +45,7 @@ class ContainerInstanceIO(DeploymentElementIO):
 
 
 class ContainerInstance(DeploymentElement):
-    """
-    Represents a container instance which can be added to a deployment node.
-
-    Attributes:
-
-    """
+    """Represents a container instance which can be added to a deployment node."""
 
     def __init__(
         self,

src/structurizr/model/deployment_node.py

@@ -25,25 +25,15 @@
 
 
 class DeploymentNodeIO(DeploymentElementIO):
-    """
-    Represent a deployment node.
-
-    Attributes:
-
-    """
+    """Represent a deployment node."""
 
     parent: "DeploymentNodeIO"
     technology: str = ""
     instances: int = 1
 
 
 class DeploymentNode(DeploymentElement):
-    """
-    Represent a deployment node.
-
-    Attributes:
-
-    """
+    """Represent a deployment node."""
 
     def __init__(
         self,
@@ -65,7 +55,7 @@ def __init__(
 
     @classmethod
     def hydrate(cls, deployment_node_io: DeploymentNodeIO) -> "DeploymentNode":
-        """"""
+        """Hydrate a new DeploymentNode instance from its IO."""
         # TODO (midnighter): Initialization requires `parent`.
         return cls(
             # parent=deployment_node_io.parent,

src/structurizr/model/element.py

@@ -72,7 +72,8 @@ def __init__(
         self.name = name
         self.description = description
         self.url = url
-        # Note: relationships should always match get_efferent_relationships() - i.e. outbound relationships only
+        # Note: relationships should always match get_efferent_relationships() - i.e.
+        # outbound relationships only
         self.relationships: Iterable[Relationship] = set(relationships)
 
         self.tags.add(Tags.ELEMENT)
@@ -108,9 +109,10 @@ def add_relationship(
     ) -> Relationship:
         """Add a new relationship from this element to another.
 
-        This can be used either to add a `Relationship` instance that has already been constructed,
-        or by passing the arguments (e.g. description, destination) with which to construct a new
-        one.  The relationship will automatically be registered with the element's model.
+        This can be used either to add a `Relationship` instance that has already been
+        constructed, or by passing the arguments (e.g. description, destination) with
+        which to construct a new one.  The relationship will automatically be
+        registered with the element's model.
         """
         if relationship is None:
             relationship = Relationship(**kwargs)
@@ -120,7 +122,8 @@ def add_relationship(
             relationship.source = self
         elif relationship.source is not self:
             raise ValueError(
-                f"Cannot add relationship {relationship} to element {self} that is not its source."
+                f"Cannot add relationship {relationship} to element {self} that is "
+                f"not its source."
             )
         self.relationships.add(relationship)
         self.model.add_relationship(
@@ -130,6 +133,7 @@ def add_relationship(
 
     @classmethod
     def hydrate_arguments(cls, element_io: ElementIO) -> dict:
+        """Hydrate an ElementIO into the constructor arguments for Element."""
         return {
             **super().hydrate_arguments(element_io),
             "name": element_io.name,

src/structurizr/model/enterprise.py

@@ -53,5 +53,5 @@ def __init__(self, *, name: str, **kwargs) -> None:
 
     @classmethod
     def hydrate(cls, enterprise_io: EnterpriseIO) -> "Enterprise":
-        """"""
+        """Hydrate a new Enterprise instance from its IO."""
         return cls(name=enterprise_io.name)

src/structurizr/model/model_item.py

@@ -17,7 +17,7 @@
 
 
 from abc import ABC
-from typing import Dict, Iterable, List, Set, Union
+from typing import Dict, Iterable, List, Union
 
 from ordered_set import OrderedSet
 from pydantic import Field, validator
@@ -49,12 +49,13 @@ class ModelItemIO(BaseModel, ABC):
 
     @validator("tags", pre=True)
     def split_tags(cls, tags: Union[str, Iterable[str]]) -> List[str]:
+        """Convert comma-separated tag list into list if needed."""
         if isinstance(tags, str):
             return tags.split(",")
         return list(tags)
 
     def dict(self, **kwargs) -> dict:
-        """"""
+        """Map this IO into a dictionary suitable for serialisation."""
         obj = super().dict(**kwargs)
         if "tags" in obj:
             obj["tags"] = ",".join(obj["tags"])
@@ -82,18 +83,20 @@ def __init__(
         perspectives: Iterable[Perspective] = (),
         **kwargs,
     ):
-        """"""
+        """Initialise a ModelItem instance."""
         super().__init__(**kwargs)
         self.id = id
         self.tags = OrderedSet(tags)
         self.properties = dict(properties)
         self.perspectives = set(perspectives)
 
     def __repr__(self) -> str:
+        """Return repr(self)."""
         return f"{type(self).__name__}(id={self.id})"
 
     @classmethod
     def hydrate_arguments(cls, model_item_io: ModelItemIO) -> dict:
+        """Hydrate an ModelItemIO into the constructor arguments for ModelItem."""
         return {
             "id": model_item_io.id,
             "tags": model_item_io.tags,

src/structurizr/model/perspective.py

@@ -71,4 +71,5 @@ def __init__(self, *, name: str, description: str, **kwargs) -> None:
 
     @classmethod
     def hydrate(cls, perspective_io: PerspectiveIO) -> "Perspective":
+        """Hydrate a new Perspective instance from its IO."""
         return cls(name=perspective_io.name, description=perspective_io.description)

src/structurizr/model/static_structure_element.py

@@ -57,6 +57,7 @@ def uses(
         technology: str = "",
         **kwargs,
     ) -> Optional["Relationship"]:
+        """Add a unidirectional "uses" style relationship to another element."""
         return self.get_model().add_relationship(
             source=self,
             destination=destination,
@@ -72,6 +73,7 @@ def delivers(
         technology: str = "",
         **kwargs,
     ) -> Optional["Relationship"]:
+        """Add a unidirectional relationship to another element."""
         return self.uses(
             destination=destination,
             description=description,