nexus-extensibility 2.0.0b45__py3-none-any.whl → 2.0.0b46__py3-none-any.whl

nexus_extensibility/_extensibility_data_source.py

@@ -2,14 +2,16 @@ import enum
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from datetime import datetime
-from typing import (Any, Awaitable, Callable, Dict, List, Optional, Protocol,
-                    Tuple)
+from typing import (Any, Awaitable, Callable, Dict, Generic, List, Optional,
+                    Protocol, Tuple, TypeVar)
 from urllib.parse import ParseResult
 
 from ._data_model import CatalogItem, CatalogRegistration, ResourceCatalog
 
 ################# DATA SOURCE TYPES ###############
 
+T = TypeVar('T')
+
 class LogLevel(enum.IntEnum):
     """Defines logging severity levels."""
 
@@ -37,14 +39,14 @@ class ILogger(ABC):
     def log(self, log_level: LogLevel, message: str):
         pass
 
+# use this syntax in future (3.12+): DataSourceContext[T]
 @dataclass(frozen=True)
-class DataSourceContext:
+class DataSourceContext(Generic[T]):
     """
     The starter package for a data source.
 
     Args:
         resource_locator: An optional URL which points to the data.
-        system_configuration: The system configuration.
         source_configuration: The source configuration.
         request_configuration: The request configuration.
     """
@@ -52,10 +54,7 @@ class DataSourceContext:
     resource_locator: Optional[ParseResult]
     """The unique identifier of the package reference."""
 
-    system_configuration: Optional[Dict[str, Any]]
-    """The system configuration."""
-
-    source_configuration: Optional[Dict[str, Any]]
+    source_configuration: T
     """The source configuration."""
 
     request_configuration: Optional[Dict[str, Any]]
@@ -104,13 +103,13 @@ class ReadDataHandler(Protocol):
 
 ################# DATA SOURCE ###############
 
-class IDataSource(ABC):
+class IDataSource(Generic[T], ABC):
     """
     A data source.
     """
 
     @abstractmethod
-    def set_context(self, context: DataSourceContext, logger: ILogger) -> Awaitable[None]:
+    def set_context(self, context: DataSourceContext[T], logger: ILogger) -> Awaitable[None]:
         """
         Invoked by Nexus right after construction to provide the context.
 
@@ -182,12 +181,29 @@ class IDataSource(ABC):
         """
         pass
 
-class SimpleDataSource(IDataSource, ABC):
+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]:
+        """
+        Upgrades the source configuration.
+
+        Args:
+            configuration: The configuration.
+        """
+        pass
+
+# use this syntax in future (3.12+): SimpleDataSource[T](...
+class SimpleDataSource(Generic[T], IDataSource[T], ABC):
     """
     A simple implementation of a data source.
     """
 
-    Context: DataSourceContext
+    Context: DataSourceContext[T]
     """Gets the data source context. This property is not accessible from within class constructors as it will bet set later."""
 
     Logger: ILogger

{nexus_extensibility-2.0.0b45.dist-info → nexus_extensibility-2.0.0b46.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nexus-extensibility
-Version: 2.0.0b45
+Version: 2.0.0b46
 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.0b45.dist-info → nexus_extensibility-2.0.0b46.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=WMQ8_re5CRJLQma4vq0FfRs6hh_WG4eQBC7c5z3tNhI,7095
+nexus_extensibility/_extensibility_data_source.py,sha256=w2LTMMpBXNeNasaF_7YnhNBP_GZ15bk5JW8sFpTHwaI,7530
 nexus_extensibility/_extensibility_utilities.py,sha256=hQFcY2joHt1goJSCvMfEW5cprN1I-B1-SihqYme8R1A,786
-nexus_extensibility-2.0.0b45.dist-info/METADATA,sha256=0PRl3wRxjNYSmqqWqGUiXvA01BpKgboc5IwM3Wndiuk,775
-nexus_extensibility-2.0.0b45.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-nexus_extensibility-2.0.0b45.dist-info/top_level.txt,sha256=GTaw9wgS6EKrgO6FhJ3YZuMrkgoK7kP-hW9uybPDbyg,20
-nexus_extensibility-2.0.0b45.dist-info/RECORD,,
+nexus_extensibility-2.0.0b46.dist-info/METADATA,sha256=h8aJXu8rWNXAomFwoPpsqwFIZXjKttM26PaqRq_RB6s,775
+nexus_extensibility-2.0.0b46.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+nexus_extensibility-2.0.0b46.dist-info/top_level.txt,sha256=GTaw9wgS6EKrgO6FhJ3YZuMrkgoK7kP-hW9uybPDbyg,20
+nexus_extensibility-2.0.0b46.dist-info/RECORD,,