luna-quantum 1.0.4rc3__cp312-cp312-manylinux_2_34_x86_64.whl → 1.0.5__cp312-cp312-manylinux_2_34_x86_64.whl

luna_quantum/_core.pyi

@@ -854,6 +854,14 @@ class Solution:
         """
         ...
 
+    def repr_html(self, /) -> str:
+        """Represent the solution as a html table.
+
+        Returns
+        -------
+        str
+        """
+
     def __getitem__(self, item: int, /) -> ResultView:
         """
         Extract a result view from the `Solution` object.
@@ -952,6 +960,22 @@ class Solution:
         """Get the names of all variables in the solution."""
         ...
 
+    def cvar(self, /, alpha: float) -> float:
+        """
+        Compute the Conditional Value at Rist (CVaR) of the solution.
+
+        Returns
+        -------
+        float
+            The CVaR.
+
+        Raises
+        ------
+        ComputationError
+            If the computation fails for any reason.
+        """
+        ...
+
     def expectation_value(self, /) -> float:
         """
         Compute the expectation value of the solution.
@@ -2907,6 +2931,20 @@ class Expression:
         """
         ...
 
+    def equal_contents(self, other: Expression, /) -> bool:
+        """
+        Check whether this expression has equal contents as `other`.
+
+        Parameters
+        ----------
+        other : Expression
+
+        Returns
+        -------
+        bool
+        """
+        ...
+
     @overload
     def encode(self, /) -> bytes: ...
     @overload
@@ -2959,7 +2997,7 @@ class Expression:
         ...
 
     @classmethod
-    def decode(cls, data: bytes) -> Expression:
+    def decode(cls, data: bytes, env: Environment) -> Expression:
         """
         Reconstruct an expression from encoded bytes.
 
@@ -2967,6 +3005,8 @@ class Expression:
         ----------
         data : bytes
             Binary blob returned by `encode()`.
+        env : Environment
+            The environment of the expression.
 
         Returns
         -------
@@ -2981,7 +3021,7 @@ class Expression:
         ...
 
     @classmethod
-    def deserialize(cls, data: bytes) -> Expression:
+    def deserialize(cls, data: bytes, env: Environment) -> Expression:
         """
         Alias for `decode()`.
 
@@ -3549,6 +3589,20 @@ class Environment:
         """
         ...
 
+    def equal_contents(self, other: Environment, /) -> bool:
+        """
+        Check whether this environment has equal contents as `other`.
+
+        Parameters
+        ----------
+        other : Environment
+
+        Returns
+        -------
+        bool
+        """
+        ...
+
     def __eq__(self, other: Environment, /) -> bool: ...
     def __str__(self, /) -> str: ...
     def __repr__(self, /) -> str: ...

luna_quantum/client/controllers/luna_platform_client.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+from abc import abstractmethod
 from contextlib import suppress
 from enum import Enum
 from http import HTTPStatus
@@ -42,12 +43,15 @@ def check_httpx_exceptions(response: Response) -> None:
     HttpErrorUtils.check_for_error(response)
 
 
-class APIKeyAuth(httpx.Auth):
+class APIKeyAuth(httpx.Auth):  # noqa: PLW1641
     """API key authentication method for luna platform."""
 
     def __init__(self, token: str) -> None:
         self.token = token
 
+        self.dev_header_value = os.getenv("LUNA_DEV_EXTRA_HEADER_VALUE", None)
+        self.dev_header_name = os.getenv("LUNA_DEV_EXTRA_HEADER_NAME", None)
+
     def auth_flow(self, request: Request) -> Generator[Request, Response]:
         """
         Authenticate a request to Luna platform.
