Added type hint to all submodel attributes (#424)

* Added type hint to all submodel attributes

* Updated CHANGELOG.md

* Fix type hints to include None

Author: FBumann

CHANGELOG.md

@@ -74,6 +74,7 @@ If upgrading from v2.x, see the [v3.0.0 release notes](https://github.com/flixOp
 ### 📝 Docs
 
 ### 👷 Development
+- Added type hints for submodel in all Interface classes
 
 ### 🚧 Known Issues
 

flixopt/calculation.py

@@ -53,6 +53,8 @@ class for defined way of solving a flow_system optimization
         active_timesteps: Deprecated. Use FlowSystem.sel(time=...) or FlowSystem.isel(time=...) instead.
     """
 
+    model: FlowSystemModel | None
+
     def __init__(
         self,
         name: str,
@@ -87,7 +89,7 @@ def __init__(
         flow_system._used_in_calculation = True
 
         self.flow_system = flow_system
-        self.model: FlowSystemModel | None = None
+        self.model = None
 
         self.durations = {'modeling': 0.0, 'solving': 0.0, 'saving': 0.0}
         self.folder = pathlib.Path.cwd() / 'results' if folder is None else pathlib.Path(folder)

flixopt/components.py

@@ -161,6 +161,8 @@ class LinearConverter(Component):
 
     """
 
+    submodel: LinearConverterModel | None
+
     def __init__(
         self,
         label: str,
@@ -377,6 +379,8 @@ class Storage(Component):
         With flow rates in m3/h, the charge state is therefore in m3.
     """
 
+    submodel: StorageModel | None
+
     def __init__(
         self,
         label: str,
@@ -650,6 +654,8 @@ class Transmission(Component):
 
     """
 
+    submodel: TransmissionModel | None
+
     def __init__(
         self,
         label: str,

flixopt/effects.py

@@ -160,6 +160,8 @@ class Effect(Element):
 
     """
 
+    submodel: EffectModel | None
+
     def __init__(
         self,
         label: str,
@@ -454,12 +456,14 @@ class EffectCollection(ElementContainer[Effect]):
     Handling all Effects
     """
 
+    submodel: EffectCollectionModel | None
+
     def __init__(self, *effects: Effect):
         super().__init__(element_type_name='effects')
         self._standard_effect: Effect | None = None
         self._objective_effect: Effect | None = None
 
-        self.submodel: EffectCollectionModel | None = None
+        self.submodel = None
         self.add_effects(*effects)
 
     def create_model(self, model: FlowSystemModel) -> EffectCollectionModel:

flixopt/elements.py

@@ -223,6 +223,8 @@ class Bus(Element):
         by the FlowSystem during system setup.
     """
 
+    submodel: BusModel | None
+
     def __init__(
         self,
         label: str,
@@ -411,6 +413,8 @@ class Flow(Element):
 
     """
 
+    submodel: FlowModel | None
+
     def __init__(
         self,
         label: str,

flixopt/flow_system.py

@@ -143,6 +143,8 @@ class FlowSystem(Interface, CompositeContainerMixin[Element]):
           connected_and_transformed automatically when trying to solve a calculation.
     """
 
+    model: FlowSystemModel | None
+
     def __init__(
         self,
         timesteps: pd.DatetimeIndex,

flixopt/results.py

@@ -148,6 +148,8 @@ class CalculationResults(CompositeContainerMixin['ComponentResults | BusResults
 
     """
 
+    model: linopy.Model | None
+
     @classmethod
     def from_file(cls, folder: str | pathlib.Path, name: str) -> CalculationResults:
         """Load CalculationResults from saved files.

flixopt/structure.py

@@ -850,6 +850,8 @@ def __deepcopy__(self, memo):
 class Element(Interface):
     """This class is the basic Element of flixopt. Every Element has a label"""
 
+    submodel: ElementModel | None
+
     def __init__(self, label: str, meta_data: dict | None = None):
         """
         Args:
@@ -858,7 +860,7 @@ def __init__(self, label: str, meta_data: dict | None = None):
         """
         self.label = Element._valid_label(label)
         self.meta_data = meta_data if meta_data is not None else {}
-        self.submodel: ElementModel | None = None
+        self.submodel = None
 
     def _plausibility_checks(self) -> None:
         """This function is used to do some basic plausibility checks for each Element during initialization.