add prefixes to avoid hard coding, error naming changes, fixed bug in add_pvsystem

Author: amzhao16

pygridsim/core.py

@@ -4,6 +4,7 @@
 from pygridsim.lines import _make_line
 from pygridsim.parameters import _make_generator, _make_load_node, _make_pv, _make_source_node
 from pygridsim.results import _export_results, _query_solution
+from pygridsim.defaults import RESERVED_PREFIXES
 
 """Main module."""
 
@@ -21,6 +22,7 @@ def __init__(self):
             num_transformers (int): Number of transformers in circuit so far.
             num_pv (int): Number of PV systems in circuit so far.
             num_generators (int): Number generators in circuit so far.
+            nickname_to_name (dict[str, str]): Map containing nicknames to their internal names.
         """
         self.num_loads = 0
         self.num_lines = 0
@@ -33,10 +35,9 @@ def __init__(self):
 
     def _check_naming(self, name):
         if name in self.nickname_to_name:
-            raise NameError("Provided name already assigned to a node")
-        if name.startswith("load") or name.startswith(
-                "generator") or name == "source" or name.startswith("pv"):
-            raise NameError(
+            raise ValueError("Provided name already assigned to a node")
+        if any(name.startswith(prefix) for prefix in RESERVED_PREFIXES):
+            raise ValueError(
                 "Cannot name nodes of the format 'component + __', ambiguity with internal names")
 
     def add_load_nodes(self,
@@ -127,7 +128,7 @@ def add_PVSystems(self, load_nodes: list[str],
         PV_nodes = []
         for load in load_nodes:
             if (load in self.nickname_to_name):
-                self.nickname_to_name[load]
+                load = self.nickname_to_name[load]
 
             PV_nodes.append(_make_pv(load, params, num_panels, self.num_pv))
             self.num_pv += 1

pygridsim/defaults.py

@@ -75,3 +75,5 @@
 VALID_LINE_TRANSFORMER_PARAMS = ["length", "XHL", "Conns"]
 VALID_PV_PARAMS = ["kV", "phases"]
 VALID_GENERATOR_PARAMS = ["kV", "kW", "phases"]
+
+RESERVED_PREFIXES = ["load", "generator", "pv", "source"]

tests/test_circuit.py

@@ -174,11 +174,11 @@ def test_012_node_naming(self):
         # Can use original or abbreviated name
         circuit.add_lines(connections=[("G0", "0"), ("generator1", "load1")])
 
-        with self.assertRaises(NameError):
+        with self.assertRaises(ValueError):
             # Tries to assign an already assigned name
             circuit.add_load_nodes(num=1, names=["G1"])
 
-        with self.assertRaises(NameError):
+        with self.assertRaises(ValueError):
             # Tries to assign name to internal name load1, errors because adds ambiguity
             circuit.add_load_nodes(num=1, names=["load1"])