Refine node getter api

api/__init__.py

@@ -16,21 +16,22 @@ from .s0_base import is_link, is_pipe, is_pump, is_valve
 from .s0_base import is_curve
 from .s0_base import is_pattern
 from .s0_base import get_nodes, get_links, get_curves, get_patterns
+from .s0_base import get_node_links
 
 from .s1_title import set_title, get_title
 
 from .s2_junctions import add_junction, delete_junction
-from .s2_junctions import get_junction_elevation, get_junction_demand, get_junction_pattern, get_junction_coord
 from .s2_junctions import set_junction_elevation, set_junction_demand, set_junction_pattern, set_junction_coord
+from .s2_junctions import get_junction_property_names, get_junction_properties
 
 from .s3_reservoirs import add_reservoir, delete_reservoir
-from .s3_reservoirs import get_reservoir_head, get_reservoir_pattern, get_reservoir_coord
 from .s3_reservoirs import set_reservoir_head, set_reservoir_pattern, set_reservoir_coord
+from .s3_reservoirs import get_reservoir_property_names, get_reservoir_properties
 
 from .s4_tanks import OVERFLOW_YES, OVERFLOW_NO
 from .s4_tanks import add_tank, delete_tank
-from .s4_tanks import get_tank_elevation, get_tank_init_level, get_tank_min_level, get_tank_max_level, get_tank_diameter, get_tank_min_vol, get_tank_vol_curve, get_tank_overflow, get_tank_coord
 from .s4_tanks import set_tank_elevation, set_tank_init_level, set_tank_min_level, set_tank_max_level, set_tank_diameter, set_tank_min_vol, set_tank_vol_curve, set_tank_overflow, set_tank_coord
+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

api/s2_junctions.py

@@ -1,3 +1,4 @@
+from typing import Any
 from psycopg.rows import Row
 from .s0_base import *
 from .change_set import ChangeSet
@@ -33,31 +34,6 @@ def delete_junction(name: str, id: str) -> ChangeSet:
     return delete_node(name, JUNCTION, id, sql, undo_sql)
 
 
-def get_junction_elevation(name: str, id: str) -> float | None:
-    row = _get_junction(name, id)
-    return float(row['elevation']) if row != None else None
-
-
-def get_junction_demand(name: str, id: str) -> float | str | None:
-    row = _get_junction(name, id)
-    if row != None:
-        return float(row['demand']) if row['demand'] != None else 'NULL'
-    else:
-        return None
-
-
-def get_junction_pattern(name: str, id: str) -> str | None:
-    row = _get_junction(name, id)
-    if row != None:
-        return row['pattern'] if row['pattern'] != None else 'NULL'
-    else:
-        return None
-
-
-def get_junction_coord(name: str, id: str) -> dict[str, float] | None:
-    return get_node_coord(name, id)
-
-
 def _set_junction(name: str, id: str, key: str, key_type: str, value: str, optional: bool = False) -> ChangeSet:
     if not is_junction(name, id):
         return ChangeSet()
@@ -89,3 +65,21 @@ def set_junction_coord(name: str, id: str, x: float, y: float) -> ChangeSet:
         return ChangeSet()
 
     return set_node_coord(name, JUNCTION, id, x, y)
+
+
+def get_junction_property_names(name: str) -> list[str]:
+    return ['elevation', 'demand', 'pattern', 'coord', 'links']
+
+
+def get_junction_properties(name: str, id: str) -> dict[str, Any] | None:
+    row = _get_junction(name, id)
+    if row == None:
+        return None
+
+    ps: dict[str, str] = {}
+    ps['elevation'] = float(row['elevation'])
+    ps['demand'] = float(row['demand']) if row != None and row['demand'] != None else None 
+    ps['pattern'] = row['pattern'] if row != None and row['pattern'] != None else None
+    ps['coord'] = get_node_coord(name, id)
+    ps['links'] = get_node_links(name, id)
+    return ps

api/s3_reservoirs.py

@@ -1,3 +1,4 @@
+from typing import Any
 from psycopg.rows import Row
 from .s0_base import *
 from .change_set import ChangeSet
@@ -32,23 +33,6 @@ def delete_reservoir(name: str, id: str) -> ChangeSet:
     return delete_node(name, RESERVOIR, id, sql, undo_sql)
 
 
