pandahub 0.3.8__zip → 0.3.10__zip

{pandahub-0.3.8 → pandahub-0.3.10}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## [0.3.10]
+
+    -  BREAKING: changed signatures of create_variant function and route
+
+## [0.3.9]
+
+    -  BREAKING: inserting multiple networks with the same name does not represent an error anymore, networks are only unique by their net_id (_id field of the collection)
+    -  BREAKING: passing net_id as str will not remap to the project name internally but look up on the _id field
+    -  IMPROVED: fix race condition when calling write_network_to_db without net_id
+
 ## [0.3.8]
 
     -  BREAKING: specifying variant as list will raise an error instead of a deprecation warning

{pandahub-0.3.8 → pandahub-0.3.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pandahub
-Version: 0.3.8
+Version: 0.3.10
 Summary: Data hub for pandapower and pandapipes networks based on MongoDB
 Author-email: Jan Ulffers <jan.ulffers@iee.fraunhofer.de>, Leon Thurner <leon.thurner@retoflow.de>, Jannis Kupka <jannis.kupka@retoflow.de>, Mike Vogt <mike.vogt@iee.fraunhofer.de>, Joschka Thurner <joschka.thurner@retoflow.de>, Alexander Scheidler <alexander.scheidler@iee.fraunhofer.de>
 License: Copyright (c) 2022 by University of Kassel, Fraunhofer Institute for Energy Economics

{pandahub-0.3.8 → pandahub-0.3.10}/pandahub/api/routers/net.py

@@ -1,6 +1,7 @@
 from typing import Optional, Any
 
 import pandapower as pp
+import pandapipes as pps
 from fastapi import APIRouter, Depends
 from pydantic import BaseModel
 
@@ -25,7 +26,7 @@ class GetNetFromDB(BaseModel):
 
 @router.post("/get_net_from_db")
 def get_net_from_db(data: GetNetFromDB, ph=Depends(pandahub)):
-    net = ph.get_net_from_db(**data.model_dump())
+    net = ph.get_network_by_name(**data.model_dump())
     return pp.to_json(net)
 
 
@@ -49,7 +50,7 @@ def write_network_to_db(data: WriteNetwork, ph=Depends(pandahub)):
 
 class BaseCRUDModel(BaseModel):
     project_id: str
-    net: str
+    net_id: int | str
     element_type: str
 
 class GetNetValueModel(BaseCRUDModel):

{pandahub-0.3.8 → pandahub-0.3.10}/pandahub/api/routers/variants.py

@@ -17,7 +17,7 @@ router = APIRouter(
 
 class GetVariantsModel(BaseModel):
     project_id: str
-    net_id: int
+    net_id: int | str
 
 @router.post("/get_variants")
 def get_variants(data: GetVariantsModel, ph=Depends(pandahub)):
@@ -30,17 +30,27 @@ def get_variants(data: GetVariantsModel, ph=Depends(pandahub)):
 
 class CreateVariantModel(BaseModel):
     project_id: str
-    variant_data: dict
+    net_id: int
+    name: str | None = None
+    default_name: str | None = None
+
+
+class CreateVariantResponseModel(BaseModel):
+    net_id: int
+    index: int
+    name: str | None = None
+    date_created: int
+    date_changed: int
+
 
 @router.post("/create_variant")
-def create_variant(data: CreateVariantModel, ph=Depends(pandahub)):
-    project_id = data.project_id
-    ph.set_active_project_by_id(project_id)
-    return ph.create_variant(data.variant_data)
+def create_variant(data: CreateVariantModel, ph=Depends(pandahub)) -> CreateVariantResponseModel:
+    ph.set_active_project_by_id(data.project_id)
+    return ph.create_variant(net_id=data.net_id, name=data.name, default_name=data.default_name)
 
 class DeleteVariantModel(BaseModel):
     project_id: str
-    net_id: int
+    net_id: int | str
     index: int
 
 @router.post("/delete_variant")
@@ -51,7 +61,7 @@ def delete_variant(data: DeleteVariantModel, ph=Depends(pandahub)):
 
 class UpdateVariantModel(BaseModel):
     project_id: str
-    net_id: int
+    net_id: int | str
     index: int
     data: dict
 

{pandahub-0.3.8 → pandahub-0.3.10}/pandahub/lib/PandaHub.py

@@ -2,6 +2,7 @@
 import builtins
 import json
 import logging
+import time
 import warnings
 from inspect import signature, _empty
 from collections.abc import Callable
@@ -16,7 +17,7 @@ from functools import reduce
 from operator import getitem
 from uuid import UUID
 from pymongo import MongoClient, ReplaceOne
-from pymongo.errors import ServerSelectionTimeoutError
+from pymongo.errors import ServerSelectionTimeoutError, DuplicateKeyError
 
 import pandapipes as pps
 from pandapipes import from_json_string as from_json_pps, FromSerializableRegistryPpipe
@@ -91,6 +92,7 @@ class PandaHub:
         user_id=None,
         datatypes=DATATYPES,
         mongodb_indexes=MONGODB_INDEXES,
+        elements_without_vars = None,
     ):
         mongo_client_args = {
             "host": connection_url,
@@ -115,6 +117,7 @@ class PandaHub:
                 {"var_type": np.nan},
             ]
         }
