Refine link getter api

2022-09-22 22:14:17 +08:00
parent 9905d7f022
commit 6f088bb291
6 changed files with 135 additions and 157 deletions
--- a/api/init.py
+++ b/api/init.py
@@ -35,17 +35,16 @@ from .s4_tanks import get_tank_property_names, get_tank_properties

 from .s5_pipes import PIPE_STATUS_OPEN, PIPE_STATUS_CLOSED, PIPE_STATUS_CV
 from .s5_pipes import add_pipe, delete_pipe
-from .s5_pipes import get_pipe_node1, get_pipe_node2, get_pipe_length, get_pipe_diameter, get_pipe_roughness, get_pipe_minor_loss, get_pipe_status
 from .s5_pipes import set_pipe_node1, set_pipe_node2, set_pipe_length, set_pipe_diameter, set_pipe_roughness, set_pipe_minor_loss, set_pipe_status
+from .s5_pipes import get_pipe_property_names, get_pipe_properties

 from .s6_pumps import add_pump, delete_pump
-from .s6_pumps import get_pump_node1, get_pump_node2
 from .s6_pumps import set_pump_node1, set_pump_node2
-# TODO: more properties...
+from .s6_pumps import get_pump_property_names, get_pump_properties

 from .s7_valves import VALVES_TYPE_PRV, VALVES_TYPE_PSV, VALVES_TYPE_PBV, VALVES_TYPE_FCV, VALVES_TYPE_TCV, VALVES_TYPE_GPV
 from .s7_valves import add_valve, delete_valve
-from .s7_valves import get_valve_node1, get_valve_node2, get_valve_diameter, get_valve_type, get_valve_setting, get_valve_minor_loss
 from .s7_valves import set_valve_node1, set_valve_node2, set_valve_diameter, set_valve_type, set_valve_setting, set_valve_minor_loss
+from .s7_valves import get_valve_property_names, get_valve_properties

 # from .s24_coordinates import get_node_coord, set_node_coord
--- a/api/s5_pipes.py
+++ b/api/s5_pipes.py
@@ -1,3 +1,4 @@
+from typing import Any
 from psycopg.rows import Row
 from .s0_base import *
 from .change_set import ChangeSet
@@ -45,41 +46,16 @@ def delete_pipe(name: str, id: str) -> ChangeSet:
    return delete_link(name, PIPE, id, sql, undo_sql)


-def get_pipe_node1(name: str, id: str) -> str | None:
+def _get_pipe_node1(name: str, id: str) -> str | None:
    row = _get_pipe(name, id)
    return row['node1'] if row != None else None


-def get_pipe_node2(name: str, id: str) -> str | None:
+def _get_pipe_node2(name: str, id: str) -> str | None:
    row = _get_pipe(name, id)
    return row['node2'] if row != None else None


-def get_pipe_length(name: str, id: str) -> float | None:
-    row = _get_pipe(name, id)
-    return float(row['length']) if row != None else None
-
-
-def get_pipe_diameter(name: str, id: str) -> float | None:
-    row = _get_pipe(name, id)
-    return float(row['diameter']) if row != None else None
-
-
-def get_pipe_roughness(name: str, id: str) -> float | None:
-    row = _get_pipe(name, id)
-    return float(row['roughness']) if row != None else None
-
-
-def get_pipe_minor_loss(name: str, id: str) -> float | None:
-    row = _get_pipe(name, id)
-    return float(row['minor_loss']) if row != None else None
-
-
-def get_pipe_status(name: str, id: str) -> str | None:
-    row = _get_pipe(name, id)
-    return row['status'] if row != None else None
-
-
 def _set_pipe(name: str, id: str, key: str, key_type: str, value: str, optional: bool = False) -> ChangeSet:
    if not is_pipe(name, id):
        return ChangeSet()
