steer-core 0.1.18__py3-none-any.whl → 0.1.20__py3-none-any.whl

steer_core/Decorators/Electrochemical.py

@@ -1,19 +1,16 @@
 from functools import wraps
 
-
 def calculate_half_cell_curve(func):
     """
     Decorator to recalculate half-cell curve properties after a method call.
     This is useful for methods that modify the half-cell curve data.
     """
-
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, "_update_properties") and self._update_properties:
+        if hasattr(self, '_update_properties') and self._update_properties:
             self._calculate_half_cell_curve()
         return result
-
     return wrapper
 
 
@@ -22,12 +19,11 @@ def calculate_half_cell_curves_properties(func):
     Decorator to recalculate half-cell curves properties after a method call.
     This is useful for methods that modify the half-cell curves data.
     """
-
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, "_update_properties") and self._update_properties:
+        if hasattr(self, '_update_properties') and self._update_properties:
             self._calculate_half_cell_curves_properties()
         return result
-
     return wrapper
+

steer_core/Decorators/General.py

@@ -31,3 +31,4 @@ def calculate_all_properties(func):
         return result
 
     return wrapper
+

steer_core/Mixins/Dunder.py

@@ -0,0 +1,164 @@
+
+
+import numpy as np
+
+
+class DunderMixin:
+
+    def _get_comparable_properties(self):
+        """Get all comparable properties from the class hierarchy."""
+        properties = []
+        for cls in self.__class__.__mro__:
+            for name, value in cls.__dict__.items():
+                if isinstance(value, property):
+                    if not self._should_exclude_property(name):
+                        properties.append(name)
+        return properties
+
+    def _should_exclude_property(self, name):
+        """Check if a property should be excluded from comparison."""
+        return (
+            name.endswith('_trace') or
+            name.endswith('_range') or 
+            name in {'last_updated', 'properties'}
+        )
+
+    def _is_plotly_trace(self, obj):
+        """Check if object is a Plotly trace object."""
+        return (
+            hasattr(obj, '__module__') and 
+            obj.__module__ and 
+            obj.__module__.startswith('plotly.graph_objs')
+        )
+
+    def _compare_none_values(self, self_value, other_value):
+        """Compare None values. Returns (should_continue, result)."""
+        if self_value is None and other_value is None:
+            return True, True  # Continue, values are equal
+        elif self_value is None or other_value is None:
+            return False, False  # Stop, values are not equal
+        return True, None  # Continue, not None values
+
+    def _compare_plotly_traces(self, self_value, other_value):
+        """Compare Plotly trace objects. Returns (should_continue, result)."""
+        if self._is_plotly_trace(self_value) or self._is_plotly_trace(other_value):
+            return True, True  # Skip Plotly traces, continue
+        return True, None  # Continue, not Plotly traces
+
+    def _compare_numpy_arrays(self, self_value, other_value):
+        """Compare NumPy arrays. Returns (should_continue, result)."""
+        if isinstance(self_value, np.ndarray) and isinstance(other_value, np.ndarray):
+            return False, np.array_equal(self_value, other_value, equal_nan=True)
+        elif isinstance(self_value, np.ndarray) or isinstance(other_value, np.ndarray):
+            return False, False  # One is numpy array, other is not
+        return True, None  # Continue, not numpy arrays
+
+    def _compare_dataframes(self, self_value, other_value):
+        """Compare pandas DataFrames/Series. Returns (should_continue, result)."""
+        if hasattr(self_value, 'equals') and hasattr(other_value, 'equals'):
+            return False, self_value.equals(other_value)
+        elif hasattr(self_value, 'equals') or hasattr(other_value, 'equals'):
+            return False, False  # Only one is a DataFrame/Series
+        return True, None  # Continue, not DataFrames
+
+    def _compare_dictionaries(self, self_value, other_value):
+        """Compare dictionaries by comparing keys and values separately. Returns (should_continue, result)."""
+        if isinstance(self_value, dict) and isinstance(other_value, dict):
+            # Compare keys first (order-independent)
+            if list(self_value.keys()) == list(other_value.keys()) and list(self_value.values()) == list(other_value.values()):
+                return False, True  # Quick path: both keys and values match in order
+            
+            # Compare values for each key
+            for key in self_value.keys():
+                if self_value[key] != other_value[key]:
+                    return False, False
+            
+            return False, True  # Dictionaries are equal
+        elif isinstance(self_value, dict) or isinstance(other_value, dict):
+            return False, False  # One is dict, other is not
+        return True, None  # Continue, not dictionaries
+
+    def _compare_sequences(self, self_value, other_value):
+        """Compare lists and tuples. Returns (should_continue, result)."""
+        if isinstance(self_value, (list, tuple)) and isinstance(other_value, (list, tuple)):
+            return False, type(self_value) == type(other_value) and self_value == other_value
+        elif isinstance(self_value, (list, tuple)) or isinstance(other_value, (list, tuple)):
+            return False, False  # One is sequence, other is not
+        return True, None  # Continue, not sequences
+
+    def _compare_other_types(self, self_value, other_value):
+        """Compare all other types. Returns (should_continue, result)."""
+        return False, self_value == other_value
+
+    def __eq__(self, other):
+        """
+        Compare two instances based on all their @property decorated attributes.
+        
+        Returns True if all properties have equal values, False otherwise.
+        Returns False if other is not an instance of the same class.
+        """
+        # Quick identity check first (performance optimization)
+        if self is other:
+            return True
+            
+        # Check if other is the same type
+        if type(other) != type(self):
+            return False
+        
+        # Cache properties to avoid repeated computation (performance optimization)
+        if not hasattr(self, '_cached_properties'):
+            self._cached_properties = self._get_comparable_properties()
+        
+        # Define comparison methods in order of priority/frequency
+        comparison_methods = [
+            self._compare_none_values,
+            self._compare_plotly_traces,
+            self._compare_numpy_arrays,
+            self._compare_dataframes,
+            self._compare_dictionaries,
+            self._compare_sequences,
+            self._compare_other_types,
+        ]
+
+        # Compare all property values
+        for prop_name in self._cached_properties:
+
+            try:
+                self_value = getattr(self, prop_name)
+                other_value = getattr(other, prop_name)
+                
+                # Execute comparison methods until one handles the values
+                for method in comparison_methods:
+                    should_continue, result = method(self_value, other_value)
+                    if not should_continue:
+                        if not result:
+                            return False
+                        break  # Values are equal, continue to next property
+                        
+            except (AttributeError, Exception):
+                # If property doesn't exist or comparison fails
+                return False
+        
+        return True
+    
+    def __hash__(self):
+        """
+        Simple, robust hash based on object identity.
+        
+        Uses id() for a fast, guaranteed-unique hash that won't fail.
+        Objects are only equal if they're the same instance.
+        """
+        return hash(id(self))
+    
+    def __str__(self):
+        """
+        String representation of the instance showing all @property decorated attributes and their values.
+        """
+        return f"{self.__class__.__name__}, {self.__name__}"
+    
+    def __repr__(self):
+        """
+        Official string representation of the instance.
+        """
+        return self.__str__()
+

steer_core/Mixins/TypeChecker.py

@@ -1,12 +1,37 @@
 from typing import Type
 import pandas as pd
 import numpy as np
+import plotly.graph_objects as go
 
 
 ALLOWED_REFERENCE = ["Na/Na+", "Li/Li+"]
 
 
 class ValidationMixin:
+
+    @staticmethod
+    def validate_plotly_trace(value: object, name: str) -> None:
+        """
+        Validate that a value is a Plotly trace object.
+
+        Parameters
+        ----------
+        value : object
+            The value to validate.
+        name : str
+            The name of the parameter for error messages.
+
+        Raises
+        ------
+        TypeError
+            If the value is not a Plotly trace object.
+        """
+        return (
+            hasattr(value, '__module__') and
+            value.__module__ and 
+            value.__module__.startswith('plotly.graph_objs')
+        )
+        
     @staticmethod
     def validate_type(value: Type, expected_type: Type, name: str) -> None:
         """