@@ -59,20 +63,44 @@ class APIKeyAuth(httpx.Auth):
         """
         request.headers["Luna-API-Key"] = self.token
 
-        dev_header_value = os.getenv("LUNA_DEV_EXTRA_HEADER_VALUE", None)
-        dev_header_name = os.getenv("LUNA_DEV_EXTRA_HEADER_NAME", None)
-        if dev_header_name and dev_header_value:
-            request.headers[dev_header_name] = dev_header_value
+        if self.dev_header_name and self.dev_header_value:
+            request.headers[self.dev_header_name] = self.dev_header_value
         yield request
 
+    def __eq__(self, other: object) -> bool:
+        """
+        Check if the object is equal to the current instance.
+
+        Parameters
+        ----------
+        other: object
+            Object to compare with the current instance.
+
+        Returns
+        -------
+        bool:
+            True if the object is equal to the current instance, False otherwise.
+
+        """
+        if self is other:
+            return True
+        if not isinstance(other, APIKeyAuth):
+            return False
+        return (
+            self.token == other.token
+            and self.dev_header_name == other.dev_header_name
+            and self.dev_header_value == other.dev_header_value
+        )
+
 
 class LunaPlatformClient(IService):
     """Luna platform REST client."""
 
-    _base_url: str = ""
+    _base_url: str
 
     _httpx_client: httpx.Client
     _api_key: ClassVar[str | None] = None
+    _timeout: float | None = None
 
     @property
     def client(self) -> httpx.Client:
@@ -85,9 +113,13 @@ class LunaPlatformClient(IService):
         """
         return self._httpx_client
 
