power-grid-model-io 1.2.14__py3-none-any.whl → 1.2.15__py3-none-any.whl

power_grid_model_io/data_types/tabular_data.py

@@ -6,7 +6,7 @@ The TabularData class is a wrapper around Dict[str, Union[pd.DataFrame, np.ndarr
 which supports unit conversions and value substitutions
 """
 
-from typing import Dict, Iterable, Optional, Tuple, Union
+from typing import Callable, Dict, Generator, Iterable, Optional, Tuple, Union
 
 import numpy as np
 import pandas as pd
@@ -15,6 +15,8 @@ import structlog
 from power_grid_model_io.mappings.unit_mapping import UnitMapping
 from power_grid_model_io.mappings.value_mapping import ValueMapping
 
+LazyDataFrame = Callable[[], pd.DataFrame]
+
 
 class TabularData:
     """
@@ -22,7 +24,7 @@ class TabularData:
     which supports unit conversions and value substitutions
     """
 
-    def __init__(self, **tables: Union[pd.DataFrame, np.ndarray]):
+    def __init__(self, **tables: Union[pd.DataFrame, np.ndarray, LazyDataFrame]):
         """
         Tabular data can either be a collection of pandas DataFrames and/or numpy structured arrays.
         The key word arguments will define the keys of the data.
@@ -34,12 +36,12 @@ class TabularData:
             **tables: A collection of pandas DataFrames and/or numpy structured arrays
         """
         for table_name, table_data in tables.items():
-            if not isinstance(table_data, (pd.DataFrame, np.ndarray)):
+            if not isinstance(table_data, (pd.DataFrame, np.ndarray)) and not callable(table_data):
                 raise TypeError(
                     f"Invalid data type for table '{table_name}'; "
                     f"expected a pandas DataFrame or NumPy array, got {type(table_data).__name__}."
                 )
-        self._data: Dict[str, Union[pd.DataFrame, np.ndarray]] = tables
+        self._data: Dict[str, Union[pd.DataFrame, np.ndarray, LazyDataFrame]] = tables
         self._units: Optional[UnitMapping] = None
         self._substitution: Optional[ValueMapping] = None
         self._log = structlog.get_logger(type(self).__name__)
@@ -73,7 +75,7 @@ class TabularData:
         Returns:
             The required column, with unit conversions and value substitutions applied
         """
-        table_data = self._data[table_name]
+        table_data = self[table_name]
 
         # If the index 'column' is requested, but no column called 'index' exist,
         # return the index of the dataframe as if it were an actual column.
@@ -154,6 +156,14 @@ class TabularData:
 
         return table_data[pd.MultiIndex.from_tuples([(field, si_unit)])[0]]
 
+    def __len__(self) -> int:
+        """
+        Return the number of tables (regardless of if they are already loaded or not)
+
+        Returns: The number of tables
+        """
+        return len(self._data)
+
     def __contains__(self, table_name: str) -> bool:
         """
         Mimic the dictionary 'in' operator
@@ -176,6 +186,8 @@ class TabularData:
 
         Returns: The 'raw' table data
         """
+        if callable(self._data[table_name]):
+            self._data[table_name] = self._data[table_name]()
         return self._data[table_name]
 
     def keys(self) -> Iterable[str]:
@@ -187,13 +199,14 @@ class TabularData:
 
         return self._data.keys()
 
-    def items(self) -> Iterable[Tuple[str, Union[pd.DataFrame, np.ndarray]]]:
+    def items(self) -> Generator[Tuple[str, Union[pd.DataFrame, np.ndarray]], None, None]:
         """
         Mimic the dictionary .items() function
 
-        Returns: An iterator over the table names and the raw table data
+        Returns: An generator of the table names and the raw table data
         """
 
         # Note: PyCharm complains about the type, but it is correct, as an ItemsView extends from
         # AbstractSet[Tuple[_KT_co, _VT_co]], which actually is compatible with Iterable[_KT_co, _VT_co]
-        return self._data.items()
+        for key in self._data:
+            yield key, self[key]

{power_grid_model_io-1.2.14.dist-info → power_grid_model_io-1.2.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: power-grid-model-io
-Version: 1.2.14
+Version: 1.2.15
 Summary: Power Grid Model Input/Output
 Author-email: Alliander Dynamic Grid Calculation <dynamic.grid.calculation@alliander.com>
 License: MPL-2.0
@@ -67,15 +67,15 @@ SPDX-License-Identifier: MPL-2.0
 For detailed documentation, see [Read the Docs](https://power-grid-model-io.readthedocs.io/en/stable/index.html).
 
 # Examples
-* [PGM JSON Example](https://github.com/alliander-opensource/power-grid-model-io/blob/a806d97bdc8acd2b0037e4426d38a5ce4371825e/docs/examples/pgm_json_example.ipynb)
+* [PGM JSON Example](https://github.com/alliander-opensource/power-grid-model-io/blob/7e498b3c2d5ca4581628587d9474c1efca004ea7/docs/examples/pgm_json_example.ipynb)
 
 
 # License
-This project is licensed under the Mozilla Public License, version 2.0 - see [LICENSE](https://github.com/alliander-opensource/power-grid-model-io/blob/a806d97bdc8acd2b0037e4426d38a5ce4371825e/LICENSE) for details.
+This project is licensed under the Mozilla Public License, version 2.0 - see [LICENSE](https://github.com/alliander-opensource/power-grid-model-io/blob/7e498b3c2d5ca4581628587d9474c1efca004ea7/LICENSE) for details.
 
 # Contributing
-Please read [CODE_OF_CONDUCT](https://github.com/alliander-opensource/power-grid-model-io/blob/a806d97bdc8acd2b0037e4426d38a5ce4371825e/CODE_OF_CONDUCT.md) and [CONTRIBUTING](https://github.com/alliander-opensource/power-grid-model-io/blob/a806d97bdc8acd2b0037e4426d38a5ce4371825e/CONTRIBUTING.md) for details on the process 
+Please read [CODE_OF_CONDUCT](https://github.com/alliander-opensource/power-grid-model-io/blob/7e498b3c2d5ca4581628587d9474c1efca004ea7/CODE_OF_CONDUCT.md) and [CONTRIBUTING](https://github.com/alliander-opensource/power-grid-model-io/blob/7e498b3c2d5ca4581628587d9474c1efca004ea7/CONTRIBUTING.md) for details on the process 
 for submitting pull requests to us.
 
 # Contact
-Please read [SUPPORT](https://github.com/alliander-opensource/power-grid-model-io/blob/a806d97bdc8acd2b0037e4426d38a5ce4371825e/SUPPORT.md) for how to connect and get into contact with the Power Gird Model IO project.
+Please read [SUPPORT](https://github.com/alliander-opensource/power-grid-model-io/blob/7e498b3c2d5ca4581628587d9474c1efca004ea7/SUPPORT.md) for how to connect and get into contact with the Power Gird Model IO project.

{power_grid_model_io-1.2.14.dist-info → power_grid_model_io-1.2.15.dist-info}/RECORD

@@ -17,7 +17,7 @@ power_grid_model_io/data_stores/json_file_store.py,sha256=vmo25AiCIy16HDF8S5ZZKu
 power_grid_model_io/data_stores/vision_excel_file_store.py,sha256=d5J6ClvIpef_JwKcqCilzYU411IR8Zju6R9Dc4j0KXQ,821
 power_grid_model_io/data_types/__init__.py,sha256=zXc0yGSyNFxpORWjXnejEkvjXFZXXyfEO7PeUtoqWnA,384
 power_grid_model_io/data_types/_data_types.py,sha256=IRQomW3ecETvIYfIzQRPDOwUY-TAa4g4mV17TvQVeGg,1834
-power_grid_model_io/data_types/tabular_data.py,sha256=xpBWKFzQh8U8rFBrn2R03G4piMRtkWLZpLa6TRhhCio,7878
+power_grid_model_io/data_types/tabular_data.py,sha256=BC20WzbV1V03KD_BmfxwDKH4X_X_sbQ97PuUXz2Y7wA,8356
 power_grid_model_io/functions/__init__.py,sha256=LQKpnYqnZhMHb9QwWTTGiMadwl3e6jMSEzJf6TlIZk0,511
 power_grid_model_io/functions/_functions.py,sha256=J0KiqU_V3lniwNvYbFhF2_iOz5ug9_KahtlnM1xyeHs,2873
 power_grid_model_io/functions/phase_to_phase.py,sha256=oaDRoPg6okII0rq8klPM085DF5pSmIDqlSiY9l-L5E8,6296
@@ -33,8 +33,8 @@ power_grid_model_io/utils/dict.py,sha256=Y5fCB22qIwFVHinUq-TO1eXeNWU177sVPyOVVaA
 power_grid_model_io/utils/json.py,sha256=Fw9GhCiwk4sXw48ljPOkWAR0LaRkdA8ZkUQu-K0z0vU,3343
 power_grid_model_io/utils/modules.py,sha256=ZB8IIK96VuJk5FkoclrUCuXOSsGeVqT3B01bBAcodeU,944
 power_grid_model_io/utils/regex.py,sha256=0uJDRSfggmDFu_nip1Oge8NUXBQ_8e-3HTLdB8niAkQ,1728
-power_grid_model_io-1.2.14.dist-info/LICENSE,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907
-power_grid_model_io-1.2.14.dist-info/METADATA,sha256=88TvQfEryWlOrh42YbYe2IgTnTewZwfTGtDm1X4FLXo,5679
-power_grid_model_io-1.2.14.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-power_grid_model_io-1.2.14.dist-info/top_level.txt,sha256=7sq9VveemMm2R0RgTBa4tH8y_xF4_1hxbufmX9OjCTo,20
-power_grid_model_io-1.2.14.dist-info/RECORD,,
+power_grid_model_io-1.2.15.dist-info/LICENSE,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907
+power_grid_model_io-1.2.15.dist-info/METADATA,sha256=vehvfqpJuj38lsYHOVfbt79N66zNAjWA3y-rxNCVjJ8,5679
+power_grid_model_io-1.2.15.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+power_grid_model_io-1.2.15.dist-info/top_level.txt,sha256=7sq9VveemMm2R0RgTBa4tH8y_xF4_1hxbufmX9OjCTo,20
+power_grid_model_io-1.2.15.dist-info/RECORD,,