@@ -27,9 +52,7 @@ class ValidationMixin:
             If the value is not of the expected type.
         """
         if not isinstance(value, expected_type):
-            raise TypeError(
-                f"{name} must be of type {expected_type.__name__}. Provided: {type(value).__name__}."
-            )
+            raise TypeError(f"{name} must be of type {expected_type.__name__}. Provided: {type(value).__name__}.")
 
     @staticmethod
     def validate_percentage(value: float, name: str) -> None:

steer_core/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.18"
+__version__ = "0.1.20"

{steer_core-0.1.18.dist-info → steer_core-0.1.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steer-core
-Version: 0.1.18
+Version: 0.1.20
 Summary: Modelling energy storage from cell to site - STEER OpenCell Design
 Home-page: https://github.com/nicholas9182/steer-core/
 Author: Nicholas Siemons

{steer_core-0.1.18.dist-info → steer_core-0.1.20.dist-info}/RECORD

@@ -1,5 +1,5 @@
 steer_core/DataManager.py,sha256=06TrnBa4SLGvLeH2DacCxwGZ4zjLZslwNcwIlmfhxtA,10943
-steer_core/__init__.py,sha256=6BiuMUkhwQp6bzUZSF8np8F1NwCltEtK0sPBF__tepU,23
+steer_core/__init__.py,sha256=8XalsVoLEfXslFvdtUEmkNOuYShzOzYOcFbgmOz1oSk,23
 steer_core/Apps/ContextManagers.py,sha256=-ImT0O8BdmPKOd_e7wS6AWJMMQme7nGDEUdxTi_wv8s,1870
 steer_core/Apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 steer_core/Apps/Components/MaterialSelectors.py,sha256=LBf2PvHkyAXUoZgEhoJCfo5shEfaloa6l3PeOJAakFk,35707
@@ -15,20 +15,21 @@ steer_core/Constants/Universal.py,sha256=5FWdrex5NiI2DResDmwO7GIvGN2B0DNtdlG1l-y
 steer_core/Constants/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 steer_core/ContextManagers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 steer_core/Data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_core/Data/database.db,sha256=lCRyt-d92hq_yWMLmPVNvyjknMCznxkAf54eDX2iz90,13615104
+steer_core/Data/database.db,sha256=y8cJv-W2T1EXoULbd8cT6AlN_yUIaTAkObX0pMDB4Oc,13615104
 steer_core/Decorators/Coordinates.py,sha256=MxUWXQNrR9Q0_p4gGAywS4qnPAztajJzSay1Cu6lCRQ,1441
-steer_core/Decorators/Electrochemical.py,sha256=YDXzYxrIpbMMViK2y56UHZHb6Y4bDSIeXSVeP8VtYr4,990
-steer_core/Decorators/General.py,sha256=y1azWe4Ja9BP5vHn2gqwIpHVs11xQ1WKdqOc9v_uegs,969
+steer_core/Decorators/Electrochemical.py,sha256=nrNnTG4weyQOq1VLybjWWcbgGoth8ndvy3muN51xpwU,986
+steer_core/Decorators/General.py,sha256=lc7YdvxU-JDo8b4kunVzSjxcB3_8C185458HrXQq-lk,970
 steer_core/Decorators/Objects.py,sha256=aYaRQBFgdSE0IB4QgBVfb6GhEPagoU6TRNrW_pOaqQI,506
 steer_core/Decorators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 steer_core/Mixins/Colors.py,sha256=vbo44Fr0oeziwHJ-tu7ojG-GzqFc2LBcT_hH4szvPFc,6796
 steer_core/Mixins/Coordinates.py,sha256=irdrrXIm7lmjMqgXyRXmu-x5swNQHhR7S0EZTBhvV8U,12824
 steer_core/Mixins/Data.py,sha256=2SXRIExCmd98N5JtNEFCQ9poi94fRF_GV5TNYjEGy6o,1363
+steer_core/Mixins/Dunder.py,sha256=591oDGiRPdLH1bDIc1FUw33eeRtSc4pC7UbKEIGPm1I,7035
 steer_core/Mixins/Plotter.py,sha256=zYj-P9ryhSUe5mHoIyjasZSOnY5sDCFKx6u73E8rFZc,5424
-steer_core/Mixins/Serializer.py,sha256=VC3sqfPMR8BxBC7WaDO6cCDpVAgLV8MKAVZtiX953gQ,1016
-steer_core/Mixins/TypeChecker.py,sha256=YXvM3s0NIMGf8Dyk7xWgEMUak-tkuPxNK7ZgmefRUoE,7577
+steer_core/Mixins/TypeChecker.py,sha256=CIv-Tt-NECR55hbscBvqQnzzABflj4bHG2zYHV4kLwk,8199
 steer_core/Mixins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_core-0.1.18.dist-info/METADATA,sha256=AjS23x19XFZMX6mWTixmSzAbvuEoo5s_MuRZLX6g0Yc,704
-steer_core-0.1.18.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-steer_core-0.1.18.dist-info/top_level.txt,sha256=6LFpGCSDE_SqRoT7raeM3Ax7KTBKQnyXLXxM9kXtw5M,11
-steer_core-0.1.18.dist-info/RECORD,,
+steer_core/Mixins/serializer.py,sha256=VC3sqfPMR8BxBC7WaDO6cCDpVAgLV8MKAVZtiX953gQ,1016
+steer_core-0.1.20.dist-info/METADATA,sha256=vfJQ4joPBy8fuJ_uCyFEeV4FkSIc3mRd63fMg9RCEdw,704
+steer_core-0.1.20.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+steer_core-0.1.20.dist-info/top_level.txt,sha256=6LFpGCSDE_SqRoT7raeM3Ax7KTBKQnyXLXxM9kXtw5M,11
+steer_core-0.1.20.dist-info/RECORD,,