steer-core 0.1.30__py3-none-any.whl → 0.1.33__py3-none-any.whl

steer_core/{DataManager.py → Data/DataManager.py}

@@ -1,15 +1,20 @@
 import sqlite3 as sql
 from pathlib import Path
+from typing import TypeVar
 import pandas as pd
 import importlib.resources
 
 from steer_core.Constants.Units import *
+from steer_core.Mixins.Serializer import SerializerMixin
+
+
+T = TypeVar('T', bound='SerializerMixin')
 
 
 class DataManager:
     
     def __init__(self):
-        with importlib.resources.path("steer_core.Data", "database.db") as db_path:
+        with importlib.resources.path("steer_opencell_data", "database.db") as db_path:
             self._db_path = db_path
             self._connection = sql.connect(self._db_path)
             self._cursor = self._connection.cursor()
@@ -356,5 +361,72 @@ class DataManager:
         self._cursor.execute(f"DELETE FROM {table_name} WHERE {condition}")
         self._connection.commit()
 
+    @classmethod
+    def from_database(cls: type[T], name: str, table_name: str = None) -> T:
+        """
+        Pull object from the database by name.
+        
+        Subclasses must define a '_table_name' class variable (str or list of str)
+        unless table_name is explicitly provided.
+
+        Parameters
+        ----------
+        name : str
+            Name of the object to retrieve.
+        table_name : str, optional
+            Specific table to search. If provided, '_table_name' is not required.
+            If None, uses class's _table_name.
+
+        Returns
+        -------
+        T
+            Instance of the class.
+            
+        Raises
+        ------
+        NotImplementedError
+            If the subclass doesn't define '_table_name' and table_name is not provided.
+        ValueError
+            If the object name is not found in any of the tables.
+        """
+        database = cls()
+        
+        # Get list of tables to search
+        if table_name:
+            tables_to_search = [table_name]
+        else:
+            # Only check for _table_name if table_name wasn't provided
+            if not hasattr(cls, '_table_name'):
+                raise NotImplementedError(
+                    f"{cls.__name__} must define a '_table_name' class variable "
+                    "or provide 'table_name' argument"
+                )
+            
+            if isinstance(cls._table_name, (list, tuple)):
+                tables_to_search = cls._table_name
+            else:
+                tables_to_search = [cls._table_name]
+        
+        # Try each table until found
+        for table in tables_to_search:
+            available_materials = database.get_unique_values(table, "name")
+            
+            if name in available_materials:
+                data = database.get_data(table, condition=f"name = '{name}'")
+                serialized_bytes = data["object"].iloc[0]
+                return cls.deserialize(serialized_bytes)
+        
+        # Not found in any table
+        all_available = []
+        for table in tables_to_search:
+            all_available.extend(database.get_unique_values(table, "name"))
+        
+        raise ValueError(
+            f"'{name}' not found in tables {tables_to_search}. "
+            f"Available: {all_available}"
+        )
+        
     def __del__(self):
         self._connection.close()
+
+

steer_core/Mixins/Dunder.py

@@ -154,7 +154,10 @@ class DunderMixin:
         """
         String representation of the instance showing all @property decorated attributes and their values.
         """
-        return f"{self.__class__.__name__}, {self.__name__}"
+        if hasattr(self, 'name') and self.name:
+            return f"{self.__class__.__name__} ({self.name})"
+        else:
+            return f"{self.__class__.__name__}"
     
     def __repr__(self):
         """

steer_core/Mixins/Plotter.py

@@ -366,3 +366,5 @@ class PlotterMixin:
 
 
     
+
+

steer_core/Mixins/Serializer.py

@@ -1,46 +1,298 @@
-import base64
-from pickle import loads, dumps
-from typing import Type
-from copy import deepcopy
+import msgpack
+import msgpack_numpy as m
+import zlib
+from typing import TypeVar, Any
+from datetime import datetime
+from enum import Enum
+
+T = TypeVar('T', bound='SerializerMixin')
 
 
 class SerializerMixin:
     
-    def serialize(self) -> str:
+    def serialize(self, compress: bool = True) -> bytes:
         """
-        Serialize an object to a string representation.
+        Serialize object using MessagePack with numpy support.
 
         Parameters
         ----------
-        obj : Type
-            The object to serialize.
+        compress : bool, optional
+            Whether to compress the serialized data (default: True)
 
         Returns
         -------
