Fix loading datetimes with - instead of T (#41)

Author: bdraco

onvif/client.py

@@ -26,6 +26,7 @@
 from .managers import NotificationManager, PullPointManager
 from .settings import DEFAULT_SETTINGS
 from .transport import ASYNC_TRANSPORT
+from .types import FastDateTime
 from .util import create_no_verify_ssl_context, normalize_url, path_isfile, utcnow
 from .wrappers import retry_connection_error  # noqa: F401
 
@@ -80,10 +81,44 @@ def apply(self, envelope, headers):
         return result
 
 
-@lru_cache(maxsize=128)
-def _cached_document(url: str) -> Document:
+_DOCUMENT_CACHE: dict[str, Document] = {}
+
+original_load = Document.load
+
+
+class DocumentWithDeferredLoad(Document):
+    def load(self, *args: Any, **kwargs: Any) -> None:
+        """Deferred load of the document."""
+
+    def original_load(self, *args: Any, **kwargs: Any) -> None:
+        """Original load of the document."""
+        return original_load(self, *args, **kwargs)
+
+
+async def _cached_document(url: str) -> Document:
     """Load external XML document from disk."""
-    return Document(url, ASYNC_TRANSPORT, settings=DEFAULT_SETTINGS)
+    if url in _DOCUMENT_CACHE:
+        return _DOCUMENT_CACHE[url]
+    loop = asyncio.get_event_loop()
+
+    def _load_document() -> DocumentWithDeferredLoad:
+        document = DocumentWithDeferredLoad(url, ASYNC_TRANSPORT, DEFAULT_SETTINGS)
+        # Override the default datetime type to use FastDateTime
+        # This is a workaround for the following issue:
+        # https://github.com/mvantellingen/python-zeep/pull/1370
+        schema = document.types.documents.get_by_namespace(
+            "http://www.w3.org/2001/XMLSchema", False
+        )[0]
+        instance = FastDateTime(is_global=True)
+        schema.register_type(FastDateTime._default_qname, instance)
+        document.types.add_documents([None], url)
+        # Perform the original load
+        document.original_load(url)
+        return document
+
+    document = await loop.run_in_executor(None, _load_document)
+    _DOCUMENT_CACHE[url] = document
+    return document
 
 
 class ZeepAsyncClient(BaseZeepAsyncClient):
@@ -201,9 +236,7 @@ async def setup(self):
         wsse = UsernameDigestTokenDtDiff(
             self.user, self.passwd, dt_diff=self.dt_diff, use_digest=self.encrypt
         )
-        self.document = await self.loop.run_in_executor(
-            None, _cached_document, self.url
-        )
+        self.document = await _cached_document(self.url)
         self.zeep_client_authless = ZeepAsyncClient(
             wsdl=self.document,
             transport=self.transport,

onvif/types.py

@@ -0,0 +1,29 @@
+"""ONVIF types."""
+
+
+import ciso8601
+import isodate
+from zeep.xsd.types.builtins import DateTime, treat_whitespace
+
+
+# see https://github.com/mvantellingen/python-zeep/pull/1370
+class FastDateTime(DateTime):
+    """Fast DateTime that supports timestamps with - instead of T."""
+
+    @treat_whitespace("collapse")
+    def pythonvalue(self, value):
+        """Convert the xml value into a python value."""
+        try:
+            return ciso8601.parse_datetime(value)
+        except ValueError:
+            pass
+        # Determine based on the length of the value if it only contains a date
+        # lazy hack ;-)
+
+        if len(value) == 10:
+            value += "T00:00:00"
+        elif (len(value) == 19 or len(value) == 26) and value[10] == " ":
+            value = "T".join(value.split(" "))
+        elif len(value) > 10 and value[10] == "-":  # 2010-01-01-00:00:00...
+            value[10] = "T"
+        return isodate.parse_datetime(value)

setup.py

@@ -7,7 +7,12 @@
 version_path = os.path.join(here, "onvif/version.txt")
 version = open(version_path).read().strip()
 
-requires = ["httpx>=0.19.0,<1.0.0", "zeep[async]>=4.2.1,<5.0.0"]
+requires = [
+    "httpx>=0.19.0,<1.0.0",
+    "zeep[async]>=4.2.1,<5.0.0",
+    "ciso8601>=2.1.3",
+    "isodate>=0.6.0",
+]
 
 CLASSIFIERS = [
     "Development Status :: 3 - Alpha",