+        self._elements_without_vars = ["variant"] if elements_without_vars is None else elements_without_vars
         if check_server_available:
             self.server_is_available()
 
@@ -707,7 +710,8 @@ class PandaHub:
         db = self._get_project_database()
         return list(db["_networks"].find())
 
-    def get_net_from_db(
+
+    def get_network_by_name(
         self,
         name,
         include_results=True,
@@ -721,16 +725,16 @@ class PandaHub:
             self.set_active_project_by_id(project_id)
         self.check_permission("read")
         db = self._get_project_database()
-        _id = self._get_id_from_name(name, db)
-        if _id is None:
+        net_id = self._get_net_id_from_name(name, db)
+        if net_id is None:
             return None
-        return self.get_net_from_db_by_id(
-            _id, include_results, only_tables, geo_mode=geo_mode, variant=variant, convert=convert
+        return self.get_network(
+            net_id, include_results, only_tables, geo_mode=geo_mode, variant=variant, convert=convert
         )
 
-    def get_net_from_db_by_id(
+    def get_network(
         self,
-        id,
+        net_id,
         include_results=True,
         only_tables=None,
         convert=True,
@@ -739,7 +743,7 @@ class PandaHub:
     ):
         self.check_permission("read")
         return self._get_net_from_db_by_id(
-            id,
+            net_id,
             include_results,
             only_tables,
             convert=convert,
@@ -749,7 +753,7 @@ class PandaHub:
 
     def _get_net_from_db_by_id(
         self,
-        id_,
+        net_id,
         include_results=True,
         only_tables=None,
         convert=True,
@@ -757,20 +761,20 @@ class PandaHub:
         variant=None,
     ):
         db = self._get_project_database()
-        meta = self._get_network_metadata(db, id_)
+        meta = self._get_network_metadata(db, net_id)
 
         package = pp if meta.get("sector", "power") == "power" else pps
         net = package.create_empty_network()
 
         # add all elements that are stored as dataframes
-        collection_names = self._get_net_collections(db)
+        collection_names = self.get_net_collections(db)
         for collection_name in collection_names:
             el = self._element_name_of_collection(collection_name)
             self._add_element_from_collection(
                 net,
                 db,
                 el,
-                id_,
+                net_id,
                 include_results=include_results,
                 only_tables=only_tables,
                 geo_mode=geo_mode,
@@ -797,7 +801,8 @@ class PandaHub:
                     value = json.loads(value[11:], cls=io_pp.PPJSONDecoder, registry_class=registry)
                 net[key] = value
 
-    def get_subnet_from_db(
+
+    def get_subnet_by_name(
         self,
         name,
         bus_filter=None,
@@ -811,11 +816,11 @@ class PandaHub:
     ):
         self.check_permission("read")
         db = self._get_project_database()
-        _id = self._get_id_from_name(name, db)
-        if _id is None:
+        net_id = self._get_net_id_from_name(name, db)
+        if net_id is None:
             return None
-        return self.get_subnet_from_db_by_id(
-            _id,
+        return self.get_subnet(
+            net_id,
             bus_filter=bus_filter,
             include_results=include_results,
             add_edge_branches=add_edge_branches,
@@ -824,7 +829,7 @@ class PandaHub:
             additional_filters=additional_filters,
         )
 
-    def get_subnet_from_db_by_id(
+    def get_subnet(
         self,
         net_id,
         bus_filter=None,
@@ -1034,7 +1039,7 @@ class PandaHub:
             )
 
         # add all other collections
-        collection_names = self._get_net_collections(db)
+        collection_names = self.get_net_collections(db)
         for collection in collection_names:
             table_name = self._element_name_of_collection(collection)
             # skip all element tables that we have already added
@@ -1072,33 +1077,67 @@ class PandaHub:
 
     def write_network_to_db(
         self,
-        net,
-        name,
+        net: pp.pandapowerNet | pps.pandapipesNet,
+        name: str,
         sector="power",
-        overwrite=True,
-        project_id=None,
-        metadata=None,
-        skip_results=False,
-        net_id=None,
-    ):
+        overwrite: bool = True,
+        project_id: str = None,
+        metadata: dict = None,
+        skip_results: bool = False,
+        net_id: int | str = None,
+    ) -> dict:
+        """
+        Write a pandapower or pandapipes network to the database.
+
+        A network is uniquely identified only by its net_id (multiple networks with the same name are allowed).
+        If no net_id is passed, an incrementing integer id is generated.
+        Raises an error if a passed net_id already exists in the database unless overwrite is set to True.
+
+
+        Parameters
+        ----------
+        net:
+            pandapower or pandapipes network
+        name:
+            name of the network
+        sector:
+            sector of the network
+        overwrite:
+            if True, an existing network with the same net_id will be overwritten
+        project_id:
+            id of the project (defaults to active project)
+        metadata:
+            additional metadata to be stored with the network
+        skip_results:
+            if True, results tables are not stored in the database
+        net_id:
+            id of the network. If None, a new integer id is generated
+
+        Returns
+        -------
+        dict
+            metadata of the created network
+        """
         if project_id:
             self.set_active_project_by_id(project_id)
         self.check_permission("write")
         db = self._get_project_database()
-
-        #         if not isinstance(net, pp.pandapowerNet) and not isinstance(net, pps.pandapipesNet):
-        #             raise PandaHubError("net must be a pandapower or pandapipes object")
-
-        if self._network_with_name_exists(name, db):
-            if overwrite:
-                self.delete_net_from_db(name)
-            else:
-                raise PandaHubError("Network name already exists")
+        networks_coll = db["_networks"]
 
         if net_id is None:
-            max_id_network = db["_networks"].find_one(sort=[("_id", -1)])
-            net_id = 0 if max_id_network is None else max_id_network["_id"] + 1
-        db["_networks"].insert_one({"_id": net_id})
+            net_id = self._get_int_index("_networks")
+        else:
+            try:
+                networks_coll.insert_one({"_id": net_id})
+            except DuplicateKeyError:
+                if overwrite:
+                    self.delete_network(net_id)
+                    networks_coll.insert_one({"_id": net_id})
+                else:
+                    msg = f"Network with net_id {net_id} already exists"
+                    raise PandaHubError(msg)
+
+        networks_coll.update_one({"_id": net_id}, {"$set": {"name": name, "sector": sector}})
 
         data = {}
         dtypes = {}
@@ -1114,10 +1153,13 @@ class PandaHub:
                 if element_data.empty:
                     continue
                 element_data = element_data.copy(deep=True)
-                if "var_type" in element_data:
-                    element_data["var_type"] = element_data["var_type"].fillna("base")
-                else:
-                    element_data["var_type"] = "base"
+                if element not in self._elements_without_vars:
+                    if "var_type" in element_data:
+                        element_data["var_type"] = element_data["var_type"].fillna("base")
+                    else:
+                        element_data["var_type"] = "base"
+                        element_data["not_in_var"] = np.empty((len(element_data.index), 0)).tolist()
+                        element_data["variant"] = None
                 element_data = convert_element_to_dict(element_data, net_id, self._datatypes.get(element))
                 self._write_element_to_db(db, element, element_data)
 
@@ -1128,14 +1170,12 @@ class PandaHub:
 
         # write network metadata
         network_data = {
-            "name": name,
-            "sector": sector,
             "dtypes": dtypes,
             "data": data,
         }
         if metadata is not None:
             network_data.update(metadata)
-        db["_networks"].update_one({"_id": net_id}, {"$set": network_data})
+        networks_coll.update_one({"_id": net_id}, {"$set": network_data})
         return network_data | {"_id": net_id}
 
     def _write_net_collections_to_db(self, db, collections):
@@ -1151,16 +1191,22 @@ class PandaHub:
             db[collection_name].insert_many(element_data, ordered=False)
             # print(f"\nFAILED TO WRITE TABLE '{element_type}' TO DATABASE! (details above)")
 
-    def delete_net_from_db(self, name):
-        self.check_permission("write")
+    def delete_network(self, net_id):
+        if net_id is None:
+            raise PandaHubError(f"No net_id was passed", 404)
         db = self._get_project_database()
-        _id = self._get_id_from_name(name, db)
-        if _id is None:
-            raise PandaHubError("Network does not exist", 404)
-        collection_names = self._get_net_collections(db)  # TODO
+        collection_names = self.get_net_collections(db)
         for collection_name in collection_names:
-            db[collection_name].delete_many({"net_id": _id})
-        db["_networks"].delete_one({"_id": _id})
+            db[collection_name].delete_many({"net_id": net_id})
+        db["_networks"].delete_one({"_id": net_id})
+
+    def delete_network_by_name(self, name):
+        self.check_permission("write")
+        db = self._get_project_database()
+        net_id = self._get_net_id_from_name(name, db)
+        if net_id is None:
+            raise PandaHubError(f"Network with name {name} does not exist", 404)
+        self.delete_network(net_id)
 
     def network_with_name_exists(self, name):
         self.check_permission("read")
@@ -1177,19 +1223,23 @@ class PandaHub:
         nets = pd.DataFrame(list(db.find(fi, projection=proj)))
         return nets
 
-    def _get_metadata_from_name(self, name, db):
-        return list(db["_networks"].find({"name": name}))
-
-    def _get_id_from_name(self, name, db):
-        metadata = self._get_metadata_from_name(name, db)
+    def _get_net_id_from_name(self, name, db):
+        metadata = list(db["_networks"].find({"name": name}))
         if len(metadata) > 1:
-            raise PandaHubError("Duplicate Network!")
+            msg = (f"Multiple networks with the name {metadata[0]['name']} found in the database. "
+                   f"Use the corresponding function which selects the network by net_id instead.")
+            raise PandaHubError(msg)
         return None if len(metadata) == 0 else metadata[0]["_id"]
 
     def _network_with_name_exists(self, name, db):
-        return self._get_id_from_name(name, db) is not None
+        return self._get_net_id_from_name(name, db) is not None
 
     def _get_net_collections(self, db, with_areas=True):
+        return self.get_net_collections(db, with_areas)
+
+    def get_net_collections(self, db=None, with_areas=True):
+        if db is None:
+            db = self.get_project_database()
         if with_areas:
             collection_filter = {"name": {"$regex": "^net_"}}
         else:
@@ -1268,16 +1318,12 @@ class PandaHub:
     # -------------------------
 
     def get_net_value_from_db(
-        self, net, element_type, element_index, parameter, variant=None, project_id=None
+        self, net_id, element_type, element_index, parameter, variant=None, project_id=None
     ):
         if project_id:
             self.set_active_project_by_id(project_id)
         self.check_permission("write")
         db = self._get_project_database()
-        if isinstance(net, str):
-            net_id = self._get_id_from_name(net, db)
-        else:
-            net_id = net
 
         collection = self._collection_name_of_element(element_type)
         dtypes = self._datatypes.get(element_type)
@@ -1303,14 +1349,14 @@ class PandaHub:
             return document[parameter]
 
     def delete_element(
-        self, net, element_type, element_index, variant=None, project_id=None, **kwargs
+        self, net_id, element_type, element_index, variant=None, project_id=None, **kwargs
     ) -> dict:
         """
         Delete an element from the database.
 
         Parameters
         ----------
-        net: str or int
+        net_id: str or int
             Network to add elements to, either a name or numeric id
         element_type: str
             Name of the element type (e.g. bus, line)
@@ -1326,7 +1372,7 @@ class PandaHub:
             The deleted element as dict with all fields
         """
         return self.delete_elements(
-            net=net,
+            net_id=net_id,
             element_type=element_type,
             element_indexes=[element_index],
             variant=variant,
@@ -1336,7 +1382,7 @@ class PandaHub:
 
     def delete_elements(
         self,
-        net: Union[int, str],
+        net_id: Union[int, str],
         element_type: str,
         element_indexes: list[int],
         variant: Union[int, None] = None,
@@ -1348,7 +1394,7 @@ class PandaHub:
 
         Parameters
         ----------
-        net: str or int
+        net_id: str or int
             Network to add elements to, either a name or numeric id
         element_type: str
             Name of the element type (e.g. bus, line)
@@ -1365,7 +1411,7 @@ class PandaHub:
         """
         if not isinstance(element_indexes, list):
             raise TypeError("Parameter element_indexes must be a list of ints!")
-        validate_variant_type(variant)
+        self.validate_variant(variant, element_type)
         if project_id:
             self.set_active_project_by_id(project_id)
 
@@ -1373,11 +1419,6 @@ class PandaHub:
         db = self._get_project_database()
         collection = self._collection_name_of_element(element_type)
 
-        if isinstance(net, str):
-            net_id = self._get_id_from_name(net, db)
-        else:
-            net_id = net
-
         element_filter = {
             "index": {"$in": element_indexes},
             "net_id": int(net_id),
@@ -1405,7 +1446,7 @@ class PandaHub:
 
     def set_net_value_in_db(
         self,
-        net,
+        net_id,
         element_type,
         element_index,
         parameter,
@@ -1414,7 +1455,7 @@ class PandaHub:
         project_id=None,
         **kwargs,
     ):
-        validate_variant_type(variant)
+        self.validate_variant(variant, element_type)
         if project_id:
             self.set_active_project_by_id(project_id)
         self.check_permission("write")
@@ -1423,10 +1464,6 @@ class PandaHub:
         if value is not None and dtypes is not None and parameter in dtypes:
             value = dtypes[parameter](value)
         collection = self._collection_name_of_element(element_type)
-        if isinstance(net, str):
-            net_id = self._get_id_from_name(net, db)
-        else:
-            net_id = net
         element_filter = {
             "index": element_index,
             "net_id": int(net_id),
@@ -1478,7 +1515,7 @@ class PandaHub:
 
     def set_object_attribute(
         self,
-        net,
+        net_id,
         element_type,
         element_index,
         parameter,
@@ -1486,7 +1523,7 @@ class PandaHub:
         variant=None,
         project_id=None,
     ):
-        validate_variant_type(variant)
+        self.validate_variant(variant, element_type)
         if project_id:
             self.set_active_project_by_id(project_id)
         self.check_permission("write")
@@ -1495,10 +1532,6 @@ class PandaHub:
         if dtypes is not None and parameter in dtypes:
             value = dtypes[parameter](value)
         collection = self._collection_name_of_element(element_type)
-        if isinstance(net, str):
-            net_id = self._get_id_from_name(net, db)
-        else:
-            net_id = net
 
         js = list(db[collection].find({"index": element_index, "net_id": net_id}))[0]
         obj = json_to_object(js["object"])
@@ -1544,7 +1577,7 @@ class PandaHub:
 
     def create_element(
         self,
-        net: Union[int, str],
+        net_id: Union[int, str],
         element_type: str,
         element_index: int,
         element_data: dict,
@@ -1557,7 +1590,7 @@ class PandaHub:
 
         Parameters
         ----------
-        net: str or int
+        net_id: str or int
             Network to add elements to, either as name or numeric id
         element_type: str
             Name of the element type (e.g. bus, line)
@@ -1575,7 +1608,7 @@ class PandaHub:
             The created element (element_data with added _id field)
         """
         return self.create_elements(
-            net=net,
+            net_id=net_id,
             element_type=element_type,
             elements_data=[{"index": element_index, **element_data}],
             variant=variant,
@@ -1585,7 +1618,7 @@ class PandaHub:
 
     def create_elements(
         self,
-        net: Union[int, str],
+        net_id: Union[int, str],
         element_type: str,
         elements_data: list[dict],
         variant: int | None = None,
@@ -1597,7 +1630,7 @@ class PandaHub:
 
         Parameters
         ----------
-        net: str or int
+        net_id: str or int
             Network to add elements to, either a name or numeric id
         element_type: str
             Name of the element type (e.g. bus, line)
@@ -1612,7 +1645,7 @@ class PandaHub:
         list
             A list of the created elements (elements_data with added _id fields)
         """
-        validate_variant_type(variant)
+        self.validate_variant(variant, element_type)
         if project_id:
             self.set_active_project_by_id(project_id)
         self.check_permission("write")
@@ -1621,10 +1654,6 @@ class PandaHub:
             var_data = {"var_type": "base", "not_in_var": [], "variant": None}
         else:
             var_data = {"var_type": "addition", "not_in_var": [], "variant": variant}
-        if isinstance(net, str):
-            net_id = self._get_id_from_name(net, db)
-        else:
-            net_id = net
 
         data = []
         for elm_data in elements_data:
@@ -1707,39 +1736,78 @@ class PandaHub:
             logger.info(f"creating indexes in {collection} collection")
             project_db[collection].create_indexes(indexes)
 
+    def _get_int_index(self, collection: str, index_field: str = "_id", query_filter: dict | None = None,
+                       retries: int = 10) -> int:
+        """Create a document in a collection with an incrementing integer value for the index_field key.
+
+        ! This function expects a unique index set in the database on collection.index_field, compound with the keys in query_filter (if not None) !
+
+        Parameters
+        ----------
+        collection:
+            The collection to create the document in.
+        index_field:
+            The field holding the incrementing integer index.
+        query_filter:
+            A query filter to apply when searching for the highest existing index.
+        retries:
+            Number of retries to create the index in case of a race condition.
+
+        Returns
+        -------
+            The value of the created index.
+        """
+        query_filter = query_filter if query_filter is not None else {}
+        coll = self.get_project_database(collection)
+        for retry in range(retries):
+            try:
+                max_index = next(coll.find(query_filter, projection={index_field: 1})
+                                 .sort(index_field, -1)
+                                 .limit(1),
+                                 None)
+                index = 0 if max_index is None else int(max_index[0][index_field]) + 1
+                coll.insert_one({index_field: index})
+                break
+            except DuplicateKeyError:
+                continue
+        else:
+            msg = f"Failed to create integer index for field {index_field} in {collection}!"
+            raise PandaHubError(msg)
+        return index
+
+
     # -------------------------
     # Variants
     # -------------------------
 
-    def create_variant(self, data, index: Optional[int] = None):
+    def create_variant(
+        self,
+        net_id: int,
+        name: str | None = None,
+        default_name: str = "Variant",
+        index: int | None = None,
+    ) -> dict:
         db = self._get_project_database()
-        net_id = int(data["net_id"])
         if index is None:
-            max_index = list(
-                db["variant"]
-                .find({"net_id": net_id}, projection={"_id": 0, "index": 1})
-                .sort("index", -1)
-                .limit(1)
-            )
-            index = int(max_index[0]["index"]) + 1 if max_index else 1
-
-        data["index"] = index
-        if data.get("default_name") is not None and data.get("name") is None:
-            data["name"] = data.pop("default_name") + " " + str(index)
-        db["variant"].insert_one(data)
-        del data["_id"]
-
-        if index == 1:
-            for coll in self._get_net_collections(db):
-                db[coll].update_many(
-                    {"$or": [{"var_type": None}, {"var_type": np.nan}]},
-                    {"$set": {"var_type": "base", "not_in_var": [], "variant": None}},
-                )
-        return data
+            index = self._get_int_index("variant", index_field="index", query_filter={"net_id": net_id})
+
+        if name is None:
+            name = f"{default_name}  {index + 1}"
+        now = int(time.time())
+        variant = {
+            "net_id": net_id,
+            "index": index,
+            "name": name,
+            "date_created": now,
+            "date_changed": now,
+        }
+        db["variant"].insert_one(variant)
+        del variant["_id"]
+        return variant
 
     def delete_variant(self, net_id, index):
         db = self._get_project_database()
-        collection_names = self._get_net_collections(db)
+        collection_names = self.get_net_collections(db)
         for coll in collection_names:
             # remove references to deleted objects
             db[coll].update_many(
@@ -1775,12 +1843,17 @@ class PandaHub:
         dict
             mongodb query filter for the given variant
         """
-        validate_variant_type(variant)
+        self.validate_variant(variant)
         if variant is None:
             return self.base_variant_filter
         return {"$or": [{"var_type": "base", "not_in_var": {"$ne": variant}},
                         {"var_type": {"$in": ["change", "addition"]}, "variant": variant}, ]}
 
+    def validate_variant(self, variant: int | None, element_type: str | None = None):
+        """Raise a ValueError if variant is not int | None or element_type does not support variants."""
+        validate_variant_type(variant)
+        if element_type is not None and variant is not None and element_type in self._elements_without_vars:
+            raise ValueError(f"{element_type} does not support variants")
 
     # -------------------------
     # Bulk operations
@@ -2976,7 +3049,7 @@ class PandaHub:
             "ph.create_element_in_db was renamed - use ph.create_element instead!"
         )
         return self.create_element(
-            net=net,
+            net_id=net,
             element_type=element,
             element_index=element_index,
             element_data=data,
@@ -2997,7 +3070,7 @@ class PandaHub:
             "Watch out for changed order of project_id and variant args"
         )
         return self.create_elements(
-            net=net,
+            net_id=net,
             element_type=element_type,
             elements_data=elements_data,
             variant=variant,
@@ -3011,13 +3084,52 @@ class PandaHub:
             "ph.delete_net_element was renamed - use ph.delete_element instead!"
         )
         return self.delete_element(
-            net=net,
+            net_id=net,
             element_type=element,
             element_index=element_index,
             variant=variant,
             project_id=project_id,
         )
 
+    def get_net_from_db(self, *args, **kwargs):
+        msg = ("Getting a network by name can be ambiguous and will throw an error if more than one Network with the "
+               "given name exists. Preferably, switch to get_network() and pass the network id. "
+               "If you want to continue to retrieve a network by its name, switch to get_network_by_name(). "
+               "get_net_from_db() will be removed in future versions.")
+        warnings.warn(msg, DeprecationWarning)
+        return self.get_network_by_name(*args, **kwargs)
+
+    def get_net_from_db_by_id(self, *args, **kwargs):
+        msg = "get_net_from_db_by_id() has been renamed - use get_network() as drop-in replacement. This function will be removed in future versions."
+        warnings.warn(msg, DeprecationWarning)
+        self.get_network(*args, **kwargs)
+
+    def get_subnet_from_db(self, *args, **kwargs):
+        msg = ("Getting a network by name can be ambiguous and will throw an error if more than one Network with the "
+               "given name exists. Preferably, switch to get_subnet() and pass the network id. "
+               "If you want to continue to retrieve a subnet by its name, switch to get_subnet_by_name(). "
+               "get_subnet_from_db() will be removed in future versions.")
+        warnings.warn(msg, DeprecationWarning)
+        return self.get_subnet_by_name(*args, **kwargs)
+
+    def get_subnet_from_db_by_id(self,*args, **kwargs):
+        msg = "get_subnet_from_db_by_id() has been renamed - use get_subnet() as drop-in replacement. This function will be removed in future versions."
+        warnings.warn(msg, DeprecationWarning)
+        return self.get_subnet(*args, **kwargs)
+
+    def delete_net_from_db(self, name):
+        msg = ("Deleting a network by name can be ambiguous and will throw an error if more than one Network with the "
+               "given name exists. Preferably, switch to delete_network() and pass the network id. "
+               "If you want to continue to delete a net by its name, switch to delete_network_by_name(). "
+               "delete_net_from_db() will be removed in future versions.")
+        warnings.warn(msg, DeprecationWarning)
+        return self.delete_network_by_name(name)
+
+    def _get_net_collections(self, db, with_areas=True):
+        msg = "_get_net_collections() has been made public - use get_net_collections() as drop-in replacement. This function will be removed in future versions."
+        warnings.warn(msg, DeprecationWarning)
+        return self.get_net_collections(db, with_areas)
+
 
 if __name__ == "__main__":
     self = PandaHub()

{pandahub-0.3.8 → pandahub-0.3.10}/pandahub.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pandahub
-Version: 0.3.8
+Version: 0.3.10
 Summary: Data hub for pandapower and pandapipes networks based on MongoDB
 Author-email: Jan Ulffers <jan.ulffers@iee.fraunhofer.de>, Leon Thurner <leon.thurner@retoflow.de>, Jannis Kupka <jannis.kupka@retoflow.de>, Mike Vogt <mike.vogt@iee.fraunhofer.de>, Joschka Thurner <joschka.thurner@retoflow.de>, Alexander Scheidler <alexander.scheidler@iee.fraunhofer.de>
 License: Copyright (c) 2022 by University of Kassel, Fraunhofer Institute for Energy Economics

{pandahub-0.3.8 → pandahub-0.3.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pandahub"
-version = "0.3.8"  # File format version '__format_version__' is tracked in __init__.py
+version = "0.3.10"  # File format version '__format_version__' is tracked in __init__.py
 authors=[
     { name = "Jan Ulffers", email = "jan.ulffers@iee.fraunhofer.de" },
     { name = "Leon Thurner", email = "leon.thurner@retoflow.de" },

{pandahub-0.3.8 → pandahub-0.3.10}/test/performance_test.py

@@ -17,13 +17,13 @@ def get_test_net(n_buses):
     pp.create_sgens(net, net.bus.index[::50], p_mw=0, q_mvar=0)
     pp.create_gens(net, net.bus.index[::1000], p_mw=0, q_mvar=0)
     pp.create_lines(net, net.bus.index[::2], net.bus.index[1::2], 1.0, "NAYY 4x50 SE")
-    pp.create_transformers_from_parameters(net, net.bus.index[::1000], 
+    pp.create_transformers_from_parameters(net, net.bus.index[::1000],
                                             net.bus.index[1::1000],
                                             vn_hv_kv=20.,
                                             vn_lv_kv=0.4,
                                             sn_mva=0.4,
                                             vkr_percent=5.,
-                                            vk_percent=0.5, 
+                                            vk_percent=0.5,
                                             pfe_kw=0,
                                             i0_percent=0,
                                             )
@@ -31,7 +31,7 @@ def get_test_net(n_buses):
     line_indices = list(net.line.index) + list(net.line.index)
     pp.create_switches(net, line_buses, line_indices, "l")
     return net
-    
+
 def write_test_net_to_mongodb(net, project_name):
     ph = PandaHub()
     if ph.project_exists(project_name):
@@ -39,14 +39,14 @@ def write_test_net_to_mongodb(net, project_name):
         ph.delete_project(True)
     ph.create_project(project_name)
     ph.write_network_to_db(net, "test_net")
-    
+
 def load_test_subnet_from_mongodb(project_name):
     ph = PandaHub()
     ph.set_active_project(project_name)
     buses = list(range(1000))
     t0 = time.time()
-    subnet = ph.get_subnet_from_db("test_net", 
-                                 bus_filter={"index": {"$in": buses}})
+    subnet = ph.get_subnet_by_name("test_net",
+                                   bus_filter={"index": {"$in": buses}})
     t1 = time.time()
     print("LOADED NET IN %.2fs"%(t1-t0))
     return subnet
@@ -54,11 +54,11 @@ def load_test_subnet_from_mongodb(project_name):
 def profile_load_test(project_name):
     lp = LineProfiler()
     lp_wrapper = lp(load_test_subnet_from_mongodb)
-    lp.add_function(PandaHub.get_subnet_from_db_by_id)
+    lp.add_function(PandaHub.get_subnet)
     lp.add_function(PandaHub._add_element_from_collection)
     lp_wrapper(project_name)
     lp.print_stats()
-    
+
 if __name__ == '__main__':
     n_buses = 3e6 #3 Million buses
     project_name = "test_%u"%n_buses

{pandahub-0.3.8 → pandahub-0.3.10}/test/test_networks.py

@@ -21,7 +21,7 @@ def test_additional_res_tables(ph):
     net1 = pp.create_empty_network()
     net1['res_test'] = pd.DataFrame(data={'col1': [1, 2], 'col2': [3, 4]})
     ph.write_network_to_db(net1, 'test')
-    net2 = ph.get_net_from_db('test')
+    net2 = ph.get_network_by_name('test')
 
     assert('res_test' in net2)
     assert(net1.res_test.shape == (2,2))
@@ -50,14 +50,14 @@ def test_network_io(ph):
     # we check storing two different networks consecutively to ensure the nets are properly separated
     for net, name in [(net1, name1), (net2, name2)]:
         if ph.network_with_name_exists(name):
-            ph.delete_net_from_db(name)
+            ph.delete_network_by_name(name)
 
         assert ph.network_with_name_exists(name) == False
 
         ph.write_network_to_db(net, name)
         assert ph.network_with_name_exists(name) == True
 
-        net_loaded = ph.get_net_from_db(name)
+        net_loaded = ph.get_network_by_name(name)
 
         pp.runpp(net)
         pp.runpp(net_loaded)
@@ -66,18 +66,18 @@ def test_network_io(ph):
         # doesn't compare to itself
         # assert pp.nets_equal(net, net_loaded, check_dtype=False)
 
-        net3 = ph.get_net_from_db(name, only_tables=["bus"])
+        net3 = ph.get_network_by_name(name, only_tables=["bus"])
         assert len(net3.bus) == len(net.bus)
         assert len(net3.line) == 0
         assert len(net3.load) == 0
 
     # delete first network
-    ph.delete_net_from_db(name1)
+    ph.delete_network_by_name(name1)
     assert ph.network_with_name_exists(name1) == False
 
     # check that second network is still in database
     assert ph.network_with_name_exists(name2) == True
-    net2_loaded = ph.get_net_from_db(name2)
+    net2_loaded = ph.get_network_by_name(name2)
     pp.runpp(net2_loaded)
     assert pp.nets_equal(net2, net2_loaded, check_only_results=True)
 
@@ -90,20 +90,20 @@ def test_load_subnetwork(ph):
         net = nw_pp.mv_oberrhein()
         ph.write_network_to_db(net, name)
 
-    subnet = ph.get_subnet_from_db(name, bus_filter={"vn_kv": 110})
+    subnet = ph.get_subnet_by_name(name, bus_filter={"vn_kv": 110})
     expected_sizes = [("bus", 4), ("line", 0), ("trafo", 2), ("ext_grid", 2)]
 
     for element, size in expected_sizes:
         assert len(subnet[element]) == size
         assert len(subnet["res_" + element]) == size
 
-    subnet = ph.get_subnet_from_db(name, bus_filter={"vn_kv": 110},
+    subnet = ph.get_subnet_by_name(name, bus_filter={"vn_kv": 110},
                                    include_results=False)
     for element, size in expected_sizes:
         assert len(subnet[element]) == size
         assert len(subnet["res_" + element]) == 0
 
-    subnet = ph.get_subnet_from_db(name, bus_filter={"vn_kv": 110},
+    subnet = ph.get_subnet_by_name(name, bus_filter={"vn_kv": 110},
                                    add_edge_branches=False)
     expected_sizes = [("bus", 2), ("line", 0), ("trafo", 0), ("ext_grid", 2)]
 
@@ -135,7 +135,7 @@ def test_access_and_set_single_values(ph):
     ph.delete_element(name, element, index)
     with pytest.raises(PandaHubError):
         ph.get_net_value_from_db(name, element, index, parameter)
-    net = ph.get_net_from_db(name)
+    net = ph.get_network_by_name(name)
     assert index not in net[element].index
 
 
@@ -143,7 +143,7 @@ def test_pandapipes(ph):
     ph.set_active_project('pytest')
     net = nw_pps.gas_versatility()
     ph.write_network_to_db(net, 'versatility')
-    net2 = ph.get_net_from_db('versatility', convert=False)
+    net2 = ph.get_network_by_name('versatility', convert=False)
     pps.pipeflow(net)
     pps.pipeflow(net2)
     assert nets_equal(net, net2, check_only_results=True)
@@ -167,7 +167,7 @@ if __name__ == '__main__':
     ph.create_project('pytest')
     net = nw_pps.gas_versatility()
     ph.write_network_to_db(net, 'versatility')
-    net2 = ph.get_net_from_db('versatility')
+    net2 = ph.get_network_by_name('versatility')
     pps.pipeflow(net)
     pps.pipeflow(net2)
     # test_network_io(ph)

{pandahub-0.3.8 → pandahub-0.3.10}/test/test_projects.py

@@ -53,7 +53,7 @@ def test_upgrade_project():
                 raise pandahub.PandaHubError("net must be a pandapower or pandapipes object")
             if self._network_with_name_exists(name, db):
                 if overwrite:
-                    self.delete_net_from_db(name)
+                    self.delete_network_by_name(name)
                 else:
                     raise pandahub.PandaHubError("Network name already exists")
             max_id_network = db["_networks"].find_one(sort=[("_id", -1)])
@@ -92,7 +92,7 @@ def test_upgrade_project():
     ph.set_active_project("pytest")
     ph.upgrade_project_to_latest_version()
     # and test if everything went fine
-    net2 = ph.get_net_from_db("simple_network")
+    net2 = ph.get_network_by_name("simple_network")
     assert pp.nets_equal(net, net2, check_dtype=False)