-        str
-            The serialized string representation of the object.
+        bytes
+            The serialized byte representation of the object.
         """
-        pickled = dumps(self)
-        based = base64.b64encode(pickled).decode("utf-8")
-        return based
-
-    @staticmethod
-    def deserialize(String: str) -> Type:
+        m.patch()  # Enable numpy support
+        # Include class information for proper deserialization
+        obj_dict = {
+            '_class': f"{self.__class__.__module__}.{self.__class__.__name__}",
+            **self._to_dict()
+        }
+        data = msgpack.packb(obj_dict, use_bin_type=True)
+        
+        if compress:
+            # Add marker byte to indicate compression
+            return b'\x01' + zlib.compress(data, level=6)
+        else:
+            return b'\x00' + data
+    
+    def _serialize_value(self, value: Any) -> Any:
+        """
+        Recursively serialize a value, handling nested structures.
+        
+        Parameters
+        ----------
+        value : Any
+            The value to serialize.
+            
+        Returns
+        -------
+        Any
+            The serialized representation.
+        """
+        if hasattr(value, '_to_dict'):
+            # Add marker and class info for object reconstruction
+            return {
+                '__object__': True,
+                '_class': f"{value.__class__.__module__}.{value.__class__.__name__}",
+                **value._to_dict()
+            }
+        elif isinstance(value, datetime):
+            return {'__datetime__': value.isoformat()}
+        elif isinstance(value, Enum):
+            return {
+                '__enum__': True,
+                'class': f"{value.__class__.__module__}.{value.__class__.__name__}",
+                'value': value.value
+            }
+        elif isinstance(value, tuple):
+            # Recursively serialize tuple items
+            return {
+                '__tuple__': True,
+                'items': [self._serialize_value(item) for item in value]
+            }
+        elif isinstance(value, list):
+            # Recursively serialize list items
+            return [self._serialize_value(item) for item in value]
+        elif isinstance(value, dict):
+            # Handle dictionaries with object keys or values
+            has_object_keys = value and any(hasattr(k, '_to_dict') for k in value.keys())
+            has_object_values = value and any(hasattr(v, '_to_dict') for v in value.values())
+            
+            if has_object_keys or has_object_values:
+                return {
+                    '__object_dict__': True,
+                    'items': [
+                        {
+                            'key': self._serialize_value(k),
+                            'value': self._serialize_value(v)
+                        }
+                        for k, v in value.items()
+                    ]
+                }
+            else:
+                # Recursively serialize regular dict values
+                return {k: self._serialize_value(v) for k, v in value.items()}
+        else:
+            return value
+    
+    def _to_dict(self) -> dict:
         """
-        Deserialize a string representation into an object.
+        Convert object to dictionary for serialization.
+        Override this in subclasses to customize serialization behavior.
+        
+        Returns
+        -------
+        dict
+            Dictionary representation of the object.
+        """
+        result = {}
+        for key, value in self.__dict__.items():
+            result[key] = self._serialize_value(value)
+        return result
+    
+    @classmethod
+    def deserialize(cls: type[T], data: bytes) -> T:
+        """
+        Deserialize byte data into an object.
+        Automatically detects and decompresses if needed.
 
         Parameters
         ----------
-        String : str
-            The string representation to deserialize.
+        data : bytes
+            The byte data to deserialize.
 
         Returns
         -------
-        SerializerMixin
+        T
+            Instance of the class.
+        """
+        m.patch()  # Enable numpy support
+        
+        # Check compression marker
+        if data[0:1] == b'\x01':
+            data = zlib.decompress(data[1:])
+        else:
+            data = data[1:]
+        
+        obj_dict = msgpack.unpackb(data, raw=False)
+        
+        # Use stored class information if available
+        if '_class' in obj_dict:
+            import importlib
+            module_name, class_name = obj_dict['_class'].rsplit('.', 1)
+            module = importlib.import_module(module_name)
+            actual_cls = getattr(module, class_name)
+            # Remove class marker before reconstructing
+            obj_data = {k: v for k, v in obj_dict.items() if k != '_class'}
+            return actual_cls._from_dict(obj_data)
+        else:
+            # Fallback for backward compatibility
+            return cls._from_dict(obj_dict)
+    
+    @classmethod
+    def _deserialize_value(cls, value: Any) -> Any:
+        """
+        Recursively deserialize a value, handling nested structures.
+        
+        Parameters
+        ----------
+        value : Any
+            The value to deserialize.
+            
+        Returns
+        -------
+        Any
             The deserialized object.
         """
-        decoded = base64.b64decode(String.encode("utf-8"))
-        obj = deepcopy(loads(decoded))
+        if isinstance(value, dict):
+            if '__datetime__' in value:
+                return datetime.fromisoformat(value['__datetime__'])
+            elif '__enum__' in value:
+                # Reconstruct enum
+                module_name, class_name = value['class'].rsplit('.', 1)
+                import importlib
+                module = importlib.import_module(module_name)
+                enum_class = getattr(module, class_name)
+                return enum_class(value['value'])
+            elif '__tuple__' in value:
+                # Recursively reconstruct tuple items
+                return tuple(cls._deserialize_value(item) for item in value['items'])
+            elif '__object__' in value:
+                # Reconstruct regular object
+                import importlib
+                module_name, class_name = value['_class'].rsplit('.', 1)
+                module = importlib.import_module(module_name)
+                obj_class = getattr(module, class_name)
+                # Remove marker fields before passing to _from_dict
+                obj_data = {k: v for k, v in value.items() if k not in ('__object__', '_class')}
+                return obj_class._from_dict(obj_data)
+            elif '__object_dict__' in value:
+                # Reconstruct dictionary with object keys or values
+                reconstructed_dict = {}
+                for item in value['items']:
+                    key_obj = cls._deserialize_value(item['key'])
+                    value_obj = cls._deserialize_value(item['value'])
+                    reconstructed_dict[key_obj] = value_obj
+                return reconstructed_dict
+            else:
+                # Recursively deserialize regular dict values
+                return {k: cls._deserialize_value(v) for k, v in value.items()}
+        elif isinstance(value, list):
+            # Recursively deserialize list items
+            return [cls._deserialize_value(item) for item in value]
+        else:
+            return value
+    
+    @classmethod
+    def _from_dict(cls: type[T], data: dict) -> T:
+        """
+        Reconstruct object from dictionary.
+        Override in subclasses for custom deserialization.
+        
+        Parameters
+        ----------
+        data : dict
+            Dictionary representation to reconstruct from.
+            
+        Returns
+        -------
+        T
+            Reconstructed object instance.
+        """
+        obj = cls.__new__(cls)
+        reconstructed = {}
+        for key, value in data.items():
+            reconstructed[key] = cls._deserialize_value(value)
+        obj.__dict__.update(reconstructed)
         return obj
+        
+    @classmethod
+    def from_database(cls: type[T], name: str, table_name: str = None) -> T:
+        """
+        Pull object from the database by name.
+        
+        Subclasses must define a '_table_name' class variable (str or list of str)
+        unless table_name is explicitly provided.
 
