nexus-extensibility 2.0.0b47__py3-none-any.whl → 2.0.0b49__py3-none-any.whl

nexus_extensibility/_extensibility_data_source.py

@@ -2,8 +2,8 @@ import enum
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from datetime import datetime
-from typing import (Any, Awaitable, Callable, Dict, Generic, List, Optional,
-                    Protocol, Tuple, TypeVar)
+from typing import (Any, Awaitable, Callable, Generic, Optional, Protocol,
+                    TypeVar)
 from urllib.parse import ParseResult
 
 from ._data_model import CatalogItem, CatalogRegistration, ResourceCatalog
@@ -57,9 +57,25 @@ class DataSourceContext(Generic[T]):
     source_configuration: T
     """The source configuration."""
 
-    request_configuration: Optional[Dict[str, Any]]
+    request_configuration: Optional[dict[str, Any]]
     """The request configuration."""
 
+@dataclass(frozen=True)
+class CatalogTimeRange:
+    """
+    A catalog time range.
+
+    Args:
+        begin: The date/time of the first data in the catalog.
+        end: The date/time of the last data in the catalog.
+    """
+
+    begin: datetime
+    """The date/time of the first data in the catalog."""
+
+    end: datetime
+    """The date/time of the last data in the catalog."""
+
 @dataclass(frozen=True)
 class ReadRequest:
     """
@@ -103,6 +119,7 @@ class ReadDataHandler(Protocol):
 
 ################# DATA SOURCE ###############
 
+# use this syntax in future (3.12+): IDataSource[T](ABC)
 class IDataSource(Generic[T], ABC):
     """
     A data source.
@@ -120,7 +137,7 @@ class IDataSource(Generic[T], ABC):
         pass
 
     @abstractmethod
-    def get_catalog_registrations(self, path: str) -> Awaitable[List[CatalogRegistration]]:
+    def get_catalog_registrations(self, path: str) -> Awaitable[list[CatalogRegistration]]:
         """
         Gets the catalog registrations that are located under path.
 
@@ -140,7 +157,7 @@ class IDataSource(Generic[T], ABC):
         pass
 
     @abstractmethod
-    def get_time_range(self, catalog_id: str) -> Awaitable[Tuple[datetime, datetime]]:
+    def get_time_range(self, catalog_id: str) -> Awaitable[CatalogTimeRange]:
         """
         Gets the time range of the ResourceCatalog.
 
@@ -186,7 +203,6 @@ class IUpgradableDataSource(ABC):
     Data sources which have configuration data to be upgraded should implement this interface.
     """
 
-    @staticmethod
     @abstractmethod
     def upgrade_source_configuration(configuration: Any) -> Awaitable[Any]:
         """
@@ -214,15 +230,15 @@ class SimpleDataSource(Generic[T], IDataSource[T], ABC):
         self.Logger = logger
 
     @abstractmethod
-    def get_catalog_registrations(self, path: str) -> Awaitable[List[CatalogRegistration]]:
+    def get_catalog_registrations(self, path: str) -> Awaitable[list[CatalogRegistration]]:
         pass
 
     @abstractmethod
     def enrich_catalog(self, catalog: ResourceCatalog) -> Awaitable[ResourceCatalog]:
         pass
 
-    async def get_time_range(self, catalog_id: str) -> Tuple[datetime, datetime]:
-        return (datetime.min, datetime.max)
+    async def get_time_range(self, catalog_id: str) -> CatalogTimeRange:
+        return CatalogTimeRange(datetime.min, datetime.max)
 
     async def get_availability(self, catalog_id: str, begin: datetime, end: datetime) -> float:
         return float("NaN")

{nexus_extensibility-2.0.0b47.dist-info → nexus_extensibility-2.0.0b49.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nexus-extensibility
-Version: 2.0.0b47
+Version: 2.0.0b49
 Summary: Type definitions to implement data sources for the Nexus system.
 Home-page: https://github.com/nexus-main/nexus
 Author: https://github.com/nexus-main

{nexus_extensibility-2.0.0b47.dist-info → nexus_extensibility-2.0.0b49.dist-info}/RECORD

@@ -2,9 +2,9 @@ nexus_extensibility/__init__.py,sha256=temuSqvUeZusU_0j-QoRalMIDfCHm9JP8W6jEO280
 nexus_extensibility/_data_model.py,sha256=HBuH2ftXAq_a5pJWc5UtqbEEcQIVAolz3xLUYgAHyk0,11964
 nexus_extensibility/_data_model_extensions.py,sha256=iLSOVDKvVoorj2h0x_XHGhbKwd_NHtrURgS7aUVe8MI,670
 nexus_extensibility/_data_model_utilities.py,sha256=cb_uJD4CeYz1m7NEttQ7kR3nrcMjovJQCrSUchnglQE,377
-nexus_extensibility/_extensibility_data_source.py,sha256=w2LTMMpBXNeNasaF_7YnhNBP_GZ15bk5JW8sFpTHwaI,7530
+nexus_extensibility/_extensibility_data_source.py,sha256=JcXABjfBhbktNzlnem1ylpLJTRJfEd64__JjPx3GIMk,7928
 nexus_extensibility/_extensibility_utilities.py,sha256=hQFcY2joHt1goJSCvMfEW5cprN1I-B1-SihqYme8R1A,786
-nexus_extensibility-2.0.0b47.dist-info/METADATA,sha256=f7qtfAi5diLDRJzneDSGeasp95Fnz7gHKvI7fPyVRGM,775
-nexus_extensibility-2.0.0b47.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-nexus_extensibility-2.0.0b47.dist-info/top_level.txt,sha256=GTaw9wgS6EKrgO6FhJ3YZuMrkgoK7kP-hW9uybPDbyg,20
-nexus_extensibility-2.0.0b47.dist-info/RECORD,,
+nexus_extensibility-2.0.0b49.dist-info/METADATA,sha256=36GdIqTtdbM0CnQRIP3KDZYlLq-H_cUZ-Dp_dz_Tv7A,775
+nexus_extensibility-2.0.0b49.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+nexus_extensibility-2.0.0b49.dist-info/top_level.txt,sha256=GTaw9wgS6EKrgO6FhJ3YZuMrkgoK7kP-hW9uybPDbyg,20
+nexus_extensibility-2.0.0b49.dist-info/RECORD,,