renamed files

core/dto/__init__.py

@@ -1,3 +1,4 @@
+"""data_models module content."""
 from __future__ import annotations
 
 from .angle import AngleData
@@ -8,7 +9,6 @@ from .information_value import InformationValueData
 from .modality_color import ModalityColorData
 from .modality_depth import ModalityDepthData
 from .modality_lighting import ModalityLightingData
-from .model_data import ModelData
 from .point_of_view import PointOfViewData
 from .salience import SalienceData
 from .visual_syntax import VisualSyntaxData

core/dto/angle.py

@@ -1,9 +1,11 @@
+"""Definition of Angle data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class AngleData(BaseDataModel):
+class AngleData(DataModel):
+    """Angle data model."""
     high: float
     eye_level: float
     low: float

core/dto/contact.py

@@ -1,8 +1,11 @@
+"""Definition of ContactData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class ContactData(BaseDataModel):
+class ContactData(DataModel):
+    """ContactData data model."""
+
     offer: float
     demand: float

core/dto/data_model.py

@@ -1,3 +1,4 @@
+"""Definition of DataModel base class."""
 from __future__ import annotations
 
 import random
@@ -6,7 +7,8 @@ from pydantic import BaseModel
 from pydantic import ValidationError
 
 
-class BaseDataModel(BaseModel):
+class DataModel(BaseModel):
+    """DataModel base class."""
 
     @classmethod
     def classname(cls) -> str:

core/dto/distance.py

@@ -1,9 +1,12 @@
+"""Definition of DistanceData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class DistanceData(BaseDataModel):
+class DistanceData(DataModel):
+    """DistanceData data model."""
+
     long: float
     medium: float
     close: float

core/dto/framing.py

@@ -1,9 +1,12 @@
+"""Definition of FramingData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class FramingData(BaseDataModel):
+class FramingData(DataModel):
+    """FramingData data model."""
+
     frame_lines: float
     empty_space: float
     colour_contrast: float

core/dto/information_value.py

@@ -1,9 +1,12 @@
+"""Definition of InformationValueData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class InformationValueData(BaseDataModel):
+class InformationValueData(DataModel):
+    """InformationValueData data model."""
+
     given_new: float
     ideal_real: float
     central_marginal: float

core/dto/modality_color.py

@@ -1,9 +1,12 @@
+"""Definition of ModalityColorData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class ModalityColorData(BaseDataModel):
+class ModalityColorData(DataModel):
+    """ModalityColorData data model."""
+
     high: float
     medium: float
     low: float

core/dto/modality_depth.py

@@ -1,9 +1,12 @@
+"""Definition of ModalityDepthData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class ModalityDepthData(BaseDataModel):
+class ModalityDepthData(DataModel):
+    """ModalityDepthData data model."""
+
     high: float
     medium: float
     low: float

core/dto/modality_lighting.py

@@ -1,9 +1,12 @@
+"""Definition of ModalityLightingData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class ModalityLightingData(BaseDataModel):
+class ModalityLightingData(DataModel):
+    """ModalityLightingData data model."""
+
     high: float
     medium: float
     low: float

core/dto/model_data.py

@@ -1,44 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-from .angle import AngleData
-from .contact import ContactData
-from .distance import DistanceData
-from .framing import FramingData
-from .information_value import InformationValueData
-from .modality_color import ModalityColorData
-from .modality_depth import ModalityDepthData
-from .modality_lighting import ModalityLightingData
-from .point_of_view import PointOfViewData
-from .salience import SalienceData
-from .visual_syntax import VisualSyntaxData
-
-
-class ModelData(BaseModel):
-    visual_syntax: VisualSyntaxData
-    contact: ContactData
-    angle: AngleData
-    point_of_view: PointOfViewData
-    distance: DistanceData
-    modality_lighting: ModalityLightingData
-    modality_color: ModalityColorData
-    modality_depth: ModalityDepthData
-    information_value: InformationValueData
-    framing: FramingData
-    salience: SalienceData
-
-    @classmethod
-    def list_fields(cls) -> list[str]:
-        """List options that are stored as attributes."""
-        return list(cls.model_fields.keys())
-
-    @classmethod
-    def from_random(cls) -> ModelData:
-        """Instantiate with random numbers."""
-        kwargs = {
-            field: field_info.annotation.from_random()  # type: ignore
-            for field, field_info
-            in cls.model_fields.items()
-        }
-        return cls(**kwargs)

core/dto/point_of_view.py

@@ -1,8 +1,11 @@
+"""Definition of PointOfViewData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class PointOfViewData(BaseDataModel):
+class PointOfViewData(DataModel):
+    """PointOfViewData data model."""
+
     frontal: float
     oblique: float

core/dto/salience.py

@@ -1,9 +1,12 @@
+"""Definition of SalienceData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class SalienceData(BaseDataModel):
+class SalienceData(DataModel):
+    """SalienceData data model."""
+
     size: float
     colour: float
     tone: float

core/dto/visual_syntax.py

@@ -1,9 +1,12 @@
+"""Definition of VisualSyntaxData data model."""
 from __future__ import annotations
 
-from .base_data_model import BaseDataModel
+from .data_model import DataModel
 
 
-class VisualSyntaxData(BaseDataModel):
+class VisualSyntaxData(DataModel):
+    """VisualSyntaxData data model."""
+
     non_transactional_action: float
     non_transactional_reaction: float
     unidirectional_transactional_action: float