zepben.ewb 1.0.0b9__py3-none-any.whl → 1.0.0b10__py3-none-any.whl

zepben/ewb/model/cim/iec61970/base/wires/transformer_star_impedance.py

@@ -21,16 +21,16 @@ class TransformerStarImpedance(IdentifiedObject):
     For transmission networks use PowerTransformerEnd impedances (r, r0, x, x0, b, b0, g and g0).
     """
 
-    r: Optional[float] = 0.0
+    r: Optional[float] = None
     """ r : Resistance of the transformer end. Unit: Ohms  """
 
-    r0: Optional[float] = 0.0
+    r0: Optional[float] = None
     """ r0 : Zero sequence series resistance of the transformer end. Unit: Ohms"""
 
-    x: Optional[float] = 0.0
+    x: Optional[float] = None
     """ x : Positive sequence series reactance  of the transformer end. Unit: Ohms"""
 
-    x0: Optional[float] = 0.0
+    x0: Optional[float] = None
     """ x0 : Zero sequence series reactance of the transformer end. Unit: Ohms"""
 
     transformer_end_info: Optional['TransformerEndInfo'] = None

zepben/ewb/services/common/translator/base_cim2proto.py

@@ -6,10 +6,11 @@
 __all__ = ["identified_object_to_pb", "document_to_pb", "organisation_role_to_pb", "organisation_to_pb"]
 
 import inspect
-from typing import ParamSpec, TypeVar, Callable
+from typing import ParamSpec, TypeVar, Callable, Generator
 
 # noinspection PyPackageRequirements,PyUnresolvedReferences
 from google.protobuf.timestamp_pb2 import Timestamp as PBTimestamp
+from google.protobuf.struct_pb2 import NullValue
 from zepben.protobuf.cim.iec61968.common.Document_pb2 import Document as PBDocument
 from zepben.protobuf.cim.iec61968.common.OrganisationRole_pb2 import OrganisationRole as PBOrganisationRole
 from zepben.protobuf.cim.iec61968.common.Organisation_pb2 import Organisation as PBOrganisation
@@ -38,6 +39,11 @@ def bind_to_pb(func: Callable[P, R]) -> Callable[P, R]:
     inspect.get_annotations(func, eval_str=True)[func.__code__.co_varnames[0]].to_pb = func
     return func
 
+
+def set_or_null(**kwargs):
+    return {f'{k}{"Null" if v is None else "Set"}': v if v is not None else NullValue.NULL_VALUE for k, v in kwargs.items()}
+
+
 ###################
 # IEC61968 Common #
 ###################
@@ -51,12 +57,14 @@ def document_to_pb(cim: Document) -> PBDocument:
 
     return PBDocument(
         io=identified_object_to_pb(cim),
-        title=cim.title,
         createdDateTime=timestamp,
-        authorName=cim.author_name,
-        type=cim.type,
-        status=cim.status,
-        comment=cim.comment
+        **set_or_null(
+            title=cim.title,
+            authorName=cim.author_name,
+            type=cim.type,
+            status=cim.status,
+            comment=cim.comment
+        )
     )
 
 
@@ -81,8 +89,10 @@ def organisation_role_to_pb(cim: OrganisationRole) -> PBOrganisationRole:
 def identified_object_to_pb(cim: IdentifiedObject) -> PBIdentifiedObject:
     return PBIdentifiedObject(
         mRID=str(cim.mrid),
-        name=cim.name,
-        description=cim.description,
+        **set_or_null(
+            name=cim.name,
+            description=cim.description
+        ),
         names=[name_to_pb(name) for name in cim.names]
     )
 
@@ -99,5 +109,7 @@ def name_to_pb(cim: Name) -> PBName:
 def name_type_to_pb(cim: NameType) -> PBNameType:
     return PBNameType(
         name=cim.name,
-        description=cim.description
+        **set_or_null(
+            description=cim.description
+        )
     )

zepben/ewb/services/common/translator/base_proto2cim.py

@@ -54,6 +54,11 @@ def bind_to_cim(func: Callable[P, R]) -> Callable[P, R]:
     inspect.get_annotations(func, eval_str=True)[func.__code__.co_varnames[0]].to_cim = func
     return func
 
+T = TypeVar("T")
+
+def get_nullable(pb: Message, field: str) -> Optional[T]:
+    return getattr(pb, f'{field}Set') if pb.HasField(f'{field}Set') else None
+
 
 ###################
 # IEC61968 Common #
@@ -61,12 +66,12 @@ def bind_to_cim(func: Callable[P, R]) -> Callable[P, R]:
 
 @bind_to_cim
 def document_to_cim(pb: PBDocument, cim: Document, service: BaseService):
-    cim.title = pb.title
+    cim.title = get_nullable(pb, 'title')
     cim.created_date_time = pb.createdDateTime.ToDatetime() if pb.HasField("createdDateTime") else None
-    cim.author_name = pb.authorName
-    cim.type = pb.type
-    cim.status = pb.status
-    cim.comment = pb.comment
+    cim.author_name = get_nullable(pb, 'authorName')
+    cim.type = get_nullable(pb, 'type')
+    cim.status = get_nullable(pb, 'status')
+    cim.comment = get_nullable(pb, 'comment')
 
     identified_object_to_cim(pb.io, cim, service)
 
@@ -94,8 +99,8 @@ def organisation_role_to_cim(pb: PBOrganisationRole, cim: OrganisationRole, serv
 @bind_to_cim
 def identified_object_to_cim(pb: PBIdentifiedObject, cim: IdentifiedObject, service: BaseService):
     cim.mrid = pb.mRID
-    cim.name = pb.name
-    cim.description = pb.description
+    cim.name = get_nullable(pb, 'name')
+    cim.description = get_nullable(pb, 'description')
     [cim.add_name(name_to_cim(name, cim, service).type, name.name) for name in pb.names]
 
 
@@ -120,7 +125,7 @@ def name_type_to_cim(pb: PBNameType, service: BaseService):
         nt = NameType(pb.name)
         service.add_name_type(nt)
 
-    nt.description = pb.description
+    nt.description = get_nullable(pb, 'description')
     return nt
 
 

zepben/ewb/services/customer/translator/customer_cim2proto.py

@@ -16,7 +16,7 @@ from zepben.ewb.model.cim.iec61968.customers.customer import Customer
 from zepben.ewb.model.cim.iec61968.customers.customer_agreement import CustomerAgreement
 from zepben.ewb.model.cim.iec61968.customers.pricing_structure import PricingStructure
 from zepben.ewb.model.cim.iec61968.customers.tariff import Tariff
-from zepben.ewb.services.common.translator.base_cim2proto import document_to_pb, organisation_role_to_pb
+from zepben.ewb.services.common.translator.base_cim2proto import document_to_pb, organisation_role_to_pb, set_or_null, bind_to_pb
 from zepben.ewb.services.common.translator.util import mrid_or_empty
 # noinspection PyProtectedMember
 from zepben.ewb.services.customer.translator.customer_enum_mappers import _map_customer_kind
@@ -26,6 +26,7 @@ from zepben.ewb.services.customer.translator.customer_enum_mappers import _map_c
 # IEC61968 Common #
 ###################
 
+@bind_to_pb
 def agreement_to_pb(cim: Agreement) -> PBAgreement:
     return PBAgreement(doc=document_to_pb(cim))
 
@@ -34,17 +35,21 @@ def agreement_to_pb(cim: Agreement) -> PBAgreement:
 # IEC61968 Customers #
 ######################
 
+@bind_to_pb
 def customer_to_pb(cim: Customer) -> PBCustomer:
     customer = PBCustomer(
         kind=_map_customer_kind.to_pb(cim.kind),
-        specialNeed=cim.special_need,
-        customerAgreementMRIDs=[str(io.mrid) for io in cim.agreements]
+        customerAgreementMRIDs=[str(io.mrid) for io in cim.agreements],
+        **set_or_null(
+            specialNeed=cim.special_need,
+        )
     )
 
     getattr(customer, 'or').CopyFrom(organisation_role_to_pb(cim))
     return customer
 
 
+@bind_to_pb
 def customer_agreement_to_pb(cim: CustomerAgreement) -> PBCustomerAgreement:
     return PBCustomerAgreement(
         agr=agreement_to_pb(cim),
@@ -53,6 +58,7 @@ def customer_agreement_to_pb(cim: CustomerAgreement) -> PBCustomerAgreement:
     )
 
 
+@bind_to_pb
 def pricing_structure_to_pb(cim: PricingStructure) -> PBPricingStructure:
     return PBPricingStructure(
         doc=document_to_pb(cim),
@@ -60,12 +66,6 @@ def pricing_structure_to_pb(cim: PricingStructure) -> PBPricingStructure:
     )
 
 
+@bind_to_pb
 def tariff_to_pb(cim: Tariff) -> PBTariff:
     return PBTariff(doc=document_to_pb(cim))
-
-
-Agreement.to_pb = agreement_to_pb
-Customer.to_pb = customer_to_pb
-CustomerAgreement.to_pb = customer_agreement_to_pb
-PricingStructure.to_pb = pricing_structure_to_pb
-Tariff.to_pb = tariff_to_pb

zepben/ewb/services/customer/translator/customer_proto2cim.py

@@ -16,12 +16,13 @@ from zepben.protobuf.cim.iec61968.customers.PricingStructure_pb2 import PricingS
 from zepben.protobuf.cim.iec61968.customers.Tariff_pb2 import Tariff as PBTariff
 
 import zepben.ewb.services.common.resolver as resolver
-from zepben.ewb import organisation_role_to_cim, document_to_cim, BaseService, CustomerKind
+from zepben.ewb import organisation_role_to_cim, document_to_cim, BaseService, CustomerKind, bind_to_cim
 from zepben.ewb.model.cim.iec61968.common.agreement import Agreement
 from zepben.ewb.model.cim.iec61968.customers.customer import Customer
 from zepben.ewb.model.cim.iec61968.customers.customer_agreement import CustomerAgreement
 from zepben.ewb.model.cim.iec61968.customers.pricing_structure import PricingStructure
 from zepben.ewb.model.cim.iec61968.customers.tariff import Tariff
+from zepben.ewb.services.common.translator.base_proto2cim import get_nullable
 from zepben.ewb.services.customer.customers import CustomerService
 
 
@@ -29,6 +30,7 @@ from zepben.ewb.services.customer.customers import CustomerService
 # IEC61968 Common #
 ###################
 
+@bind_to_cim
 def agreement_to_cim(pb: PBAgreement, cim: Agreement, service: BaseService):
     document_to_cim(pb.doc, cim, service)
 
@@ -37,11 +39,13 @@ def agreement_to_cim(pb: PBAgreement, cim: Agreement, service: BaseService):
 # IEC61968 Customers #
 ######################
 
+@bind_to_cim
 def customer_to_cim(pb: PBCustomer, service: CustomerService) -> Optional[Customer]:
     cim = Customer(
         mrid=pb.mrid(),
         kind=CustomerKind(pb.kind),
-        special_need=pb.specialNeed if pb.specialNeed else None
+        # TODO: missing num_end_devices from jvm sdk
+        special_need=get_nullable(pb, 'specialNeed')
     )
 
     for mrid in pb.customerAgreementMRIDs:
@@ -51,6 +55,7 @@ def customer_to_cim(pb: PBCustomer, service: CustomerService) -> Optional[Custom
     return cim if service.add(cim) else None
 
 
+@bind_to_cim
 def customer_agreement_to_cim(pb: PBCustomerAgreement, service: CustomerService) -> Optional[CustomerAgreement]:
     cim = CustomerAgreement(mrid=pb.mrid())
 
@@ -62,6 +67,7 @@ def customer_agreement_to_cim(pb: PBCustomerAgreement, service: CustomerService)
     return cim if service.add(cim) else None
 
 
+@bind_to_cim
 def pricing_structure_to_cim(pb: PBPricingStructure, service: CustomerService) -> Optional[PricingStructure]:
     cim = PricingStructure(mrid=pb.mrid())
 
@@ -72,16 +78,10 @@ def pricing_structure_to_cim(pb: PBPricingStructure, service: CustomerService) -
     return cim if service.add(cim) else None
 
 
+@bind_to_cim
 def tariff_to_cim(pb: PBTariff, service: CustomerService) -> Optional[Tariff]:
     # noinspection PyArgumentList
     cim = Tariff(mrid=pb.mrid())
 
     document_to_cim(pb.doc, cim, service)
     return cim if service.add(cim) else None
-
-
-PBAgreement.to_cim = agreement_to_cim
-PBCustomer.to_cim = customer_to_cim
-PBCustomerAgreement.to_cim = customer_agreement_to_cim
-PBPricingStructure.to_cim = pricing_structure_to_cim
-PBTariff.to_cim = tariff_to_cim

zepben/ewb/services/diagram/translator/diagram_cim2proto.py

@@ -12,7 +12,7 @@ from zepben.protobuf.cim.iec61970.base.diagramlayout.Diagram_pb2 import Diagram
 from zepben.ewb.model.cim.iec61970.base.diagramlayout.diagram import Diagram
 from zepben.ewb.model.cim.iec61970.base.diagramlayout.diagram_object import DiagramObject
 from zepben.ewb.model.cim.iec61970.base.diagramlayout.diagram_object_point import DiagramObjectPoint
-from zepben.ewb.services.common.translator.base_cim2proto import identified_object_to_pb
+from zepben.ewb.services.common.translator.base_cim2proto import identified_object_to_pb, set_or_null, bind_to_pb
 from zepben.ewb.services.common.translator.util import mrid_or_empty
 # noinspection PyProtectedMember
 from zepben.ewb.services.diagram.translator.diagram_enum_mappers import _map_diagram_style, _map_orientation_kind
@@ -22,6 +22,7 @@ from zepben.ewb.services.diagram.translator.diagram_enum_mappers import _map_dia
 # IEC61970 Base Diagram Layout #
 ################################
 
+@bind_to_pb
 def diagram_to_pb(cim: Diagram) -> PBDiagram:
     return PBDiagram(
         io=identified_object_to_pb(cim),
@@ -31,21 +32,20 @@ def diagram_to_pb(cim: Diagram) -> PBDiagram:
     )
 
 
+@bind_to_pb
 def diagram_object_to_pb(cim: DiagramObject) -> PBDiagramObject:
     return PBDiagramObject(
         io=identified_object_to_pb(cim),
         diagramMRID=mrid_or_empty(cim.diagram),
         identifiedObjectMRID=cim.identified_object_mrid,
-        diagramObjectStyle=cim.style,
+        diagramObjectPoints=[diagram_object_point_to_pb(io) for io in cim.points],
         rotation=cim.rotation,
-        diagramObjectPoints=[diagram_object_point_to_pb(io) for io in cim.points]
+        **set_or_null(
+            diagramObjectStyle=cim.style,
+        )
     )
 
 
+@bind_to_pb
 def diagram_object_point_to_pb(cim: DiagramObjectPoint) -> PBDiagramObjectPoint:
     return PBDiagramObjectPoint(xPosition=cim.x_position, yPosition=cim.y_position)
-
-
-Diagram.to_pb = diagram_to_pb
-DiagramObject.to_pb = diagram_object_to_pb
-DiagramObjectPoint.to_pb = diagram_object_point_to_pb

zepben/ewb/services/diagram/translator/diagram_proto2cim.py

@@ -10,10 +10,11 @@ from zepben.protobuf.cim.iec61970.base.diagramlayout.DiagramObject_pb2 import Di
 from zepben.protobuf.cim.iec61970.base.diagramlayout.Diagram_pb2 import Diagram as PBDiagram
 
 import zepben.ewb.services.common.resolver as resolver
-from zepben.ewb import identified_object_to_cim, OrientationKind, DiagramStyle
+from zepben.ewb import identified_object_to_cim, OrientationKind, DiagramStyle, add_to_network_or_none, bind_to_cim
 from zepben.ewb.model.cim.iec61970.base.diagramlayout.diagram import Diagram
 from zepben.ewb.model.cim.iec61970.base.diagramlayout.diagram_object import DiagramObject
 from zepben.ewb.model.cim.iec61970.base.diagramlayout.diagram_object_point import DiagramObjectPoint
+from zepben.ewb.services.common.translator.base_proto2cim import get_nullable
 from zepben.ewb.services.diagram.diagrams import DiagramService
 
 
@@ -21,6 +22,8 @@ from zepben.ewb.services.diagram.diagrams import DiagramService
 # IEC61970 Base Diagram Layout #
 ################################
 
+@bind_to_cim
+@add_to_network_or_none
 def diagram_to_cim(pb: PBDiagram, service: DiagramService):
     cim = Diagram(
         mrid=pb.mrid(),
@@ -32,14 +35,15 @@ def diagram_to_cim(pb: PBDiagram, service: DiagramService):
         service.resolve_or_defer_reference(resolver.diagram_objects(cim), mrid)
 
     identified_object_to_cim(pb.io, cim, service)
-    return cim if service.add(cim) else None
+    return cim
 
 
+@bind_to_cim
 def diagram_object_to_cim(pb: PBDiagramObject, service: DiagramService):
     cim = DiagramObject(
         mrid=pb.mrid(),
         identified_object_mrid=pb.identifiedObjectMRID if pb.identifiedObjectMRID else None,
-        style=pb.diagramObjectStyle if pb.diagramObjectStyle else None,
+        style=get_nullable(pb, 'diagramObjectStyle'),
         rotation=pb.rotation,
     )
 
@@ -51,11 +55,7 @@ def diagram_object_to_cim(pb: PBDiagramObject, service: DiagramService):
     return cim if service.add_diagram_object(cim) else None
 
 
+@bind_to_cim
 def diagram_object_point_to_cim(pb: PBDiagramObjectPoint) -> DiagramObjectPoint:
     # noinspection PyArgumentList
     return DiagramObjectPoint(pb.xPosition, pb.yPosition)
-
-
-PBDiagram.to_cim = diagram_to_cim
-PBDiagramObject.to_cim = diagram_object_to_cim
-PBDiagramObjectPoint.to_cim = diagram_object_point_to_cim

zepben/ewb/services/network/tracing/phases/phase_inferrer.py

@@ -36,9 +36,9 @@ class PhaseInferrer:
         @property
         def description(self) -> str:
             if self.suspect:
-                _inner_desc = f"phases for '{self.conducting_equipment.name}' [{self.conducting_equipment.mrid}] which may not be correct. The phases were inferred"
+                _inner_desc = f"phases for '{str(self.conducting_equipment)}' which may not be correct. The phases were inferred"
             else:
-                _inner_desc = f"phase for '{self.conducting_equipment.name}' [{self.conducting_equipment.mrid}] which should be correct. The phase was inferred"
+                _inner_desc = f"phase for '{str(self.conducting_equipment)}' which should be correct. The phase was inferred"
             return (f'Inferred missing {_inner_desc} due to a disconnected nominal phase because of an '
                     f'upstream error in the source data. Phasing information for the upstream equipment should be fixed in the source system.')