style: resolve some flake8 items

Author: yt-ms

tests/integration/test_model_element_relationships.py

@@ -28,7 +28,8 @@
 
 
 def test_adding_relationship_to_element_adds_to_model():
-    """
+    """Ensure relationships are added to the model.
+
     Make sure that when a relationship is added via Element.add_relationship it also
     gets added to the model and to the other element.
     """
@@ -47,9 +48,10 @@ def test_adding_relationship_to_element_adds_to_model():
 
 
 def test_adding_relationship_to_model_adds_to_element():
-    """
-    Make sure that when a relationship is added via Element.add_relationship it also
-    gets added to the model and to the other element.
+    """Ensure relationships are added to elements.
+
+    Make sure that when a relationship is added via Model.add_relationship it also
+    gets added to the elements.
     """
     model = Model()
     sys1 = model.add_software_system(name="sys1")
@@ -66,10 +68,7 @@ def test_adding_relationship_to_model_adds_to_element():
 
 
 def test_adding_relationship_via_uses_adds_to_elements():
-    """
-    Make sure that when a relationship is added via StaticStructureElement.uses
-    then it is reflected in the Elements.
-    """
+    """Ensure uses() adds relationships to the model and elements."""
     model = Model()
     sys1 = model.add_software_system(name="sys1")
     sys2 = model.add_software_system(name="sys2")
@@ -87,7 +86,7 @@ def test_adding_relationship_via_uses_adds_to_elements():
     ["BigBank.json"],
 )
 def test_relationships_after_deserialisation_are_consistent(filename: str):
-    """Make sure that relationships are consistent between the Model and the Element after deserialisation."""
+    """Ensure deserialisaton leaves realationships consistent."""
     path = DEFINITIONS / filename
     workspace = Workspace.load(path)
     model = workspace.model

tests/integration/test_model_elements.py

@@ -24,6 +24,7 @@
 
 @pytest.fixture(scope="function")
 def model() -> Model:
+    """Manufacture an empty model for test cases."""
     return Model()
 
 

tests/unit/model/test_element.py

@@ -31,6 +31,7 @@ class MockModel:
     """Implement a mock model for reference testing."""
 
     def add_relationship(self, relationship):
+        """Provide mock implementation."""
         return relationship
 
 

tests/unit/model/test_model.py

@@ -34,7 +34,7 @@ def test_model_get_relationship_by_id(empty_model: Model):
 
 
 def test_model_add_relationship_twice_ignored(empty_model: Model):
-    """Make sure that adding an existing relationship to the Model makes no difference."""
+    """Ensure that adding an existing relationship to the Model makes no difference."""
     sys1 = empty_model.add_software_system(name="sys1")
     sys2 = empty_model.add_software_system(name="sys2")
     relationship = empty_model.add_relationship(source=sys1, destination=sys2)
@@ -47,13 +47,11 @@ def test_model_cannot_add_relationship_with_same_id_as_existing(empty_model: Mod
     """Ensure you can't add two relationships with the same ID."""
     sys1 = empty_model.add_software_system(name="sys1")
     sys2 = empty_model.add_software_system(name="sys2")
-    relationship1 = empty_model.add_relationship(source=sys1, destination=sys2, id="r1")
+    empty_model.add_relationship(source=sys1, destination=sys2, id="r1")
     with pytest.raises(
         ValueError, match="Relationship.* has the same ID as Relationship.*"
     ):
-        relationship2 = empty_model.add_relationship(
-            source=sys1, destination=sys2, id="r1"
-        )
+        empty_model.add_relationship(source=sys1, destination=sys2, id="r1")
 
 
 def test_model_cannot_add_relationship_with_same_id_as_element(empty_model: Model):

tests/unit/model/test_model_item.py

@@ -69,7 +69,7 @@ def test_default_and_custom_tags(empty_model: Model):
 
 
 def test_tag_order_is_preserved_to_and_from_io(empty_model: Model):
-    """Test that when serializing via IO classes or back that tag ordering is preserved."""
+    """Test that when serializing via IO classes or back, tag ordering is preserved."""
     element = empty_model.add_software_system(name="Name", description="Description")
     element.tags.update(["tag3", "tag2", "tag1"])  # Deliberately not ascending
 

tests/unit/model/test_software_system.py

@@ -37,7 +37,7 @@ def test_software_system_init(attributes):
 
 
 def test_add_container_accepts_additional_args():
-    """Test other keyword arguments (e.g. id) are allowed when adding a new container."""
+    """Test keyword arguments (e.g. id) are allowed when adding a new container."""
     model = Model()
     system = model.add_software_system(name="Banking System")
     container = system.add_container("container", "description", id="id1")