Skip to content

Commit e7b9d6f

Browse files
committed
[ModelicaSystem] add/update type hints for get*() functions
1 parent 42c4f87 commit e7b9d6f

1 file changed

Lines changed: 28 additions & 7 deletions

File tree

OMPython/ModelicaSystem.py

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,10 @@ def getQuantities(self, names: Optional[str | list[str]] = None) -> list[dict]:
685685

686686
raise ModelicaSystemError("Unhandled input for getQuantities()")
687687

688-
def getContinuous(self, names: Optional[str | list[str]] = None):
688+
def getContinuous(
689+
self,
690+
names: Optional[str | list[str]] = None,
691+
) -> dict[str, str | numbers.Real] | list[str | numbers.Real]:
689692
"""Get values of continuous signals.
690693
691694
If called before simulate(), the initial values are returned as
@@ -757,7 +760,10 @@ def getContinuous(self, names: Optional[str | list[str]] = None):
757760

758761
raise ModelicaSystemError("Unhandled input for getContinous()")
759762

760-
def getParameters(self, names: Optional[str | list[str]] = None) -> dict[str, str] | list[str]: # 5
763+
def getParameters(
764+
self,
765+
names: Optional[str | list[str]] = None,
766+
) -> dict[str, str] | list[str]:
761767
"""Get parameter values.
762768
763769
Args:
@@ -788,7 +794,10 @@ def getParameters(self, names: Optional[str | list[str]] = None) -> dict[str, st
788794

789795
raise ModelicaSystemError("Unhandled input for getParameters()")
790796

791-
def getInputs(self, names: Optional[str | list[str]] = None) -> dict | list: # 6
797+
def getInputs(
798+
self,
799+
names: Optional[str | list[str]] = None,
800+
) -> dict[str, list[tuple[numbers.Real]]] | list[tuple[numbers.Real]]:
792801
"""Get values of input signals.
793802
794803
Args:
@@ -822,7 +831,10 @@ def getInputs(self, names: Optional[str | list[str]] = None) -> dict | list: #
822831

823832
raise ModelicaSystemError("Unhandled input for getInputs()")
824833

825-
def getOutputs(self, names: Optional[str | list[str]] = None): # 7
834+
def getOutputs(
835+
self,
836+
names: Optional[str | list[str]] = None,
837+
) -> dict[str, str | numbers.Real] | list[str | numbers.Real]:
826838
"""Get values of output signals.
827839
828840
If called before simulate(), the initial values are returned as
@@ -890,7 +902,10 @@ def getOutputs(self, names: Optional[str | list[str]] = None): # 7
890902

891903
raise ModelicaSystemError("Unhandled input for getOutputs()")
892904

893-
def getSimulationOptions(self, names: Optional[str | list[str]] = None) -> dict[str, str] | list[str]:
905+
def getSimulationOptions(
906+
self,
907+
names: Optional[str | list[str]] = None,
908+
) -> dict[str, str] | list[str]:
894909
"""Get simulation options such as stopTime and tolerance.
895910
896911
Args:
@@ -924,7 +939,10 @@ def getSimulationOptions(self, names: Optional[str | list[str]] = None) -> dict[
924939

925940
raise ModelicaSystemError("Unhandled input for getSimulationOptions()")
926941

927-
def getLinearizationOptions(self, names: Optional[str | list[str]] = None) -> dict | list:
942+
def getLinearizationOptions(
943+
self,
944+
names: Optional[str | list[str]] = None,
945+
) -> dict[str, str | numbers.Real] | list[str | numbers.Real]:
928946
"""Get simulation options used for linearization.
929947
930948
Args:
@@ -959,7 +977,10 @@ def getLinearizationOptions(self, names: Optional[str | list[str]] = None) -> di
959977

960978
raise ModelicaSystemError("Unhandled input for getLinearizationOptions()")
961979

962-
def getOptimizationOptions(self, names: Optional[str | list[str]] = None) -> dict | list:
980+
def getOptimizationOptions(
981+
self,
982+
names: Optional[str | list[str]] = None,
983+
) -> dict[str, str | numbers.Real] | list[str | numbers.Real]:
963984
"""Get simulation options used for optimization.
964985
965986
Args:

0 commit comments

Comments
 (0)