@@ -94,7 +70,7 @@ def _set_pipe(name: str, id: str, key: str, key_type: str, value: str, optional:
 def set_pipe_node1(name: str, id: str, node1: str) -> ChangeSet:
    if not is_node(name, node1):
        return ChangeSet()
-    if get_pipe_node2(name, id) == node1:
+    if _get_pipe_node2(name, id) == node1:
        return ChangeSet()

    return _set_pipe(name, id, 'node1', 'str', str(node1))
@@ -103,7 +79,7 @@ def set_pipe_node1(name: str, id: str, node1: str) -> ChangeSet:
 def set_pipe_node2(name: str, id: str, node2: str) -> ChangeSet:
    if not is_node(name, node2):
        return ChangeSet()
-    if get_pipe_node1(name, id) == node2:
+    if _get_pipe_node1(name, id) == node2:
        return ChangeSet()

    return _set_pipe(name, id, 'node2', 'str', str(node2))
@@ -130,3 +106,23 @@ def set_pipe_status(name: str, id: str, status: float) -> ChangeSet:
        return ChangeSet()

    return _set_pipe(name, id, 'status', 'str', str(status))
+
+
+def get_pipe_property_names(name: str) -> list[str]:
+    return ['node1', 'node2', 'length', 'diameter', 'roughness', 'minor_loss', 'status']
+
+
+def get_pipe_properties(name: str, id: str) -> dict[str, Any] | None:
+    row = _get_pipe(name, id)
+    if row == None:
+        return None
+
+    ps: dict[str, str] = {}
+    ps['node1'] = row['node1'] if row != None else None
+    ps['node2'] = row['node2'] if row != None else None
+    ps['length'] = float(row['length']) if row != None else None
+    ps['diameter'] = float(row['diameter']) if row != None else None
+    ps['roughness'] = float(row['roughness']) if row != None else None
+    ps['minor_loss'] = float(row['minor_loss']) if row != None else None
+    ps['status'] = row['status'] if row != None else None
+    return ps
--- a/api/s6_pumps.py
+++ b/api/s6_pumps.py
@@ -1,3 +1,4 @@
+from typing import Any
 from psycopg.rows import Row
 from .s0_base import *
 from .change_set import ChangeSet
@@ -37,22 +38,16 @@ def delete_pump(name: str, id: str) -> ChangeSet:
    return delete_link(name, PUMP, id, sql, undo_sql)


-def get_pump_node1(name: str, id: str) -> str | None:
+def _get_pump_node1(name: str, id: str) -> str | None:
    row = _get_pump(name, id)
    return row['node1'] if row != None else None


-def get_pump_node2(name: str, id: str) -> str | None:
+def _get_pump_node2(name: str, id: str) -> str | None:
    row = _get_pump(name, id)
    return row['node2'] if row != None else None


-def get_pump_power(name: str, id: str) -> str | None: pass
-def get_pump_speed(name: str, id: str) -> str | None: pass
-def get_pump_head(name: str, id: str) -> str | None: pass
-def get_pump_pattern(name: str, id: str) -> str | None: pass
-
-
 def _set_pump(name: str, id: str, key: str, key_type: str, value: str, optional: bool = False) -> ChangeSet:
    if not is_pump(name, id):
        return ChangeSet()
@@ -67,7 +62,7 @@ def _set_pump(name: str, id: str, key: str, key_type: str, value: str, optional:
 def set_pump_node1(name: str, id: str, node1: str) -> ChangeSet:
    if not is_node(name, node1):
        return ChangeSet()
-    if get_pump_node2(name, id) == node1:
+    if _get_pump_node2(name, id) == node1:
        return ChangeSet()

    return _set_pump(name, id, 'node1', 'str', str(node1))
@@ -76,7 +71,7 @@ def set_pump_node1(name: str, id: str, node1: str) -> ChangeSet:
 def set_pump_node2(name: str, id: str, node2: str) -> ChangeSet:
    if not is_node(name, node2):
        return ChangeSet()
-    if get_pump_node1(name, id) == node2:
+    if _get_pump_node1(name, id) == node2:
        return ChangeSet()

    return _set_pump(name, id, 'node2', 'str', str(node2))
@@ -86,3 +81,18 @@ def set_pump_power(name: str, id: str) -> ChangeSet: pass
 def set_pump_speed(name: str, id: str) -> ChangeSet: pass
 def set_pump_head(name: str, id: str) -> ChangeSet: pass
 def set_pump_pattern(name: str, id: str) -> ChangeSet: pass
+
+
+def get_pump_property_names(name: str) -> list[str]:
+    return ['node1', 'node2']
+
+
+def get_pump_properties(name: str, id: str) -> dict[str, Any] | None:
+    row = _get_pump(name, id)
+    if row == None:
+        return None
+
+    ps: dict[str, str] = {}
+    ps['node1'] = row['node1'] if row != None else None
+    ps['node2'] = row['node2'] if row != None else None
+    return ps
--- a/api/s7_valves.py
+++ b/api/s7_valves.py
@@ -1,3 +1,4 @@
+from typing import Any
 from psycopg.rows import Row
 from .s0_base import *
 from .change_set import ChangeSet
@@ -47,36 +48,16 @@ def delete_valve(name: str, id: str) -> ChangeSet:
    return delete_link(name, VALVE, id, sql, undo_sql)


-def get_valve_node1(name: str, id: str) -> str | None:
+def _get_valve_node1(name: str, id: str) -> str | None:
    row = _get_valve(name, id)
    return row['node1'] if row != None else None


-def get_valve_node2(name: str, id: str) -> str | None:
+def _get_valve_node2(name: str, id: str) -> str | None:
    row = _get_valve(name, id)
    return row['node2'] if row != None else None


-def get_valve_diameter(name: str, id: str) -> float | None:
-    row = _get_valve(name, id)
-    return float(row['diameter']) if row != None else None
-
-
-def get_valve_type(name: str, id: str) -> str | None:
-    row = _get_valve(name, id)
-    return row['type'] if row != None else None
-
-
-def get_valve_setting(name: str, id: str) -> float | None:
-    row = _get_valve(name, id)
-    return float(row['setting']) if row != None else None
-
-
-def get_valve_minor_loss(name: str, id: str) -> float | None:
-    row = _get_valve(name, id)
-    return float(row['minor_loss']) if row != None else None
-
-
 def _set_valve(name: str, id: str, key: str, key_type: str, value: str, optional: bool = False) -> ChangeSet:
    if not is_valve(name, id):
        return ChangeSet()
@@ -91,7 +72,7 @@ def _set_valve(name: str, id: str, key: str, key_type: str, value: str, optional
 def set_valve_node1(name: str, id: str, node1: str) -> ChangeSet:
    if not is_node(name, node1):
        return ChangeSet()
-    if get_valve_node2(name, id) == node1:
+    if _get_valve_node2(name, id) == node1:
        return ChangeSet()

    return _set_valve(name, id, 'node1', 'str', str(node1))
@@ -100,7 +81,7 @@ def set_valve_node1(name: str, id: str, node1: str) -> ChangeSet:
 def set_valve_node2(name: str, id: str, node2: str) -> ChangeSet:
    if not is_node(name, node2):
        return ChangeSet()
-    if get_valve_node1(name, id) == node2:
+    if _get_valve_node1(name, id) == node2:
        return ChangeSet()

    return _set_valve(name, id, 'node2', 'str', str(node2))
@@ -123,3 +104,22 @@ def set_valve_setting(name: str, id: str, setting: float) -> ChangeSet:

 def set_valve_minor_loss(name: str, id: str, minor_loss: float) -> ChangeSet:
    return _set_valve(name, id, 'minor_loss', 'float', str(minor_loss))
+
+
+def get_valve_property_names(name: str) -> list[str]:
+    return ['node1', 'node2', 'diameter', 'type', 'setting', 'minor_loss']
+
+
+def get_valve_properties(name: str, id: str) -> dict[str, Any] | None:
+    row = _get_valve(name, id)
+    if row == None:
+        return None
+
+    ps: dict[str, str] = {}
+    ps['node1'] = row['node1'] if row != None else None
+    ps['node2'] = row['node2'] if row != None else None
+    ps['diameter'] = float(row['diameter']) if row != None else None
+    ps['type'] = row['type'] if row != None else None
+    ps['setting'] = float(row['setting']) if row != None else None
+    ps['minor_loss'] = float(row['minor_loss']) if row != None else None
+    return ps