zepben.ewb 1.1.0b12__tar.gz → 1.1.0b14__tar.gz

{zepben_ewb-1.1.0b12/src/zepben.ewb.egg-info → zepben_ewb-1.1.0b14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zepben.ewb
-Version: 1.1.0b12
+Version: 1.1.0b14
 Summary: Python SDK for interacting with the Energy Workbench platform
 Author-email: Kurt Greaves <kurt.greaves@zepben.com>, Max Chesterfield <max.chesterfield@zepben.com>
 License-Expression: MPL-2.0

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14}/pyproject.toml

@@ -13,7 +13,7 @@
 
 [project]
     name = "zepben.ewb"
-    version = "1.1.0b12"
+    version = "1.1.0b14"
     description = "Python SDK for interacting with the Energy Workbench platform"
     readme = {file = "README.md", content-type = "text/markdown"}
     license = "MPL-2.0"

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14}/src/zepben/ewb/model/cim/iec61970/base/core/identified_object.py

@@ -14,7 +14,7 @@ from typing import Callable, Any, List, Generator, Optional, overload, TypeVar
 from zepben.ewb.dataclassy import dataclass
 from zepben.ewb.model.cim.iec61970.base.core.name import Name
 from zepben.ewb.model.cim.iec61970.base.core.name_type import NameType
-from zepben.ewb.util import require, CopyableUUID, nlen, ngen, safe_remove
+from zepben.ewb.util import require, nlen, ngen, safe_remove
 
 logger = logging.getLogger(__name__)
 
