esd-services-api-client 2.0.3__py3-none-any.whl → 2.0.4__py3-none-any.whl

esd_services_api_client/_version.py

@@ -1 +1 @@
-__version__ = '2.0.3'
+__version__ = '2.0.4'

esd_services_api_client/nexus/README.md

@@ -17,6 +17,7 @@ import asyncio
 import json
 import socketserver
 import threading
+import os
 from dataclasses import dataclass
 from http.server import ThreadingHTTPServer, BaseHTTPRequestHandler
 from typing import Dict, Optional
@@ -34,6 +35,7 @@ from esd_services_api_client.nexus.abstractions.socket_provider import (
 from esd_services_api_client.nexus.core.app_core import Nexus
 from esd_services_api_client.nexus.algorithms import MinimalisticAlgorithm
 from esd_services_api_client.nexus.input import InputReader, InputProcessor
+from esd_services_api_client.nexus.configurations.algorithm_configuration import NexusConfiguration
 from pandas import DataFrame as PandasDataFrame
 
 from esd_services_api_client.nexus.input.payload_reader import AlgorithmPayload
@@ -47,6 +49,16 @@ async def my_on_complete_func_2(**kwargs):
     pass
 
 
+@dataclass
+class MyAlgorithmConfiguration(NexusConfiguration):
+    @classmethod
+    def from_environment(cls) -> "NexusConfiguration":
+        return MyAlgorithmConfiguration.from_json(os.getenv("NEXUS__MY_CONFIGURATION"))
+
+    c1: str
+    c2: str
+
+
 @dataclass
 class MyAlgorithmPayload(AlgorithmPayload, DataClassJsonMixin):
     x: Optional[list[int]] = None
@@ -250,6 +262,7 @@ async def main():
             .add_reader(YReader)
             .use_processor(MyInputProcessor)
             .use_algorithm(MyAlgorithm)
+            .inject_configuration(MyAlgorithmConfiguration)
             .inject_payload(MyAlgorithmPayload, MyAlgorithmPayload2)
         )
 

esd_services_api_client/nexus/configurations/algorithm_configuration.py

@@ -0,0 +1,37 @@
+"""
+ Configuration class primitive for injections.
+"""
+from abc import abstractmethod, ABC
+from dataclasses import dataclass
+
+from dataclasses_json import DataClassJsonMixin
+
+
+#  Copyright (c) 2023. ECCO Sneaks & Data
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+
+@dataclass
+class NexusConfiguration(DataClassJsonMixin, ABC):
+    """
+    Base class for algorithm configurations
+    """
+
+    @classmethod
+    @abstractmethod
+    def from_environment(cls) -> "NexusConfiguration":
+        """
+        Instantiates this configuration from the environment variable.
+        """

esd_services_api_client/nexus/core/app_core.py

