Removed mypy overloads in the Entity class. Use UTC from dateutil everywhere.

Author: fbattello

cookbook/entities/tutorial7_urbanmobility.py

@@ -9,7 +9,8 @@
 #
 # Author: Fabien BATTELLO <fabien.battello@orange.com> et al.
 
-from datetime import datetime, timezone
+from datetime import datetime
+from dateutil.tz import UTC
 from ngsildclient import Entity, PostalAddressBuilder, OpeningHoursBuilder
 from ngsildclient.utils.urn import Urn
 
@@ -23,7 +24,7 @@ def build_entity():
             "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld",
         ],
     )
-    e.tprop("dateModified", datetime(2018, 9, 25, 8, 32, 26, tzinfo=timezone.utc))
+    e.tprop("dateModified", datetime(2018, 9, 25, 8, 32, 26, tzinfo=UTC))
     e.prop("source", "https://api.smartsantander.eu/")
     e.prop("dataProvider", "http://www.smartsantander.eu/")
     e.prop("entityVersion", "2.0")

docs/source/build.rst

@@ -211,9 +211,10 @@ observedAt
 .. code-block::
   :caption: SO2 concentration with the observation date
 
-   from datetime import datetime, timezone
+   from datetime import datetime
+   from dateutil.tz import UTC
 
-   entity.prop("SO2", 11, observedat=datetime(2016, 3, 15, 11, tzinfo=timezone.utc))
+   entity.prop("SO2", 11, observedat=datetime(2016, 3, 15, 11, tzinfo=UTC))
 
    # Alternatively one could pass directly an ISO8601 string
    # entity.prop("SO2", 11, observedat="2016-03-15T11:00:00Z")

docs/source/cookbook.rst

@@ -1883,7 +1883,8 @@ SmartCities_ on SmartDataModels repository.
 .. code-block::
    :caption: UrbanMobility code snippet
 
-   from datetime import datetime, timezone
+   from datetime import datetime
+   from dateutil.tz import UTC
    from ngsildclient import Entity, PostalAddressBuilder, OpeningHoursBuilder
    from ngsildclient.utils.urn import Urn
 
@@ -1895,7 +1896,7 @@ SmartCities_ on SmartDataModels repository.
             "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld",
         ],
     )
-    e.tprop("dateModified", datetime(2018, 9, 25, 8, 32, 26, tzinfo=timezone.utc))
+    e.tprop("dateModified", datetime(2018, 9, 25, 8, 32, 26, tzinfo=UTC))
     e.prop("source", "https://api.smartsantander.eu/")
     e.prop("dataProvider", "http://www.smartsantander.eu/")
     e.prop("entityVersion", "2.0")

src/ngsildclient/model/entity.py