-def get_reservoir_head(name: str, id: str) -> float | None:
-    row = _get_reservoir(name, id)
-    return float(row['head']) if row != None else None
-
-
-def get_reservoir_pattern(name: str, id: str) -> str | None:
-    row = _get_reservoir(name, id)
-    if row != None:
-        return row['pattern'] if row['pattern'] != None else 'NULL'
-    else:
-        return None
-
-
-def get_reservoir_coord(name: str, id: str) -> dict[str, float] | None:
-    return get_node_coord(name, id)
-
-
 def _set_reservoir(name: str, id: str, key: str, key_type: str, value: str, optional: bool = False) -> ChangeSet:
     if not is_reservoir(name, id):
         return ChangeSet()
@@ -76,3 +60,20 @@ def set_reservoir_coord(name: str, id: str, x: float, y: float) -> ChangeSet:
         return ChangeSet()
 
     return set_node_coord(name, RESERVOIR, id, x, y)
+
+
+def get_reservoir_property_names(name: str) -> list[str]:
+    return ['head', 'pattern', 'coord']
+
+
+def get_reservoir_properties(name: str, id: str) -> dict[str, Any] | None:
+    row = _get_reservoir(name, id)
+    if row == None:
+        return None
+
+    ps: dict[str, str] = {}
+    ps['head'] = float(row['head']) if row != None else None
+    ps['pattern'] = row['pattern'] if row != None and row['pattern'] != None else None
+    ps['coord'] = get_node_coord(name, id)
+    ps['links'] = get_node_links(name, id)
+    return ps

api/s4_tanks.py

@@ -1,3 +1,4 @@
+from typing import Any
 from psycopg.rows import Row
 from .s0_base import *
 from .change_set import ChangeSet
@@ -42,56 +43,6 @@ def delete_tank(name: str, id: str) -> ChangeSet:
     return delete_node(name, TANK, id, sql, undo_sql)
 
 
-def get_tank_elevation(name: str, id: str) -> float | None:
-    row = _get_tank(name, id)
-    return float(row['elevation']) if row != None else None
-
-
-def get_tank_init_level(name: str, id: str) -> float | None:
-    row = _get_tank(name, id)
-    return float(row['init_level']) if row != None else None
-
-
-def get_tank_min_level(name: str, id: str) -> float | None:
-    row = _get_tank(name, id)
-    return float(row['min_level']) if row != None else None
-
-
-def get_tank_max_level(name: str, id: str) -> float | None:
-    row = _get_tank(name, id)
-    return float(row['max_level']) if row != None else None
-
-
-def get_tank_diameter(name: str, id: str) -> float | None:
-    row = _get_tank(name, id)
-    return float(row['diameter']) if row != None else None
-
-
-def get_tank_min_vol(name: str, id: str) -> float | None:
-    row = _get_tank(name, id)
-    return float(row['min_vol']) if row != None else None
-
-
-def get_tank_vol_curve(name: str, id: str) -> str | None:
-    row = _get_tank(name, id)
-    if row != None:
-        return row['vol_curve'] if row['vol_curve'] != None else 'NULL'
-    else:
-        return None
-
-
-def get_tank_overflow(name: str, id: str) -> str | None:
-    row = _get_tank(name, id)
-    if row != None:
-        return row['overflow'] if row['overflow'] != None else 'NULL'
-    else:
-        return None
-
-
-def get_tank_coord(name: str, id: str) -> dict[str, float] | None:
-    return get_node_coord(name, id)
-
-
 def _set_tank(name: str, id: str, key: str, key_type: str, value: str, optional: bool = False) -> ChangeSet:
     if not is_tank(name, id):
         return ChangeSet()
@@ -146,3 +97,25 @@ def set_tank_coord(name: str, id: str, x: float, y: float) -> ChangeSet:
         return ChangeSet()
 
     return set_node_coord(name, TANK, id, x, y)
+
+
+def get_tank_property_names(name: str) -> list[str]:
+    return ['elevation', 'init_level', 'min_level', 'max_level', 'diameter', 'min_vol', 'vol_curve', 'overflow', 'coord']
+
+
+def get_tank_properties(name: str, id: str) -> dict[str, Any] | None:
+    row = _get_tank(name, id)
+    if row == None:
+        return None
+
+    ps: dict[str, str] = {}
+    ps['elevation'] = float(row['elevation']) if row != None else None
+    ps['init_level'] = float(row['init_level']) if row != None else None
+    ps['min_level'] = float(row['min_level']) if row != None else None
+    ps['max_level'] = float(row['max_level']) if row != None else None
+    ps['diameter'] = float(row['diameter']) if row != None else None
+    ps['min_vol'] = float(row['min_vol']) if row != None else None
+    ps['vol_curve'] = row['vol_curve'] if row != None and row['vol_curve'] != None else None
+    ps['overflow'] = row['overflow'] if row != None and row['overflow'] != None else None
+    ps['coord'] = get_node_coord(name, id)
+    return ps