@@ -30,7 +30,7 @@ class IdentifiedObject(object, metaclass=ABCMeta):
     relation, however must be in snake case to keep the phases PEP compliant.
     """
 
-    mrid: str = CopyableUUID()
+    mrid: str
     """Master resource identifier issued by a model authority. The mRID is unique within an exchange context. 
     Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended."""
 
@@ -46,6 +46,9 @@ class IdentifiedObject(object, metaclass=ABCMeta):
 
     def __init__(self, names: Optional[List[Name]] = None, **kwargs):
         super(IdentifiedObject, self).__init__(**kwargs)
+        if not self.mrid or not self.mrid.strip():
+            raise ValueError("You must provide an mRID for this object.")
+
         if names:
             for name in names:
                 self.add_name(name.type, name.name)

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14}/src/zepben/ewb/model/cim/iec61970/base/wires/regulating_cond_eq.py

@@ -28,7 +28,8 @@ class RegulatingCondEq(EnergyConnection):
 
     def __init__(self, regulating_control: Optional[RegulatingControl] = None, **kwargs):
         super(RegulatingCondEq, self).__init__(**kwargs)
-        self.regulating_control = regulating_control
+        if regulating_control:
+            self.regulating_control = regulating_control
 
     @property
     def regulating_control(self):

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14}/src/zepben/ewb/services/common/translator/base_proto2cim.py

@@ -79,7 +79,7 @@ def document_to_cim(pb: PBDocument, cim: Document, service: BaseService):
 @bind_to_cim
 @add_to_network_or_none
 def organisation_to_cim(pb: PBOrganisation, service: BaseService) -> Optional[Organisation]:
-    cim = Organisation()
+    cim = Organisation(mrid=pb.mrid())
 
     identified_object_to_cim(pb.io, cim, service)
     return cim

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14}/src/zepben/ewb/services/network/network_extensions.py

@@ -18,7 +18,7 @@ from zepben.ewb.model.cim.iec61970.base.wires.junction import Junction
 from zepben.ewb.model.cim.iec61970.base.wires.power_transformer import PowerTransformer
 from zepben.ewb.model.cim.iec61970.base.wires.power_transformer_end import PowerTransformerEnd
 from zepben.ewb.services.network.network_service import NetworkService
-from zepben.ewb.util import CopyableUUID
+from zepben.ewb.util import generate_id
 
 
 # !! WARNING !! #
@@ -39,7 +39,7 @@ def create_two_winding_power_transformer(network_service: NetworkService, cn1: C
     _connect_two_terminal_conducting_equipment(network_service=network_service, ce=power_transformer, cn1=cn1, cn2=cn2)
     # TODO: How to associated PowerTransformerEndInfo to a PowerTransformerInfo
     for i in range(1, 2):
-        end = PowerTransformerEnd(power_transformer=power_transformer)
+        end = PowerTransformerEnd(f"{power_transformer.mrid}-pte{i}", power_transformer=power_transformer)
         power_transformer.add_end(end)
         end.terminal = power_transformer.get_terminal_by_sn(i)
     return power_transformer
@@ -69,7 +69,7 @@ def create_breaker(network_service: NetworkService, cn1: ConnectivityNode, cn2:
 def create_bus(network_service: NetworkService, **kwargs) -> Junction:
     bus = Junction(**kwargs)
     if 'mrid' not in kwargs:
-        bus.mrid = str(CopyableUUID())
+        bus.mrid = generate_id()
     network_service.add(bus)
     _create_terminals(ce=bus, network=network_service)
     # TODO: Figure out how to add Voltage to Buses - Looks like we need to add topologicalNode to support the
@@ -79,7 +79,7 @@ def create_bus(network_service: NetworkService, **kwargs) -> Junction:
 
 def _create_two_terminal_conducting_equipment(network_service: NetworkService, ce: ConductingEquipment, **kwargs):
     if 'mrid' not in kwargs:
-        ce.mrid = str(CopyableUUID())
+        ce.mrid = generate_id()
     network_service.add(ce)
     _create_terminals(ce=ce, num_terms=2, network=network_service)
 
@@ -92,7 +92,7 @@ def _connect_two_terminal_conducting_equipment(network_service: NetworkService,
 
 def _create_single_terminal_conducting_equipment(network_service: NetworkService, ce: ConductingEquipment, **kwargs):
     if 'mrid' not in kwargs:
-        ce.mrid = str(CopyableUUID())
+        ce.mrid = generate_id()
     network_service.add(ce)
     _create_terminals(ce=ce, network=network_service)
 

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14}/src/zepben/ewb/util.py

@@ -15,7 +15,7 @@ __all__ = [
     "is_none_or_empty",
     "require",
     "pb_or_none",
-    "CopyableUUID",
+    "generate_id",
     "datetime_to_timestamp",
     "none",
     "classproperty",
@@ -170,14 +170,8 @@ def none(collection: Collection):
     raise ValueError("none() only supports collection types")
 
 
-class CopyableUUID(UUID):
-
-    def __init__(self):
-        super().__init__(bytes=os.urandom(16), version=4)
-
-    @staticmethod
-    def copy():
-        return str(UUID(bytes=os.urandom(16), version=4))
+def generate_id() -> str:
+    return str(UUID(bytes=os.urandom(16), version=4))
 
 
 class classproperty(property):

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14/src/zepben.ewb.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zepben.ewb
-Version: 1.1.0b12
+Version: 1.1.0b14
 Summary: Python SDK for interacting with the Energy Workbench platform
 Author-email: Kurt Greaves <kurt.greaves@zepben.com>, Max Chesterfield <max.chesterfield@zepben.com>
 License-Expression: MPL-2.0

{zepben_ewb-1.1.0b12 → zepben_ewb-1.1.0b14}/test/test_util.py

@@ -2,7 +2,9 @@
 #  This Source Code Form is subject to the terms of the Mozilla Public
 #  License, v. 2.0. If a copy of the MPL was not distributed with this
 #  file, You can obtain one at https://mozilla.org/MPL/2.0/.
-from zepben.ewb.util import none
+from uuid import UUID
+
+from zepben.ewb.util import none, generate_id
 
 
 def test_none():
@@ -17,3 +19,10 @@ def test_none():
     assert none([0, 0, 0])
     assert none([[], [], []])
     assert not none([[], [False], []])
+
+def test_generate_id():
+    # make sure our generated ID is a valid UUID.
+    UUID(generate_id())
+
+    # Make sure each call gives a new UUID.
+    assert generate_id() != generate_id()