+    @classmethod
+    @abstractmethod
+    def get_api(cls) -> LunaPrefixEnum:
+        """Return the api of the client."""
+
     def __init__(
         self,
-        api: LunaPrefixEnum,
         api_key: str | None = None,
         base_url: str | None = None,
         timeout: float | None = 240.0,
@@ -116,12 +148,46 @@ class LunaPlatformClient(IService):
             itself will time out after 240 seconds.
             Default: 240.0
         """
-        if base_url is None:
-            base_url = os.getenv("LUNA_BASE_URL", "https://api.aqarios.com")
-        if os.getenv("LUNA_DISABLE_SUFFIX", "false").lower() == "true":
-            self._base_url = f"{base_url}/api/v1"
-        else:
-            self._base_url = f"{base_url}/{api.value}/api/v1"
+        self._base_url = self._get_base_url(base_url)
+        self._timeout = timeout
+
+        api_key = self._get_api_key(api_key)
+
+        self.dev_header_value = os.getenv("LUNA_DEV_EXTRA_HEADER_VALUE", None)
+        self.dev_header_name = os.getenv("LUNA_DEV_EXTRA_HEADER_NAME", None)
+
+        self._httpx_client = LunaHTTPClient(
+            auth=APIKeyAuth(api_key),
+            base_url=self._base_url,
+            follow_redirects=True,
+            timeout=self._timeout,
+            event_hooks={"response": [check_httpx_exceptions]},
+        )
+
+        self._authenticate()
+
+    def _get_api_key(self, api_key: str | None = None) -> str:
+        """
+        Retrieve the API key for authentication.
+
+        Get the API key from provided arguments, class-specific key, or environment
+        variables. Raises an error if no API key is available.
+
+        Parameters
+        ----------
+        api_key : str or None, optional
+            An API key string if provided.
+
+        Returns
+        -------
+        str
+            The API key to be used for authentication.
+
+        Raises
+        ------
+        LunaApiKeyMissingError
+            If no API key is available from any source.
+        """
         if api_key:
             auth_key = api_key
         elif self.__class__._api_key:  # noqa: SLF001 Use here self.__class__ so that LunaSolve and LunaQ can have different api keys set
@@ -130,16 +196,31 @@ class LunaPlatformClient(IService):
             auth_key = key
         else:
             raise LunaApiKeyMissingError
+        return auth_key
 
-        self._httpx_client = LunaHTTPClient(
-            auth=APIKeyAuth(auth_key),
-            base_url=self._base_url,
-            follow_redirects=True,
-            timeout=timeout,
-            event_hooks={"response": [check_httpx_exceptions]},
-        )
+    def _get_base_url(self, base_url: str | None = None) -> str:
+        """
+        Get the base url.
 
-        self._authenticate()
+        Parameters
+        ----------
+        base_url: str
+            Base API URL.
+            If you want to use API not on your local PC then change it.
+            You can do that by setting the environment variable LUNA_BASE_URL.
+            Default value https://api.aqarios.com.
+
+        Returns
+        -------
+        str
+            Base url.
+
+        """
+        if base_url is None:
+            base_url = os.getenv("LUNA_BASE_URL", "https://api.aqarios.com")
+        if os.getenv("LUNA_DISABLE_SUFFIX", "false").lower() == "true":
+            return f"{base_url}/api/v1"
+        return f"{base_url}/{self.get_api().value}/api/v1"
 
     def __del__(self) -> None:  # noqa: D105
         if hasattr(self, "_httpx_client"):
@@ -153,3 +234,23 @@ class LunaPlatformClient(IService):
             if exception.response.status_code == HTTPStatus.UNAUTHORIZED:
                 raise LunaApiKeyInvalidError from exception
             raise
+
+    def is_same(
+        self,
+        api_key: str | None = None,
+    ) -> bool:
+        """
+        Whether the service is created with the current environment variables.
+
+        Returns
+        -------
+        bool:
+            True if the service is created with the current environment variables.
+            False otherwise.
+        """
+        api_key = self._get_api_key(api_key)
+
+        return (
+            self._get_base_url() == self._base_url
+            and APIKeyAuth(api_key) == self._httpx_client.auth
+        )

luna_quantum/client/controllers/luna_q.py

@@ -38,11 +38,16 @@ class LunaQ(LunaPlatformClient, ILunaQ):
             itself will time out after 240 seconds.
             Default: 240.0
         """
-        super().__init__(api_key=api_key, api=LunaPrefixEnum.LUNA_Q, timeout=timeout)
+        super().__init__(api_key=api_key, timeout=timeout)
 
         self.circuit = CircuitRestClient(self)
         self.qpu_token = QpuTokenRestClient(self)
 
+    @classmethod
+    def get_api(cls) -> LunaPrefixEnum:
+        """Return the api of the client."""
+        return LunaPrefixEnum.LUNA_Q
+
     @classmethod
     def authenticate(cls, api_key: str) -> None:
         """

luna_quantum/client/controllers/luna_solve.py

@@ -53,7 +53,6 @@ class LunaSolve(LunaPlatformClient, ILunaSolve):
         """
         super().__init__(
             api_key=api_key,
-            api=LunaPrefixEnum.LUNA_SOLVE,
             timeout=timeout,
         )
 
@@ -62,6 +61,11 @@ class LunaSolve(LunaPlatformClient, ILunaSolve):
         self._qpu_token = QpuTokenRestClient(self)
         self._info = InfoRestClient(self)
 
+    @classmethod
+    def get_api(cls) -> LunaPrefixEnum:
+        """Return the api of the client."""
+        return LunaPrefixEnum.LUNA_SOLVE
+
     @classmethod
     def authenticate(cls, api_key: str) -> None:
         """

luna_quantum/client/interfaces/services/service_i.py

@@ -34,3 +34,23 @@ class IService(ABC):
         None
             This method does not return any value.
         """
+
+    @abstractmethod
+    def is_same(
+        self,
+        api_key: str | None = None,
+    ) -> bool:
+        """
+        Whether the service is created with the current environment variables.
+
+        Parameters
+        ----------
+        api_key: str
+            User's API key
+
+        Returns
+        -------
+        bool:
+            True if the service is created with the current environment variables.
+            False otherwise.
+        """

luna_quantum/client/rest_client/info_rest_client.py

@@ -49,9 +49,7 @@ class InfoRestClient(IInfoRestClient):
         for provider, solvers in json.items():
             to_return[provider] = {}
             for solver in solvers:
-                to_return[provider][solver] = SolverInfo.model_validate(
-                    json[provider][solver]
-                )
+                to_return[provider][solver] = SolverInfo.model_validate(solvers[solver])
 
         return to_return
 

luna_quantum/client/schemas/solve_job.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Any
 
 from pydantic import BaseModel
 
@@ -45,3 +46,5 @@ class SolveJobSchema(BaseModel):
 
     is_cancelable: bool
     is_cancellation_requested: bool
+
+    metadata: dict[str, Any] | None = None

luna_quantum/decorators.py

@@ -1,7 +1,9 @@
 """Decorators."""
 
 from collections.abc import Callable
-from typing import Any, Generic, TypeVar, override
+from typing import Any, Generic, TypeAlias, TypeVar
+
+from typing_extensions import override
 
 from . import Model, Solution
 from .transformations import (
@@ -16,19 +18,18 @@ from .transformations import (
 
 T = TypeVar("T")
 
+AnalysisSignature: TypeAlias = Callable[[Model, AnalysisCache], T]
 
-type AnalysisSignature[T] = Callable[[Model, AnalysisCache], T]
-
-type MetaAnalysisSignature[T] = Callable[[list[BasePass], AnalysisCache], T]
+MetaAnalysisSignature: TypeAlias = Callable[[list[BasePass], AnalysisCache], T]
 
-type Outcome = (
+Outcome: TypeAlias = (
     TransformationOutcome | tuple[Model, ActionType] | tuple[Model, ActionType, Any]
 )
-type TransformationSignature = Callable[
+TransformationSignature: TypeAlias = Callable[
     [Model, AnalysisCache],
     Outcome,
 ]
-type BackwardsSignature = Callable[[Solution, AnalysisCache], Solution]
+BackwardsSignature: TypeAlias = Callable[[Solution, AnalysisCache], Solution]
 
 
 def __identity_backwards(solution: Solution, _: AnalysisCache) -> Solution:

luna_quantum/factories/luna_solve_client_factory.py

@@ -1,6 +1,8 @@
+from logging import Logger
 from typing import ClassVar
 
 from luna_quantum.client.interfaces.services.luna_solve_i import ILunaSolve
+from luna_quantum.util.log_utils import Logging
 
 
 class LunaSolveClientFactory:
@@ -11,8 +13,11 @@ class LunaSolveClientFactory:
     based on class configurations and input specifications.
     """
 
+    _logger: Logger = Logging.get_logger(__name__)
     _client_class: ClassVar[type[ILunaSolve]]
 
+    _client: ClassVar[ILunaSolve | None] = None
+
     @staticmethod
     def get_client(client: ILunaSolve | str | None) -> ILunaSolve:
         """
@@ -34,10 +39,30 @@ class LunaSolveClientFactory:
             An ILunaSolve client instance.
         """
         if isinstance(client, ILunaSolve):
+            LunaSolveClientFactory._logger.debug(
+                "Client is already an instance of ILunaSolve"
+            )
             return client
-        if isinstance(client, str):
-            return LunaSolveClientFactory.get_client_class()(client)
-        return LunaSolveClientFactory.get_client_class()()
+
+        if (
+            LunaSolveClientFactory._client
+            and isinstance(
+                LunaSolveClientFactory._client,
+                LunaSolveClientFactory.get_client_class(),
+            )
+            and LunaSolveClientFactory._client.is_same(client)
+        ):
+            LunaSolveClientFactory._logger.debug(
+                "Cache hit. Last used default client is the same as the new one."
+            )
+            return LunaSolveClientFactory._client
+        LunaSolveClientFactory._logger.debug(
+            "Cache miss. No used default client or configuration changed. "
+            "Creating new client."
+        )
+        client = LunaSolveClientFactory.get_client_class()(client)
+        LunaSolveClientFactory._client = client
+        return client
 
     @staticmethod
     def get_client_class() -> type[ILunaSolve]:

luna_quantum/solve/domain/abstract/luna_algorithm.py

@@ -2,7 +2,7 @@ from abc import abstractmethod
 from logging import Logger
 from typing import TYPE_CHECKING, Any, ClassVar, Generic
 
-from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic import ConfigDict, Field, field_validator
 
 from luna_quantum.aqm_overwrites.model import Model
 from luna_quantum.client.controllers.luna_solve import LunaSolve
@@ -18,7 +18,7 @@ if TYPE_CHECKING:
     from luna_quantum.solve.interfaces.usecases import ISolveJobCreateUseCase
 
 
-class LunaAlgorithm(IAlgorithm[BACKEND_TYPE], BaseModel, Generic[BACKEND_TYPE]):
+class LunaAlgorithm(IAlgorithm[BACKEND_TYPE], Generic[BACKEND_TYPE]):
     """
     Class representing a solver for Luna model problems.
 
@@ -133,7 +133,9 @@ class LunaAlgorithm(IAlgorithm[BACKEND_TYPE], BaseModel, Generic[BACKEND_TYPE]):
         SolveJob
             The job object containing the information about the solve process.
         """
-        from luna_quantum.factories.usecase_factory import UseCaseFactory
+        from luna_quantum.factories.usecase_factory import (  # noqa: PLC0415
+            UseCaseFactory,
+        )
 
         b: BACKEND_TYPE
         if backend is not None:

luna_quantum/solve/domain/model_metadata.py

@@ -45,7 +45,9 @@ class ModelMetadata(BaseModel):
         """
         c = LunaSolveClientFactory.get_client(client=client)
 
-        from luna_quantum.factories.usecase_factory import UseCaseFactory
+        from luna_quantum.factories.usecase_factory import (  # noqa: PLC0415
+            UseCaseFactory,
+        )
 
         aq_model: Model = UseCaseFactory.model_load_by_metadata(client=c).__call__(
             model_metadata=self

luna_quantum/solve/domain/solve_job.py

@@ -1,5 +1,5 @@
 from logging import Logger
-from typing import ClassVar, Literal
+from typing import Any, ClassVar, Literal
 
 from pydantic import BaseModel, PrivateAttr
 
@@ -28,6 +28,7 @@ class SolveJob(BaseModel):
     is_cancelable: bool = True
     is_cancellation_requested: bool = False
 
+    metadata: dict[str, Any] | None = None
     _result: Solution | None = PrivateAttr(default=None)
 
     _model: Model | None = PrivateAttr(default=None)
@@ -72,7 +73,9 @@ class SolveJob(BaseModel):
         if status_source == "remote":
             c: ILunaSolve = LunaSolveClientFactory.get_client(client)
 
-            from luna_quantum.factories.usecase_factory import UseCaseFactory
+            from luna_quantum.factories.usecase_factory import (  # noqa: PLC0415
+                UseCaseFactory,
+            )
 
             UseCaseFactory.solve_job_fetch_update(client=c).__call__(solve_job=self)
 
@@ -122,7 +125,9 @@ class SolveJob(BaseModel):
 
         c: ILunaSolve = LunaSolveClientFactory.get_client(client)
 
-        from luna_quantum.factories.usecase_factory import UseCaseFactory
+        from luna_quantum.factories.usecase_factory import (  # noqa: PLC0415
+            UseCaseFactory,
+        )
 
         self._result = UseCaseFactory.solve_job_get_result(client=c).__call__(
             solve_job=self,
@@ -163,7 +168,9 @@ class SolveJob(BaseModel):
         """
         c: ILunaSolve = LunaSolveClientFactory.get_client(client)
 
-        from luna_quantum.factories.usecase_factory import UseCaseFactory
+        from luna_quantum.factories.usecase_factory import (  # noqa: PLC0415
+            UseCaseFactory,
+        )
 
         UseCaseFactory.solve_job_cancel(client=c).__call__(self)
 
@@ -182,6 +189,8 @@ class SolveJob(BaseModel):
         """
         c: ILunaSolve = LunaSolveClientFactory.get_client(client)
 
-        from luna_quantum.factories.usecase_factory import UseCaseFactory
+        from luna_quantum.factories.usecase_factory import (  # noqa: PLC0415
+            UseCaseFactory,
+        )
 
         UseCaseFactory.solve_job_delete(client=c).__call__(solve_job_id=self.id)

luna_quantum/solve/interfaces/algorithm_i.py

@@ -1,6 +1,8 @@
 from abc import ABC, abstractmethod
 from typing import Any, Generic, TypeVar
 
+from pydantic import BaseModel
+
 from luna_quantum.aqm_overwrites.model import Model
 from luna_quantum.solve.domain.solve_job import SolveJob
 from luna_quantum.solve.interfaces.backend_i import IBackend
@@ -8,7 +10,7 @@ from luna_quantum.solve.interfaces.backend_i import IBackend
 BACKEND_TYPE = TypeVar("BACKEND_TYPE", bound=IBackend)
 
 
-class IAlgorithm(ABC, Generic[BACKEND_TYPE]):
+class IAlgorithm(ABC, BaseModel, Generic[BACKEND_TYPE]):
     """
     Interface for an algorithm that performs solve tasks based on a given model.
 

luna_quantum/solve/parameters/algorithms/__init__.py

@@ -1,5 +1,6 @@
 from .flexible_parameter_algorithm import FlexibleParameterAlgorithm
 from .genetic_algorithms import QAGA, SAGA
+from .lq_fda import FujitsuDACpu, FujitsuDAv3c, FujitsuDAv4
 from .optimization_solvers import SCIP
 from .quantum_annealing import (
     Kerberos,
@@ -31,6 +32,9 @@ __all__ = [
     "DialecticSearch",
     "FlexQAOA",
     "FlexibleParameterAlgorithm",
+    "FujitsuDACpu",
+    "FujitsuDAv3c",
+    "FujitsuDAv4",
     "Kerberos",
     "LeapHybridBqm",
     "LeapHybridCqm",

luna_quantum/solve/parameters/algorithms/lq_fda/__init__.py

@@ -0,0 +1,9 @@
+from .fujitsu_da_cpu import FujitsuDACpu
+from .fujitsu_da_v3c import FujitsuDAv3c
+from .fujitsu_da_v4 import FujitsuDAv4
+
+__all__ = [
+    "FujitsuDACpu",
+    "FujitsuDAv3c",
+    "FujitsuDAv4",
+]