@@ -23,7 +23,6 @@
 from datetime import datetime
 from typing import (
     Sequence,
-    overload,
     Any,
     Union,
     List,
@@ -186,15 +185,24 @@ class Entity:
     >>> e.rm("NO2.accuracy")
     """
 
-    @overload
-    def __init__(self, type: str, id: str, *, ctx: List = None):
+    def __init__(
+        self,
+        *args: str,
+        ctx: List = None,
+        payload: dict = None,
+        autoprefix: Optional[bool] = None,
+    ):
         """Create a NGSI-LD compliant entity
 
-        One can omit the urn and namespace, "urn:ngsi-ld:" will be added automatically.
-        One can omit the type inside the identifier.
+        Expected args are : the Entity's type and identifier.
+        Example : Entity("AirQualityObserved", "RZ:Obsv4567")
+        The fully qualified identifier is built following the naming convention : "urn:ngsi-ld:{type}:{id}'.
+        "urn:ngsi-ld:" is added if not specified.
+
+        Alernatively a single arg is allowed : the fully qualified Entity's identifier.
+        Example : Entity("urn:ngsi-ld:AirQualityObserved:RZ:Obsv4567")
+        Type is inferred from the fully qualified identifier.
 
-        By default, the constructor assumes the identifier naming convention "urn:ngsi-ld:<type>:<remainder>" and
-        automatically insert the type into the identifier.
         The default behaviour can be disabled : Entity.globalsettings.autoprefix = False.
 
 
@@ -224,60 +232,16 @@ def __init__(self, type: str, id: str, *, ctx: List = None):
             "type": "AirQualityObserved"
         }
         """
-        ...
-
-    @overload
-    def __init__(self, id: str, *, ctx: List = None):
-        """Create a NGSI-LD compliant entity.
-
-        Type is inferred from the fully qualified identifier.
-        Works only if your identifiers follow the naming convention "urn:ngsi-ld:<type>:<remainder>"
-
-        Parameters
-        ----------
-        id : str
-            entity identifier (fully qualified urn)
-        context : list, optional
-            the NGSI-LD context, by default the NGSI-LD Core Context
-
-        Example
-        -------
-        >>> from ngsildclient.model.entity import Entity
-        >>> e = Entity("urn:ngsi-ld:AirQualityObserved:RZ:Obsv4567")
-        >>> e.pprint()
-        {
-            "@context": [
-                "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
-            ],
-            "id": "urn:ngsi-ld:AirQualityObserved:RZ:Obsv4567",
-            "type": "AirQualityObserved"
-        }
-        """
-        ...
-
-    def __init__(
-        self,
-        arg1: str = None,
-        arg2: str = None,
-        *,
-        ctx: List = None,
-        payload: dict = None,
-        autoprefix: Optional[bool] = None,
-    ):
-        logger.debug(f"{arg1=} {arg2=}")
-
-        if not ctx:
-            ctx = [CORE_CONTEXT]
-
-        if autoprefix is None:
-            autoprefix = globalsettings.autoprefix
-
         self.root: NgsiDict = None
         self._lastprop: NgsiDict = None
         self._anchored: bool = False
         self._lastwasmulti: bool = False
 
-        if payload is not None:  # create Entity from a dictionary
+        if len(args) == 2:
+            type, id = args
+        elif len(args) == 1:
+            id, type = args[0], None
+        elif len(args) == 0 and payload is not None:  # create Entity from a dictionary
             if not payload.get("id", None):
                 raise NgsiMissingIdError()
             if not payload.get("type", None):
@@ -286,14 +250,15 @@ def __init__(
                 raise NgsiMissingContextError()
             self._lastprop = self.root = NgsiDict(payload)
             return
-
-        # create a new Entity using its id and type
-
-        if arg2:
-            type, id = arg1, arg2
         else:
-            type, id = None, arg1
+            raise ValueError("Expecteds args : type, id (alt. fully qualified id)")
 
+        if autoprefix is None:
+            autoprefix = globalsettings.autoprefix
+        if not ctx:
+            ctx = [CORE_CONTEXT]
+
+        # create a new Entity using its id and type
         if type is None:  # try to infer type from the fully qualified identifier
             id = Urn.prefix(id)
             urn = Urn(id)

tests/common.py

@@ -16,16 +16,18 @@
 if TYPE_CHECKING:
     from ngsildclient.model.constants import EntityOrId
 
-from datetime import datetime, timezone
+from datetime import datetime
+from dateutil.tz import UTC
 from ngsildclient.model.entity import Entity
 from ngsildclient.api.client import Client
 from ngsildclient.utils.urn import Urn
 
-sample_entity = Entity("AirQualityObserved", "AirQualityObserved:RZ:Obsv4567")
-sample_entity.tprop("dateObserved", datetime(2018, 8, 7, 12, tzinfo=timezone.utc))
+sample_entity = Entity("AirQualityObserved", "RZ:Obsv4567")
+sample_entity.tprop("dateObserved", datetime(2018, 8, 7, 12, tzinfo=UTC))
 sample_entity.prop("NO2", 22, unitcode="GP")
 sample_entity.rel("refPointOfInterest", "PointOfInterest:RZ:MainSquare")
 
+
 class MockedClient(Client):
     def __init__(self):
         self._broker_impl: dict[str, Entity] = {}
@@ -35,4 +37,4 @@ def get(self, entity: EntityOrId) -> Entity:
         return self._broker_impl[Urn.prefix(eid)]
 
     def upsert(self, entities: List[Entity]):
-        self._broker_impl |= {e.id: e for e in entities}
+        self._broker_impl |= {e.id: e for e in entities}

tests/smartdatamodels/smartcities/test_urbanmobility.py

@@ -12,17 +12,16 @@
 import pkg_resources
 import json
 
-from datetime import datetime, timezone
-from ngsildclient.model.entity import *
+from datetime import datetime
+from dateutil.tz import UTC
+from ngsildclient.model.entity import Entity
 from ngsildclient.model.helper.postal import PostalAddressBuilder
 from ngsildclient.model.helper.openinghours import OpeningHoursBuilder
 from ngsildclient.utils.urn import Urn
 
 
 def expected_dict(basename: str) -> dict:
-    filename: str = pkg_resources.resource_filename(
-        __name__, f"data/urbanmobility/{basename}.json"
-    )
+    filename: str = pkg_resources.resource_filename(__name__, f"data/urbanmobility/{basename}.json")
     with open(filename, "r") as fp:
         expected = json.load(fp)
     return expected
@@ -41,19 +40,13 @@ def test_transportstop():
         ],
     )
 
-    e.tprop("dateModified", datetime(2018, 9, 25, 8, 32, 26, tzinfo=timezone.utc))
+    e.tprop("dateModified", datetime(2018, 9, 25, 8, 32, 26, tzinfo=UTC))
     e.prop("source", "https://api.smartsantander.eu/")
     e.prop("dataProvider", "http://www.smartsantander.eu/")
     e.prop("entityVersion", "2.0")
 
     builder = PostalAddressBuilder()
-    address = (
-        builder.street("C/ La Pereda 14")
-        .locality("Santander")
-        .region("Cantabria")
-        .country("Spain")
-        .build()
-    )
+    address = builder.street("C/ La Pereda 14").locality("Santander").region("Cantabria").country("Spain").build()
     e.prop("address", address)
 
     e.gprop("location", (43.478053126, -3.804648385))

tests/test_attr.py

@@ -11,14 +11,16 @@
 
 import pytest
 
-from datetime import datetime, date, time, timezone
+from datetime import datetime
+from dateutil.tz import UTC
 from ngsildclient.model.entity import Entity
 from ngsildclient.model.attr.prop import AttrPropValue
 
+
 def test_observedat():
     e = Entity("OffStreetParking", "Downtown1")
     e.prop("availableSpotNumber", 121, observedat=datetime(2017, 7, 29, 12, 5, 2))
     p = e["availableSpotNumber"]
     assert isinstance(p, AttrPropValue)
     dt = p.observedat
-    assert dt == datetime(2017, 7, 29, 12, 5, 2, tzinfo=timezone.utc)
+    assert dt == datetime(2017, 7, 29, 12, 5, 2, tzinfo=UTC)