classiq 0.32.1__py3-none-any.whl → 0.34.0__py3-none-any.whl

classiq/__init__.py

@@ -1,5 +1,6 @@
 """Classiq SDK."""
 import sys
+from typing import List
 
 from classiq.interface._version import VERSION as _VERSION
 from classiq.interface.generator.application_apis import *  # noqa: F403
@@ -103,5 +104,5 @@ __all__ = (
 )
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/_analyzer_extras/_ipywidgets_async_extension.py

@@ -53,7 +53,7 @@ async def _create_interactive_loop_async(
 def _wait_for_change(widget: widgets) -> asyncio.Future:
     future: asyncio.Future = asyncio.Future()
 
-    def _get_value(change) -> None:
+    def _get_value(change) -> None:  # type: ignore[no-untyped-def]
         future.set_result(change.new)
         widget.unobserve(_get_value, "value")
 

classiq/_internals/api_wrapper.py

@@ -1,8 +1,7 @@
 import json
-from typing import Any, Dict, Optional, Protocol, Type, TypeVar, Union
+from typing import Dict, Optional, Protocol, Type, TypeVar
 
 import pydantic
-from pydantic import parse_obj_as
 
 import classiq.interface.pyomo_extension  # noqa: F401 - patches pyomo to add few features
 from classiq.interface.analyzer import analysis_params, result as analysis_result
@@ -19,10 +18,7 @@ from classiq._internals.enum_utils import StrEnum
 from classiq._internals.jobs import JobPoller
 from classiq.exceptions import ClassiqAPIError, ClassiqValueError
 
-_FAIL_FAST_INDICATOR = "{"
 ResultType = TypeVar("ResultType", bound=pydantic.BaseModel)
-OtherResultType = TypeVar("OtherResultType", bound=pydantic.BaseModel)
-_Circuit = Union[generator_result.GeneratedCircuit, generator_result.ExecutionCircuit]
 
 
 class HTTPMethod(StrEnum):
@@ -45,16 +41,6 @@ def _parse_job_response(
     return output_type.parse_obj(description)
 
 
-def _parse_job_response_multiple_outputs(
-    job_result: JobDescription[JSONObject],
-    output_type: Any,  # UnionType in Python 3.10,
-) -> Union[ResultType, OtherResultType]:
-    description = job_result.description
-    if job_result.status != JobStatus.COMPLETED:
-        raise ClassiqAPIError(description["details"])
-    return parse_obj_as(output_type, description)
-
-
 class ApiWrapper:
     @classmethod
     async def _call_task_pydantic(
@@ -82,22 +68,45 @@ class ApiWrapper:
         return res
 
     @classmethod
-    async def call_generation_task(cls, model: ModelInput) -> _Circuit:
+    async def call_generation_task(
+        cls, model: ModelInput
+    ) -> generator_result.GeneratedCircuit:
         poller = JobPoller(base_url=routes.TASKS_GENERATE_FULL_PATH)
         result = await poller.run_pydantic(model, timeout_sec=None)
-        return _parse_job_response_multiple_outputs(result, _Circuit)
+        return _parse_job_response(result, generator_result.GeneratedCircuit)
 
     @classmethod
     async def call_execute_generated_circuit(
-        cls,
-        circuit: _Circuit,
-    ) -> JobID:
+        cls, circuit: generator_result.GeneratedCircuit
+    ) -> execution_request.ExecutionJobDetails:
         data = await cls._call_task_pydantic(
             http_method=HTTPMethod.POST,
-            url=routes.EXECUTE_GENERATED_CIRCUIT_FULL_PATH,
+            url=routes.EXECUTION_JOBS_FULL_PATH,
             model=circuit,
         )
-        return JobID.parse_obj(data)
+        return execution_request.ExecutionJobDetails.parse_obj(data)
+
+    @classmethod
+    async def call_get_execution_job_details(
+        cls,
+        job_id: JobID,
+    ) -> execution_request.ExecutionJobDetails:
+        data = await cls._call_task(
+            http_method=HTTPMethod.GET,
+            url=f"{routes.EXECUTION_JOBS_FULL_PATH }/{job_id.job_id}",
+        )
+        return execution_request.ExecutionJobDetails.parse_obj(data)
+
+    @classmethod
+    async def call_get_execution_job_result(
+        cls,
+        job_id: JobID,
+    ) -> execution_request.ExecuteGeneratedCircuitResults:
+        data = await cls._call_task(
+            http_method=HTTPMethod.GET,
+            url=f"{routes.EXECUTION_JOBS_FULL_PATH }/{job_id.job_id}/result",
+        )
+        return execution_request.ExecuteGeneratedCircuitResults.parse_obj(data)
 
     @classmethod
     async def call_execute_estimate(
@@ -209,7 +218,9 @@ class ApiWrapper:
     async def call_generate_hamiltonian_task(
         cls, problem: ground_state_problem.CHEMISTRY_PROBLEMS_TYPE
     ) -> operator.PauliOperator:
-        poller = JobPoller(base_url=routes.CHEMISTRY_GENERATE_HAMILTONIAN_FULL_PATH)
+        poller = JobPoller(
+            base_url=routes.GENERATE_HAMILTONIAN_FULL_PATH, use_versioned_url=False
+        )
         result = await poller.run_pydantic(problem, timeout_sec=None)
         return _parse_job_response(result, operator.PauliOperator)
 

classiq/_internals/jobs.py

@@ -1,6 +1,6 @@
 import json
 import logging
-from typing import Dict, Iterable, Optional, Set
+from typing import Callable, Dict, Iterable, Optional, Set, TypeVar
 
 import httpx
 import pydantic
@@ -15,6 +15,7 @@ from classiq.exceptions import ClassiqAPIError
 _URL_PATH_SEP = "/"
 GeneralJobDescription = JobDescription[JSONObject]
 _logger = logging.getLogger(__name__)
+T = TypeVar("T")
 
 
 def _join_url_path(*parts: str) -> str:
@@ -33,6 +34,17 @@ def _join_url_path(*parts: str) -> str:
     )
 
 
+def _general_job_description_parser(
+    json_response: JSONObject,
+) -> Optional[GeneralJobDescription]:
+    job_description: GeneralJobDescription = GeneralJobDescription.parse_obj(
+        json_response
+    )
+    if job_description.status.is_final():
+        return job_description
+    return None
+
+
 class JobPoller:
     INITIAL_INTERVAL_SEC = 1
     INTERVAL_FACTOR = 2
@@ -40,11 +52,18 @@ class JobPoller:
     DEV_INTERVAL = 0.05
 
     def __init__(
-        self, base_url: str, required_headers: Optional[Set[str]] = None
+        self,
+        base_url: str,
+        required_headers: Optional[Set[str]] = None,
+        use_versioned_url: bool = True,
     ) -> None:
         self._required_headers = required_headers or set()
         client_instance = client()
-        self._base_url = client_instance.make_versioned_url(base_url)
+        self._base_url = (
+            client_instance.make_versioned_url(base_url)
+            if use_versioned_url
+            else base_url
+        )
         self._async_client = client_instance.async_client()
         self._mode = client_instance.config.mode
 
@@ -95,9 +114,12 @@ class JobPoller:
                 interval = min(interval * self.INTERVAL_FACTOR, self.FINAL_INTERVAL_SEC)
 
     async def _poll(
-        self, poll_url: str, timeout_sec: Optional[float]
-    ) -> GeneralJobDescription:
-        async def poller():
+        self,
+        poll_url: str,
+        timeout_sec: Optional[float],
+        response_parser: Callable[[JSONObject], Optional[T]] = _general_job_description_parser,  # type: ignore[assignment]
+    ) -> T:
+        async def poller() -> JSONObject:
             nonlocal self, poll_url
             raw_response = await self._request(http_method="GET", url=poll_url)
             return raw_response.json()
@@ -105,19 +127,24 @@ class JobPoller:
         async for json_response in poll_for(
             poller, timeout_sec=timeout_sec, interval_sec=self._interval_sec()
         ):
-            job_description: GeneralJobDescription = GeneralJobDescription.parse_obj(
-                json_response
-            )
-            if job_description.status.is_final():
-                return job_description
+            parsed = response_parser(json_response)
+            if parsed is not None:
+                return parsed
         raise ClassiqAPIError("API request timed out")
 
     async def poll(
-        self, job_id: JobID, timeout_sec: Optional[float]
-    ) -> GeneralJobDescription:
+        self,
+        job_id: JobID,
+        timeout_sec: Optional[float],
+        response_parser: Callable[[JSONObject], Optional[T]] = _general_job_description_parser,  # type: ignore[assignment]
+    ) -> T:
         poll_url = self._make_poll_url(job_id=job_id)
         async with self._async_client:
-            return await self._poll(poll_url=poll_url, timeout_sec=timeout_sec)
+            return await self._poll(
+                poll_url=poll_url,
+                response_parser=response_parser,
+                timeout_sec=timeout_sec,
+            )
 
     async def _cancel(self, poll_url: str) -> None:
         _logger.info("Cancelling job %s", poll_url, exc_info=True)

classiq/analyzer/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 import classiq.analyzer.show_interactive_hack
 from classiq.analyzer.analyzer import Analyzer
 
@@ -6,5 +8,5 @@ from ..analyzer import rb
 __all__ = ["rb"]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return ["rb"]

classiq/applications/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from classiq.applications import (
     benchmarking,
     chemistry,
@@ -18,5 +20,5 @@ __all__ = [
 _NON_IMPORTED_PUBLIC_SUBMODULES = ["qnn"]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__ + _NON_IMPORTED_PUBLIC_SUBMODULES

classiq/applications/benchmarking/__init__.py

@@ -1,7 +1,9 @@
+from typing import List
+
 from classiq.applications.benchmarking.mirror_benchmarking import MirrorBenchmarking
 
 __all__ = ["MirrorBenchmarking"]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications/chemistry/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from classiq.interface.chemistry.fermionic_operator import (
     FermionicOperator,
     SummedFermionicOperator,
@@ -30,5 +32,5 @@ __all__ = [
 ]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications/combinatorial_optimization/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from classiq.interface.combinatorial_optimization import examples
 from classiq.interface.combinatorial_optimization.solver_types import QSolver
 
@@ -11,5 +13,5 @@ __all__ = [
 ]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications/combinatorial_optimization/examples/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from classiq.interface.combinatorial_optimization.examples.ascending_sequence import (
     ascending_sequence,
 )
@@ -45,5 +47,5 @@ __all__ = [
 ]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications/finance/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from classiq.interface.finance import (
     function_input,
     gaussian_model_input,
@@ -13,5 +15,5 @@ __all__ = [
 ]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications/qnn/__init__.py

@@ -1,5 +1,7 @@
 # This file will be called first whenever any file from within this directory is imported.
 # Thus, we'll test dependencies only here, once.
+from typing import List
+
 try:
     import torch
 except ImportError as exc:
@@ -11,5 +13,5 @@ from ..qnn.qlayer import QLayer
 __all__ = ["datasets", "types", "QLayer"]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications/qnn/datasets/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from ..datasets import builtin_datasets
 from ..datasets.builtin_datasets import (
     DATALOADER_NOT,
@@ -29,5 +31,5 @@ __all__ = [
 ]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications/qsvm/qsvm.py

@@ -13,5 +13,5 @@ __all__ = [
 ]
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/applications_model_constructors/grover_model_constructor.py

@@ -4,6 +4,7 @@ from classiq.interface.generator.expressions.expression import Expression
 from classiq.interface.generator.functions.port_declaration import (
     PortDeclarationDirection,
 )
+from classiq.interface.model.bind_operation import BindOperation
 from classiq.interface.model.handle_binding import HandleBinding, SlicedHandleBinding
 from classiq.interface.model.local_variable_declaration import LocalVariableDeclaration
 from classiq.interface.model.model import Model, SerializedModel
@@ -16,6 +17,7 @@ from classiq.interface.model.quantum_function_call import (
     QuantumFunctionCall,
     QuantumLambdaFunction,
 )
+from classiq.interface.model.quantum_statement import QuantumStatement
 from classiq.interface.model.quantum_type import (
     QuantumFixedReal,
     QuantumInteger,
@@ -33,7 +35,7 @@ def split_registers(
     register_names: List[str],
     register_sizes: List[int],
     input_wire_name: str,
-) -> List[QuantumFunctionCall]:
+) -> List[QuantumStatement]:
     if len(register_names) == 0:
         return []
     wires = (
@@ -41,6 +43,15 @@ def split_registers(
         + [f"split{i}" for i in range(len(register_names) - 2)]
         + [register_names[-1]]
     )
+
+    if len(register_names) == 1:
+        return [
+            BindOperation(
+                in_handle=HandleBinding(name=wires[0]),
+                out_handle=HandleBinding(name=wires[1]),
+            )
+        ]
+
     return [
         QuantumFunctionCall(
             function="split",
@@ -119,6 +130,18 @@ def grover_main_port_declarations(
     }
 
 
+def _generate_local_variable_declarations(
+    definitions: List[Tuple[str, RegisterUserInput]]
+) -> List[LocalVariableDeclaration]:
+    ret = [LocalVariableDeclaration(name="gsq")]
+    if len(definitions) >= 2:
+        ret += [
+            LocalVariableDeclaration(name=f"split{i}")
+            for i in range(len(definitions) - 2)
+        ]
+    return ret
+
+
 def construct_grover_model(
     definitions: List[Tuple[str, RegisterUserInput]],
     expression: str,
@@ -150,13 +173,7 @@ def construct_grover_model(
                 port_declarations=grover_main_port_declarations(
                     definitions, PortDeclarationDirection.Output
                 ),
-                local_handles=[
-                    LocalVariableDeclaration(name="gsq"),
-                    *[
-                        LocalVariableDeclaration(name=f"split{i}")
-                        for i in range(len(definitions) - 2)
-                    ],
-                ],
+                local_handles=_generate_local_variable_declarations(definitions),
                 body=[
                     QuantumFunctionCall(
                         function="grover_search",

classiq/builtin_functions/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from classiq.interface.generator.function_param_list import *  # noqa: F403
 from classiq.interface.generator.function_param_list_without_self_reference import *  # noqa: F403
 from classiq.interface.generator.oracles.oracle_function_param_list import *  # noqa: F403
@@ -37,5 +39,5 @@ __all__ = (
 )
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/execution/__init__.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from ..executor import *  # noqa: F403
 from ..executor import __all__ as _exec_all
 from ..interface.backend.backend_preferences import *  # noqa: F403
@@ -17,5 +19,5 @@ __all__ = (
 )
 
 
-def __dir__():
+def __dir__() -> List[str]:
     return __all__

classiq/execution/jobs.py

@@ -1,40 +1,77 @@
-from dataclasses import dataclass, field
 from typing import Optional
 
+from pydantic import PrivateAttr
+
 from classiq.interface.executor.execution_request import (
-    ExecuteGeneratedCircuitResults,
+    ExecutionJobDetails,
     ResultsCollection,
 )
-from classiq.interface.server.routes import EXECUTE_GENERATED_CIRCUIT_FULL_PATH
+from classiq.interface.jobs import JobStatus, JSONObject
+from classiq.interface.server.routes import EXECUTION_JOBS_FULL_PATH
 
-from classiq._internals.api_wrapper import _parse_job_response
+from classiq._internals.api_wrapper import ApiWrapper
 from classiq._internals.async_utils import syncify_function
 from classiq._internals.jobs import JobID, JobPoller
+from classiq.exceptions import ClassiqAPIError
+
+
+class ExecutionJob(ExecutionJobDetails):
+    _result: Optional[ResultsCollection] = PrivateAttr(default=None)
+
+    def __init__(self, details: ExecutionJobDetails) -> None:
+        super().__init__(**details.dict())
 
+    def _update_details(self, details: ExecutionJobDetails) -> None:
+        for k, v in details.dict().items():
+            setattr(self, k, v)
 
-@dataclass
-class ExecutionJob:
-    id: str
-    _result: Optional[ResultsCollection] = field(default=None, repr=False)
+    @classmethod
+    async def from_id_async(cls, id: str) -> "ExecutionJob":
+        details = await ApiWrapper.call_get_execution_job_details(JobID(job_id=id))
+        return cls(details)
+
+    @classmethod
+    def from_id(cls, id: str) -> "ExecutionJob":
+        return syncify_function(cls.from_id_async)(id)
+
+    @property
+    def _job_id(self) -> JobID:
+        return JobID(job_id=self.id)
 
     async def result_async(
         self, timeout_sec: Optional[float] = None
     ) -> ResultsCollection:
+        await self.poll_async(timeout_sec=timeout_sec)
+
+        if self.status == JobStatus.FAILED:
+            raise ClassiqAPIError(self.error or "")
+        if self.status == JobStatus.CANCELLED:
+            raise ClassiqAPIError("Job has been cancelled.")
+
         if self._result is None:
-            self._result = await self._poll_result(timeout_sec=timeout_sec)
+            self._result = (
+                await ApiWrapper.call_get_execution_job_result(self._job_id)
+            ).results
         return self._result
 
     result = syncify_function(result_async)
 
-    async def _poll_result(
-        self, timeout_sec: Optional[float] = None
-    ) -> ResultsCollection:
-        poller = JobPoller(base_url=EXECUTE_GENERATED_CIRCUIT_FULL_PATH)
-        response = await poller.poll(
-            job_id=JobID(job_id=self.id), timeout_sec=timeout_sec
-        )
-        raw_result = _parse_job_response(
-            job_result=response,
-            output_type=ExecuteGeneratedCircuitResults,
+    async def poll_async(self, timeout_sec: Optional[float] = None) -> None:
+        if not self.status.is_final():
+            await self._poll_job(timeout_sec=timeout_sec)
+
+    poll = syncify_function(poll_async)
+
+    async def _poll_job(self, timeout_sec: Optional[float] = None) -> None:
+        def response_parser(json_response: JSONObject) -> Optional[bool]:
+            self._update_details(ExecutionJobDetails.parse_obj(json_response))
+            if self.status.is_final():
+                return True
+            return None
+
+        poller = JobPoller(base_url=EXECUTION_JOBS_FULL_PATH)
+        await poller.poll(
+            job_id=self._job_id,
+            response_parser=response_parser,
+            timeout_sec=timeout_sec,
         )
-        return raw_result.results

classiq/executor.py

@@ -3,7 +3,6 @@ import functools
 from typing import Optional, Tuple, Union
 
 import more_itertools
-from pydantic import parse_raw_as
 from typing_extensions import TypeAlias
 
 from classiq.interface.backend.backend_preferences import BackendPreferencesTypes
@@ -19,10 +18,7 @@ from classiq.interface.executor.execution_request import (
 from classiq.interface.executor.quantum_instruction_set import QuantumInstructionSet
 from classiq.interface.executor.quantum_program import MultipleArguments, QuantumProgram
 from classiq.interface.executor.result import ExecutionDetails
-from classiq.interface.generator.generated_circuit import (
-    ExecutionCircuit,
-    GeneratedCircuit,
-)
+from classiq.interface.generator.generated_circuit import GeneratedCircuit
 
 from classiq._internals.api_wrapper import ApiWrapper
 from classiq._internals.async_utils import syncify_function
@@ -40,17 +36,14 @@ _MAX_ARGUMENTS_SIZE = 1024
 
 def _parse_serialized_qprog(
     quantum_program: SerializedQuantumProgram,
-) -> Union[GeneratedCircuit, ExecutionCircuit]:
-    return parse_raw_as(
-        Union[GeneratedCircuit, ExecutionCircuit],  # type:ignore[arg-type]
-        quantum_program,
-    )
+) -> GeneratedCircuit:
+    return GeneratedCircuit.parse_raw(quantum_program)
 
 
 async def execute_async(quantum_program: SerializedQuantumProgram) -> ExecutionJob:
     circuit = _parse_serialized_qprog(quantum_program)
     result = await ApiWrapper.call_execute_generated_circuit(circuit)
-    return ExecutionJob(id=result.job_id)
+    return ExecutionJob(details=result)
 
 
 execute = syncify_function(execute_async)

classiq/interface/_version.py

@@ -3,5 +3,5 @@ from packaging.version import Version
 # This file was generated automatically
 # Please don't track in version control (DONTTRACK)
 
-SEMVER_VERSION = '0.32.1'
+SEMVER_VERSION = '0.34.0'
 VERSION = str(Version(SEMVER_VERSION))

classiq/interface/analyzer/analysis_params.py

@@ -82,7 +82,7 @@ class ChemistryGenerationParams(pydantic.BaseModel):
         title = "Chemistry"
 
     molecule: MoleculeProblem = pydantic.Field(
-        title="Molecule Problem",
+        title="Molecule",
         default=...,
         description="The molecule to generate the VQE ansatz for",
     )

classiq/interface/backend/backend_preferences.py

@@ -9,6 +9,7 @@ from pydantic import BaseModel, validator
 from classiq.interface.backend import pydantic_backend
 from classiq.interface.backend.quantum_backend_providers import (
     EXACT_SIMULATORS,
+    AliceBobBackendNames,
     AmazonBraketBackendNames,
     AzureQuantumBackendNames,
     ClassiqAerBackendNames,
@@ -55,6 +56,19 @@ class BackendPreferences(BaseModel):
 AWS_DEFAULT_JOB_TIMEOUT_SECONDS = int(timedelta(minutes=5).total_seconds())
 
 
+class AliceBobBackendPreferences(BackendPreferences):
+    backend_service_provider: ProviderTypeVendor.ALICE_BOB
+    api_key: pydantic_backend.PydanticAliceBobApiKeyType = pydantic.Field(
+        ..., description="AliceBob API key"
+    )
+
+    @pydantic.root_validator(pre=True)
+    def _set_backend_service_provider(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+        return values_with_discriminator(
+            values, "backend_service_provider", ProviderVendor.ALICE_AND_BOB
+        )
+
+
 class ClassiqBackendPreferences(BackendPreferences):
     backend_service_provider: ProviderTypeVendor.CLASSIQ
 
@@ -214,6 +228,7 @@ BackendPreferencesTypes = Union[
     AwsBackendPreferences,
     IonqBackendPreferences,
     GCPBackendPreferences,
+    AliceBobBackendPreferences,
 ]
 
 __all__ = [
@@ -230,6 +245,8 @@ __all__ = [
     "IonqBackendNames",
     "ClassiqNvidiaBackendNames",
     "GCPBackendPreferences",
+    "AliceBobBackendPreferences",
+    "AliceBobBackendNames",
 ]