+        Parameters
+        ----------
+        name : str
+            Name of the object to retrieve.
+        table_name : str, optional
+            Specific table to search. If provided, '_table_name' is not required.
+            If None, uses class's _table_name.
 
+        Returns
+        -------
+        T
+            Instance of the class.
+            
+        Raises
+        ------
+        NotImplementedError
+            If the subclass doesn't define '_table_name' and table_name is not provided.
+        ValueError
+            If the object name is not found in any of the tables.
+        """
+        from steer_core.Data.DataManager import DataManager
+        
+        database = DataManager()
+        
+        # Get list of tables to search
+        if table_name:
+            tables_to_search = [table_name]
+        else:
+            # Only check for _table_name if table_name wasn't provided
+            if not hasattr(cls, '_table_name'):
+                raise NotImplementedError(
+                    f"{cls.__name__} must define a '_table_name' class variable "
+                    "or provide 'table_name' argument"
+                )
+            
+            if isinstance(cls._table_name, (list, tuple)):
+                tables_to_search = cls._table_name
+            else:
+                tables_to_search = [cls._table_name]
+        
+        # Try each table until found
+        for table in tables_to_search:
+            available_materials = database.get_unique_values(table, "name")
+            
+            if name in available_materials:
+                data = database.get_data(table, condition=f"name = '{name}'")
+                serialized_bytes = data["object"].iloc[0]
+                return cls.deserialize(serialized_bytes)
+        
+        # Not found in any table
+        all_available = []
+        for table in tables_to_search:
+            all_available.extend(database.get_unique_values(table, "name"))
+        
+        raise ValueError(
+            f"'{name}' not found in tables {tables_to_search}. "
+            f"Available: {all_available}"
+        )
+        

steer_core/Mixins/TypeChecker.py

@@ -208,8 +208,9 @@ class ValidationMixin:
         ValueError
             If the value is not a positive float.
         """
+        value = float(value)  # Ensure value is float
         if not isinstance(value, (int, float)):
-            raise ValueError(f"{name} must be a positive float. Provided: {value}.")
+            raise ValueError(f"{name} must be a positive float. Provided: {value} of type {type(value).__name__}.")
 
     @staticmethod
     def validate_positive_int(value: int, name: str) -> None:

steer_core/__init__.py

@@ -1,7 +1,4 @@
-__version__ = "0.1.30"
-
-# datamanager import
-from .DataManager import DataManager
+__version__ = "0.1.33"
 
 from .Mixins.Colors import ColorMixin
 from .Mixins.Coordinates import CoordinateMixin

