Add Type Hints for cadCAD objects (#313)

* add types.py
cadCAD-org · Dec 14, 2023 · 0a291e8 · 0a291e8
1 parent b9d2918
commit 0a291e8
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/cadCAD/types.py b/cadCAD/types.py
@@ -0,0 +1,18 @@
+from typing import TypedDict, Callable, Union, Dict, List, Tuple
+
+State = Dict[str, object]
+Parameters = Dict[str, object]
+Substep = int
+StateHistory = List[List[State]]
+PolicyOutput = Dict[str, object]
+StateVariable = object
+
+PolicyFunction = Callable[[Parameters, Substep, StateHistory, State], PolicyOutput]
+StateUpdateFunction = Callable[[Parameters, Substep, StateHistory, State, PolicyOutput], Tuple[str, StateVariable]]
+
+class StateUpdateBlock(TypedDict):
+    policies: Dict[str, PolicyFunction]
+    variables: Dict[str, StateUpdateFunction]
+
+
+StateUpdateBlocks = List[StateUpdateBlock]