@@ -46,6 +46,9 @@ from esd_services_api_client.crystal import (
 from esd_services_api_client.nexus.algorithms._baseline_algorithm import (
     BaselineAlgorithm,
 )
+from esd_services_api_client.nexus.configurations.algorithm_configuration import (
+    NexusConfiguration,
+)
 from esd_services_api_client.nexus.core.app_dependencies import (
     ServiceConfigurator,
 )
@@ -163,6 +166,19 @@ class Nexus:
             self._configurator = self._configurator.with_payload((await get_payload()))
         return self
 
+    def inject_configuration(
+        self, *configuration_types: Type[NexusConfiguration]
+    ) -> "Nexus":
+        """
+        Adds custom configuration class instances to the DI container.
+        """
+        for config_type in configuration_types:
+            self._configurator = self._configurator.with_configuration(
+                config_type.from_environment()
+            )
+
+        return self
+
     async def _submit_result(
         self,
         result: Optional[PandasDataFrame] = None,

esd_services_api_client/nexus/core/app_dependencies.py

@@ -32,6 +32,9 @@ from esd_services_api_client.nexus.abstractions.logger_factory import LoggerFact
 from esd_services_api_client.nexus.abstractions.socket_provider import (
     ExternalSocketProvider,
 )
+from esd_services_api_client.nexus.configurations.algorithm_configuration import (
+    NexusConfiguration,
+)
 from esd_services_api_client.nexus.exceptions.startup_error import (
     FatalStartupConfigurationError,
 )
@@ -42,6 +45,7 @@ from esd_services_api_client.nexus.input.payload_reader import (
 )
 
 
+@final
 class MetricsModule(Module):
     """
     Metrics provider module.
@@ -63,6 +67,7 @@ class MetricsModule(Module):
         return metrics_class(**metrics_settings)
 
 
+@final
 class LoggerFactoryModule(Module):
     """
     Logger factory module.
@@ -77,6 +82,7 @@ class LoggerFactoryModule(Module):
         return LoggerFactory()
 
 
+@final
 class CrystalReceiverClientModule(Module):
     """
     Crystal receiver module.
@@ -93,6 +99,7 @@ class CrystalReceiverClientModule(Module):
         )
 
 
+@final
 class QueryEnabledStoreModule(Module):
     """
     QES module.
@@ -107,6 +114,7 @@ class QueryEnabledStoreModule(Module):
         return QueryEnabledStore.from_string(os.getenv("NEXUS__QES_CONNECTION_STRING"))
 
 
+@final
 class StorageClientModule(Module):
     """
     Storage client module.
@@ -203,3 +211,12 @@ class ServiceConfigurator:
             lambda binder: binder.bind(payload.__class__, to=payload, scope=singleton)
         )
         return self
+
+    def with_configuration(self, config: NexusConfiguration) -> "ServiceConfigurator":
+        """
+        Adds the specified payload instance to the DI container.
+        """
+        self._injection_binds.append(
+            lambda binder: binder.bind(config.__class__, to=config, scope=singleton)
+        )
+        return self

{esd_services_api_client-2.0.3.dist-info → esd_services_api_client-2.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esd-services-api-client
-Version: 2.0.3
+Version: 2.0.4
 Summary: Python clients for ESD services
 Home-page: https://github.com/SneaksAndData/esd-services-api-client
 License: Apache 2.0

{esd_services_api_client-2.0.3.dist-info → esd_services_api_client-2.0.4.dist-info}/RECORD

@@ -1,5 +1,5 @@
 esd_services_api_client/__init__.py,sha256=rP0njtEgVSMm-sOVayVfcRUrrubl4lme7HI2zS678Lo,598
-esd_services_api_client/_version.py,sha256=fcRMgwI40iVFwre_3iKQA-N6sHUo3pAErXcKJS63DRg,22
+esd_services_api_client/_version.py,sha256=YuAuFLBrpl-SUl_UsvW1U1NTjqnldfuD1xUmSLmtaRw,22
 esd_services_api_client/beast/__init__.py,sha256=NTaz_7YoLPK8MCLwbwqH7rW1zDWLxXu2T7fGmMmRxyg,718
 esd_services_api_client/beast/v3/__init__.py,sha256=TRjB4-T6eIORpMvdylb32_GinrIpYNFmAdshSC1HqHg,749
 esd_services_api_client/beast/v3/_connector.py,sha256=oPizDQ1KOKOfiyh-jAofKodlpRzrRiELv-rmP_o_oio,11473
@@ -15,7 +15,7 @@ esd_services_api_client/crystal/__init__.py,sha256=afSGQRkDic0ECsJfgu3b291kX8CyU
 esd_services_api_client/crystal/_api_versions.py,sha256=2BMiQRS0D8IEpWCCys3dge5alVBRCZrOuCR1QAn8UIM,832
 esd_services_api_client/crystal/_connector.py,sha256=WjfMezWXia41Z8aiNupaT577fk9Sx6uy6V23O6y9hfI,12870
 esd_services_api_client/crystal/_models.py,sha256=eRhGAl8LjglCyIFwf1bcFBhjbpSuRYucuF2LO388L2E,4025
-esd_services_api_client/nexus/README.md,sha256=6fGBYTvzkmZH9Yk9VcPqWCtqU_D2zleG1rv1U3GA3IM,7721
+esd_services_api_client/nexus/README.md,sha256=73TcvRlAoMUrxE4rnARZmlwS7AwlW9fDV0Tj-MPwC00,8141
 esd_services_api_client/nexus/__init__.py,sha256=e7RPs-qJNQqDHj121TeYx-_YadZSOIyJuAPyhSSXRsE,622
 esd_services_api_client/nexus/abstractions/__init__.py,sha256=e7RPs-qJNQqDHj121TeYx-_YadZSOIyJuAPyhSSXRsE,622
 esd_services_api_client/nexus/abstractions/logger_factory.py,sha256=JHl_t0d0ra_k-EixZlkw-s746wHUdBhSU6preqoARtk,2031
@@ -26,9 +26,11 @@ esd_services_api_client/nexus/algorithms/_baseline_algorithm.py,sha256=4Gqp8qV5n
 esd_services_api_client/nexus/algorithms/distributed.py,sha256=iWjx9D6g-ASwTWPkQ9GmInTLymVlxl7UkfEBcEfnkmc,1628
 esd_services_api_client/nexus/algorithms/minimalistic.py,sha256=9KvIXXsiOZ9wAOvrIZuOlNYcJLB-SjlQoNpICJu-qeQ,1366
 esd_services_api_client/nexus/algorithms/recursive.py,sha256=2YuAeYZ6-K5hcY8NEAAJVyGhtVVQMTZ7wjkWPPo8qeE,1829
+esd_services_api_client/nexus/configurations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+esd_services_api_client/nexus/configurations/algorithm_configuration.py,sha256=sg3ul-Vqd39li42cfMsdWtFJIBNfQ52XLmqKO2sryDg,1086
 esd_services_api_client/nexus/core/__init__.py,sha256=e7RPs-qJNQqDHj121TeYx-_YadZSOIyJuAPyhSSXRsE,622
-esd_services_api_client/nexus/core/app_core.py,sha256=bwbFzbjx8PwZWHfHsEYDCGAjJuTzmVKuunSeMU54tHs,8877
-esd_services_api_client/nexus/core/app_dependencies.py,sha256=8HhakKwWIEjtSHb71UAGbFH3e1ZNKIJ-mN4UXPUAkPQ,5666
+esd_services_api_client/nexus/core/app_core.py,sha256=7cT6ZEzKzq3lfio6YNxREpTTeXt1wjhHUOXxaezuFiQ,9393
+esd_services_api_client/nexus/core/app_dependencies.py,sha256=rIk6R-InJeF1P0DC4bhj4kJTNNxYg39Vhuz8AXfV6pk,6140
 esd_services_api_client/nexus/exceptions/__init__.py,sha256=JgPXhrvBIi0U1QOF90TYHS8jv_SBQEoRLsEg6rrtRoc,691
 esd_services_api_client/nexus/exceptions/_nexus_error.py,sha256=b3L8JnNvV2jdxNfuFWh9-j4kVb_VX7gNH5WHKcC-R78,890
 esd_services_api_client/nexus/exceptions/input_reader_error.py,sha256=D-xYTKRNREQ2-NGhc88GHOmXCvLNsIVQsH8wf0LLC_0,1760
@@ -37,7 +39,7 @@ esd_services_api_client/nexus/input/__init__.py,sha256=0k_HMIP4NPC5O2ixKJPgKsLzY
 esd_services_api_client/nexus/input/input_processor.py,sha256=MiXXd_APrG85Pi-Ke68_UHNEV7T_QHN1hU1WAPWoTsw,3187
 esd_services_api_client/nexus/input/input_reader.py,sha256=uxTAGX5xNhjTFpEsVQnr8BkVgpIH_U_om54hh3pvJ3s,3269
 esd_services_api_client/nexus/input/payload_reader.py,sha256=__r_QjIFRAWwx56X5WUK1qensJUae0vZEb422dzOgSY,2511
-esd_services_api_client-2.0.3.dist-info/LICENSE,sha256=0gS6zXsPp8qZhzi1xaGCIYPzb_0e8on7HCeFJe8fOpw,10693
-esd_services_api_client-2.0.3.dist-info/METADATA,sha256=v0LOcae6jYgRf0mU8aGvXU_oCEYT0Xa0vS-j4Xwl3V0,1236
-esd_services_api_client-2.0.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-esd_services_api_client-2.0.3.dist-info/RECORD,,
+esd_services_api_client-2.0.4.dist-info/LICENSE,sha256=0gS6zXsPp8qZhzi1xaGCIYPzb_0e8on7HCeFJe8fOpw,10693
+esd_services_api_client-2.0.4.dist-info/METADATA,sha256=CGlXTMSDUh5Fvzm0E4-r8b9FA9SuQ5gm5xUX7ulxhIg,1236
+esd_services_api_client-2.0.4.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+esd_services_api_client-2.0.4.dist-info/RECORD,,