docs(views): fix flake8 warnings

Author: yt-ms

src/structurizr/view/vertex.py

@@ -26,24 +26,14 @@
 
 
 class VertexIO(BaseModel):
-    """
-    Define a wrapper for a vertex.
-
-    Attributes:
-
-    """
+    """Define a wrapper for a vertex."""
 
     x: Optional[int] = Field(default=None)
     y: Optional[int] = Field(default=None)
 
 
 class Vertex(AbstractBase):
-    """
-    Define a wrapper for a vertex.
-
-    Attributes:
-
-    """
+    """Define a wrapper for a vertex."""
 
     def __init__(self, *, x: int, y: int, **kwargs) -> None:
         """Initialize an automatic layout."""
@@ -53,4 +43,5 @@ def __init__(self, *, x: int, y: int, **kwargs) -> None:
 
     @classmethod
     def hydrate(cls, vertex_io: VertexIO) -> "Vertex":
+        """Hydrate a new Vertex instance from its IO."""
         return cls(x=vertex_io.x, y=vertex_io.y)

src/structurizr/view/view.py

@@ -24,7 +24,7 @@
 from ..abstract_base import AbstractBase
 from ..base_model import BaseModel
 from ..mixin import ViewSetRefMixin
-from ..model import Element, SoftwareSystem
+from ..model import Element, Model, SoftwareSystem
 from .automatic_layout import AutomaticLayout, AutomaticLayoutIO
 from .element_view import ElementView, ElementViewIO
 from .paper_size import PaperSize
@@ -39,9 +39,6 @@ class ViewIO(BaseModel, ABC):
     Define an abstract base class for all views.
 
     Views include static views, dynamic views and deployment views.
-
-    Attributes:
-
     """
 
     key: str
@@ -102,10 +99,12 @@ def __init__(
         self.layout_merge_strategy = layout_merge_strategy
 
     def __repr__(self) -> str:
+        """Return repr(self)."""
         return f"{type(self).__name__}(key={self.key})"
 
     @classmethod
     def hydrate_arguments(cls, view_io: ViewIO) -> Dict:
+        """Hydrate a ViewIO into the constructor arguments for View."""
         return {
             # TODO: should we add this here? probably not: "software_system"
             "key": view_io.key,
@@ -122,7 +121,8 @@ def hydrate_arguments(cls, view_io: ViewIO) -> Dict:
         }
 
     @property
-    def model(self):
+    def model(self) -> Model:
+        """Return the `Model` for this view."""
         return self.software_system.get_model()
 
     def _add_element(self, element: Element, add_relationships: bool) -> None:
@@ -188,6 +188,7 @@ def _add_relationships(self, element: Element) -> None:
                 self.relationship_views.add(RelationshipView(relationship=relationship))
 
     def copy_layout_information_from(self, source: "View") -> None:
+        """Copy the layout information from another view, including child views."""
         if not self.paper_size:
             self.paper_size = source.paper_size
 
@@ -210,6 +211,7 @@ def copy_layout_information_from(self, source: "View") -> None:
     def find_element_view(
         self, source_element_view: ElementView
     ) -> Optional[ElementView]:
+        """Find a child element view corresponding to the given source view."""
         for element_view in self.element_views:
             if element_view.element.id == source_element_view.element.id:
                 return element_view
@@ -218,6 +220,7 @@ def find_element_view(
     def find_relationship_view(
         self, source_relationship_view: RelationshipView
     ) -> Optional[RelationshipView]:
+        """Find a child element view corresponding to the given relationship view."""
         for relationship_view in self.relationship_views:
             if (
                 relationship_view.relationship.id

src/structurizr/view/view_set.py

@@ -43,9 +43,6 @@ class ViewSetIO(BaseModel):
     Define a set of views onto a software architecture model.
 
     Views include static views, dynamic views and deployment views.
-
-    Attributes:
-
     """
 
     system_landscape_views: List[SystemLandscapeViewIO] = Field(
@@ -69,9 +66,6 @@ class ViewSet(ModelRefMixin, AbstractBase):
     Define a set of views onto a software architecture model.
 
     Views include static views, dynamic views and deployment views.
-
-    Attributes:
-
     """
 
     def __init__(
@@ -101,6 +95,7 @@ def __init__(
 
     @classmethod
     def hydrate(cls, views: ViewSetIO, model: "Model") -> "ViewSet":
+        """Hydrate a new ViewSet instance from its IO."""
         system_landscape_views = []
         for view_io in views.system_landscape_views:
             view = SystemLandscapeView.hydrate(view_io, model=model)
@@ -156,7 +151,15 @@ def _hydrate_view(cls, view: View, model: "Model") -> None:
     def create_system_landscape_view(
         self, system_landscape_view: Optional[SystemLandscapeView] = None, **kwargs
     ) -> SystemLandscapeView:
-        # TODO:
+        """
+        Add a new SystemLandscapeView to the ViewSet.
+
+        Args:
+            system_landscape_view (SystemLandscapeView, optional): Either provide a
+                `SystemLandscapeView` instance or
+            **kwargs: Provide keyword arguments for instantiating a
+                `SystemLandscapeView` (recommended).
+        """        # TODO:
         # assertThatTheViewKeyIsSpecifiedAndUnique(key);
         if system_landscape_view is None:
             system_landscape_view = SystemLandscapeView(
@@ -169,6 +172,15 @@ def create_system_landscape_view(
     def create_system_context_view(
         self, system_context_view: Optional[SystemContextView] = None, **kwargs
     ) -> SystemContextView:
+        """
+        Add a new SystemContextView to the ViewSet.
+
+        Args:
+            system_context_view (SystemContextView, optional): Either provide a
+                `SystemContextView` instance or
+            **kwargs: Provide keyword arguments for instantiating a `SystemContextView`
+                (recommended).
+        """
         # TODO:
         # assertThatTheSoftwareSystemIsNotNull(softwareSystem);
         # assertThatTheViewKeyIsSpecifiedAndUnique(key);
@@ -181,6 +193,15 @@ def create_system_context_view(
     def create_container_view(
         self, container_view: Optional[ContainerView] = None, **kwargs
     ) -> ContainerView:
+        """
+        Add a new ContainerView to the ViewSet.
+
+        Args:
+            container_view (ContainerView, optional): Either provide a
+                `ContainerView` instance or
+            **kwargs: Provide keyword arguments for instantiating a `ContainerView`
+                (recommended).
+        """
         # TODO:
         # assertThatTheSoftwareSystemIsNotNull(softwareSystem);
         # assertThatTheViewKeyIsSpecifiedAndUnique(key);
@@ -193,6 +214,15 @@ def create_container_view(
     def create_component_view(
         self, component_view: Optional[ComponentView] = None, **kwargs
     ) -> ComponentView:
+        """
+        Add a new ComponentView to the ViewSet.
+
+        Args:
+            component_view (ComponentView, optional): Either provide a
+                `ComponentView` instance or
+            **kwargs: Provide keyword arguments for instantiating a `ComponentView`
+                (recommended).
+        """
         # TODO:
         # AssertThatTheViewKeyIsUnique(key);
         if component_view is None:
@@ -202,6 +232,7 @@ def create_component_view(
         return component_view
 
     def copy_layout_information_from(self, source: "ViewSet") -> None:
+        """Copy all the layout information from a source ViewSet."""
         for source_view in source.system_landscape_views:
             destination_view = self._find_system_landscape_view(source_view)
             if destination_view: