Refactoring code

Author: eniocc

requirements.txt

@@ -1,6 +1,14 @@
-numpy==1.22
-pandas==1.4.3
-pytest~=6.2.3
-setuptools~=56.0.0
-
-colorama~=0.4.4
+attrs==22.2.0
+colorama==0.4.6
+comtypes==1.1.14
+exceptiongroup==1.1.0
+iniconfig==2.0.0
+numpy==1.24.2
+packaging==23.0
+pandas==1.5.3
+pluggy==1.0.0
+pytest==7.2.1
+python-dateutil==2.8.2
+pytz==2022.7.1
+six==1.16.0
+tomli==2.0.1

src/py_dss_interface/models/ActiveClass/ActiveClass.py

@@ -13,43 +13,63 @@
 
 @dataclass
 class ActiveClass(ActiveClassS, ActiveClassI, ActiveClassV):
-    """This interface implements the ActiveClass (IActiveClass) interface of OpenDSS by declaring 3 procedures for
-    accessing the different properties included in this interface: ActiveClassS, ActiveClassI, ActiveClassV. Ih the
-    original paper Davis cited that are 4 procedures, but only 3 were described."""
+    """This class implements the ActiveClass interface of OpenDSS.
+
+    The ActiveClass interface provides methods for accessing properties of DSS classes.
+    This class defines the methods for accessing the different properties included in this interface:
+    ActiveClassS, ActiveClassI, ActiveClassV.
+
+    Args:
+        obj_dss: The COM object that provides access to the OpenDSS engine.
+    """
 
     def __init__(self, obj_dss):
         super().__init__(obj_dss)
 
     def first(self) -> int:
+        """Sets first element in the active class to be the active DSS object.
+        If object is a CktElement, ActiveCktElement also points to this element.
+        Returns 0 if none."""
         return ActiveClassI._first(self)
 
     def next(self) -> int:
+        """Sets next element in the active class to be the active DSS object.
+        If object is a CktElement, ActiveCktElement also points to this element.
+        Returns 0 if none."""
         return ActiveClassI._next(self)
 
     @property
     def num_elements(self) -> int:
+        """Gets the number of elements in this class. Same as Count Property."""
         return ActiveClassI._num_elements(self)
 
     @property
     def count(self) -> int:
+        """Gets the number of elements in this class. Same as NumElements Property."""
         return ActiveClassI._count(self)
 
     @property
     def name(self) -> str:
+        """Gets the name of the active Element of the Active class."""
         return ActiveClassS._name(self)
 
     @name.setter
     def name(self, argument: str):
+        """Sets the name of the active Element of the Active class."""
         ActiveClassS._name_write(self, argument)
 
     @property
     def class_name(self) -> str:
+        """Gets the name of the active Element's class."""
         return ActiveClassS._class_name(self)
 
     @property
     def parent_class_name(self) -> str:
+        """Gets the name of the Parent Element of the Active class."""
         return ActiveClassS._parent_class_name(self)
 
     @property
     def names(self) -> List[str]:
+        """Gets a list of all element names in the active Class."""
         return ActiveClassV._names(self)
+

src/py_dss_interface/models/ActiveClass/ActiveClassI.py

@@ -20,18 +20,31 @@ class ActiveClassI(Base):
 
     def _count(self) -> int:
         """Gets the number of elements in this class. Same as NumElements Property."""
-        return self.dss_obj.ActiveClassI(3, 0)
+        try:
+            return self.dss_obj.ActiveClassI(3, 0)
+        except Exception as e:
+            raise Exception(f"Error in _count: {e}")
 
     def _first(self) -> int:
         """Sets first element in the active class to be the active DSS object. If object is a CktElement,
         ActiveCktElement also points to this element. Returns 0 if none."""
-        return self.dss_obj.ActiveClassI(0, 0)
+        try:
+            return self.dss_obj.ActiveClassI(0, 0)
+        except Exception as e:
+            raise Exception(f"Error in _first: {e}")
 
     def _next(self) -> int:
         """Sets next element in the active class to be the active DSS object.
         If object is a CktElement, ActiveCktElement also points to this element. Returns 0 if none."""
-        return self.dss_obj.ActiveClassI(1, 0)
+        try:
+            return self.dss_obj.ActiveClassI(1, 0)
+        except Exception as e:
+            raise Exception(f"Error in _next: {e}")
 
     def _num_elements(self) -> int:
         """Gets the number of elements in this class. Same as Count Property."""
-        return self.dss_obj.ActiveClassI(2, 0)
+        try:
+            return self.dss_obj.ActiveClassI(2, 0)
+        except Exception as e:
+            raise Exception(f"Error in _num_elements: {e}")
+

src/py_dss_interface/models/ActiveClass/ActiveClassS.py

@@ -22,16 +22,28 @@ class ActiveClassS(Base):
 
     def _class_name(self) -> str:
         """Sets the name of the active Element of the Active class."""
-        return (self.dss_obj.ActiveClassS(2, 0)).decode('ascii')
+        try:
+            return (self.dss_obj.ActiveClassS(2, 0)).decode('ascii')
+        except Exception as e:
+            raise Exception(f"Error in _class_name: {e}")
 
     def _name(self) -> str:
         """Gets the name of the active Element of the Active class."""
-        return (self.dss_obj.ActiveClassS(0, 0)).decode('ascii')
+        try:
+            return (self.dss_obj.ActiveClassS(0, 0)).decode('ascii')
+        except Exception as e:
+            raise Exception(f"Error in _name: {e}")
 
     def _name_write(self, argument) -> str:
         """Sets the name of the active Element of the Active class. """
-        return (self.dss_obj.ActiveClassS(1, argument.encode('ascii'))).decode('ascii')
+        try:
+            return (self.dss_obj.ActiveClassS(1, argument.encode('ascii'))).decode('ascii')
+        except Exception as e:
+            raise Exception(f"Error in _name_write: {e}")
 
     def _parent_class_name(self) -> str:
         """Gets the name of the Parent Element of the Active class."""
-        return (self.dss_obj.ActiveClassS(3, 0)).decode('ascii')
+        try:
+            return (self.dss_obj.ActiveClassS(3, 0)).decode('ascii')
+        except Exception as e:
+            raise Exception(f"Error in _parent_class_name: {e}")

src/py_dss_interface/models/ActiveClass/ActiveClassV.py

@@ -25,4 +25,7 @@ class ActiveClassV(Base):
     def _names(self) -> List[str]:
         """Gets a variant array of strings consisting of all element names in the active Class."""
         # return Bridge.var_array_function(self.dss_obj.ActiveClassV, 0, None, '')
-        return Bridge.variant_pointer_read(self.dss_obj.ActiveClassV, 0)
+        try:
+            return Bridge.variant_pointer_read(self.dss_obj.ActiveClassV, 0)
+        except Exception as e:
+            raise Exception(f"Error while retrieving element names: {e}")

tests/py_dss_interface/conftest.py

@@ -17,7 +17,7 @@
 
 @pytest.fixture(scope='function')
 def solve_snap_13bus():
-    dss = py_dss_interface.DSS("C:\OpenDSS_rep\Version8\Source")
+    dss = py_dss_interface.DSS(r"C:\OpenDSS")
 
     dss.text("set DefaultBaseFrequency=60")
     dss13_path = os.path.join(pathlib.Path(script_path), "cases", "13Bus", "IEEE13Nodeckt.dss")