{steer_core-0.1.30.dist-info → steer_core-0.1.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steer-core
-Version: 0.1.30
+Version: 0.1.33
 Summary: Modelling energy storage from cell to site - STEER OpenCell Design
 Author-email: Nicholas Siemons <nsiemons@stanford.edu>
 Maintainer-email: Nicholas Siemons <nsiemons@stanford.edu>

{steer_core-0.1.30.dist-info → steer_core-0.1.33.dist-info}/RECORD

@@ -1,12 +1,11 @@
-steer_core/DataManager.py,sha256=XlURPvXYS05jd6bj7M4QkNU9Dwp3s1X3xjy3AIxX6No,12256
-steer_core/__init__.py,sha256=4vqKn3rLX5TKwgoOHGdqZusR6xbPr_3zyPxh6zK1GFg,380
+steer_core/__init__.py,sha256=uaSr9hFWvTFJQhMD0bP2Rvg3e7RcybXAGZGBGaWY4MA,321
 steer_core/Constants/Units.py,sha256=QIV_lDX7rANH-MKP90jOyiXbGueL15LILKMNr5dSWoI,714
 steer_core/Constants/Universal.py,sha256=5FWdrex5NiI2DResDmwO7GIvGN2B0DNtdlG1l-ysDh8,41
 steer_core/Constants/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 steer_core/ContextManagers/ContextManagers.py,sha256=4rSeBdBi6xtKLMAbERklrYmZlbFr0zceAiwu-gjTR38,1869
 steer_core/ContextManagers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+steer_core/Data/DataManager.py,sha256=AUbuK1lmibTeY5oZ_RSmfof9FyFd9HQ5J2vMoLWsuAo,14707
 steer_core/Data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_core/Data/database.db,sha256=hQ6rHo_htf-xsq5_saleJlQGjc1nJAS6tCwAjStjyMY,1716224
 steer_core/Decorators/Coordinates.py,sha256=MxUWXQNrR9Q0_p4gGAywS4qnPAztajJzSay1Cu6lCRQ,1441
 steer_core/Decorators/General.py,sha256=lc7YdvxU-JDo8b4kunVzSjxcB3_8C185458HrXQq-lk,970
 steer_core/Decorators/Objects.py,sha256=aYaRQBFgdSE0IB4QgBVfb6GhEPagoU6TRNrW_pOaqQI,506
@@ -14,12 +13,12 @@ steer_core/Decorators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 steer_core/Mixins/Colors.py,sha256=vbo44Fr0oeziwHJ-tu7ojG-GzqFc2LBcT_hH4szvPFc,6796
 steer_core/Mixins/Coordinates.py,sha256=DEPKvySoiDT8JhQSEQDiQgAxGjEJK7MezuZysSvf-UU,36259
 steer_core/Mixins/Data.py,sha256=c313F85muxlBHQ6yl6AKrifNyV2toHvVwEy35fNNUNE,4434
-steer_core/Mixins/Dunder.py,sha256=591oDGiRPdLH1bDIc1FUw33eeRtSc4pC7UbKEIGPm1I,7035
-steer_core/Mixins/Plotter.py,sha256=2W8PQok3AHogS8rgpOkaC5UiJGXu9ZxXSrKW5lOQp5w,13503
-steer_core/Mixins/Serializer.py,sha256=20ZOP7cKWwD-JH-XwBMN-qOoxFohQMn4XBr52U6cwTE,1023
-steer_core/Mixins/TypeChecker.py,sha256=dzTu6q6xfz0Op3Yhu7vA-3-8D02iHZPBeAdX9ng9-WM,10454
+steer_core/Mixins/Dunder.py,sha256=cIwh1VhcwzlwelUo2eM1KllVtxZddrkr6g0a5CkXea8,7146
+steer_core/Mixins/Plotter.py,sha256=wRRF0C5fz_6polCKKRVnZ07UFL4HBohZ5K2BSm_ULsg,13505
+steer_core/Mixins/Serializer.py,sha256=a3-J1ESM0UkO7b8Ctzjj605-p9bfzoFjJydM8k2grEQ,10458
+steer_core/Mixins/TypeChecker.py,sha256=eXgu1G4d2_btNg5AJ3UkTXpoFJ79bc6tSasInCnXqc0,10539
 steer_core/Mixins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_core-0.1.30.dist-info/METADATA,sha256=fhJvQG2VK24GIL6uCgShSNtqJVVFk9dMfor16Zsj1nk,1601
-steer_core-0.1.30.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-steer_core-0.1.30.dist-info/top_level.txt,sha256=6LFpGCSDE_SqRoT7raeM3Ax7KTBKQnyXLXxM9kXtw5M,11
-steer_core-0.1.30.dist-info/RECORD,,
+steer_core-0.1.33.dist-info/METADATA,sha256=Cgqe7hQ4CZxG1bSCAZhO1-CwDh5aJjsXgoOMBaZGUY8,1601
+steer_core-0.1.33.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+steer_core-0.1.33.dist-info/top_level.txt,sha256=6LFpGCSDE_SqRoT7raeM3Ax7KTBKQnyXLXxM9kXtw5M,11
+steer_core-0.1.33.dist-info/RECORD,,