azure-quantum 3.5.1.dev0__py3-none-any.whl → 3.6.0__py3-none-any.whl

azure/quantum/_client/operations/_patch.py

@@ -1,14 +1,15 @@
-# ------------------------------------
-# Copyright (c) Microsoft Corporation.
-# Licensed under the MIT License.
-# ------------------------------------
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------
 """Customize generated code here.
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
-from typing import List
 
-__all__: List[str] = []  # Add all objects you want publicly available to users at this package level
+
+__all__: list[str] = []  # Add all objects you want publicly available to users at this package level
 
 
 def patch_sdk():

azure/quantum/_constants.py

@@ -51,6 +51,11 @@ class EnvironmentKind(Enum):
     DOGFOOD = 3
 
 
+class WorkspaceKind(Enum):
+    V1 = "V1"
+    V2 = "V2"
+
+
 class ConnectionConstants:
     DATA_PLANE_CREDENTIAL_SCOPE = "https://quantum.microsoft.com/.default"
     ARM_CREDENTIAL_SCOPE = "https://management.azure.com/.default"

azure/quantum/_mgmt_client.py

@@ -9,7 +9,7 @@ Created to do not add additional azure-mgmt-* dependencies that can conflict wit
 
 import logging
 from http import HTTPStatus
-from typing import Any, Optional, cast
+from typing import Any, Dict, Optional, cast
 from azure.core import PipelineClient
 from azure.core.credentials import TokenProvider
 from azure.core.pipeline import policies
@@ -104,8 +104,8 @@ class WorkspaceMgmtClient():
             query += f"\n                | where location =~ '{connection_params.location}'"
 
         query += """
-            | extend endpointUri = tostring(properties.endpointUri)
-            | project name, subscriptionId, resourceGroup, location, endpointUri
+            | extend endpointUri = tostring(properties.endpointUri), workspaceKind = tostring(properties.workspaceKind)
+            | project name, subscriptionId, resourceGroup, location, endpointUri, workspaceKind
         """
 
         request_body = {
@@ -143,20 +143,22 @@ class WorkspaceMgmtClient():
                 f"Please specify additional connection parameters. {self.CONNECT_DOC_MESSAGE}"
             )
         
-        workspace_data = data[0]
+        workspace_data: Dict[str, Any] = data[0]
         
         connection_params.subscription_id = workspace_data.get('subscriptionId')
         connection_params.resource_group = workspace_data.get('resourceGroup')
         connection_params.location = workspace_data.get('location')
         connection_params.quantum_endpoint = workspace_data.get('endpointUri')
+        connection_params.workspace_kind = workspace_data.get('workspaceKind')
 
         logger.debug(
-            "Found workspace '%s' in subscription '%s', resource group '%s', location '%s', endpoint '%s'",
+            "Found workspace '%s' in subscription '%s', resource group '%s', location '%s', endpoint '%s', kind '%s'.",
             connection_params.workspace_name,
             connection_params.subscription_id,
             connection_params.resource_group,
             connection_params.location,
-            connection_params.quantum_endpoint
+            connection_params.quantum_endpoint,
+            connection_params.workspace_kind
         )
 
         # If one of the required parameters is missing, probably workspace in failed provisioning state
@@ -194,7 +196,7 @@ class WorkspaceMgmtClient():
         try:
             response = self._client.send_request(request)
             response.raise_for_status()
-            workspace_data = response.json()
+            workspace_data: Dict[str, Any] = response.json()
         except HttpResponseError as e:
             if e.status_code == HTTPStatus.NOT_FOUND:
                 raise ValueError(
@@ -225,7 +227,7 @@ class WorkspaceMgmtClient():
             )
 
         # Extract and apply endpoint URI from properties
-        properties = workspace_data.get("properties", {})
+        properties: Dict[str, Any] = workspace_data.get("properties", {})
         endpoint_uri = properties.get("endpointUri")
         if endpoint_uri:
             connection_params.quantum_endpoint = endpoint_uri
@@ -237,3 +239,11 @@ class WorkspaceMgmtClient():
                 f"Failed to retrieve endpoint uri for workspace '{connection_params.workspace_name}'. "
                 f"Please check that workspace is in valid state."
             )
+        
+        # Set workspaceKind if available
+        workspace_kind = properties.get("workspaceKind")
+        if workspace_kind:
+            connection_params.workspace_kind = workspace_kind
+            logger.debug(
+                "Updated workspace kind from ARM: %s", connection_params.workspace_kind
+            )

azure/quantum/_workspace_connection_params.py

@@ -17,6 +17,7 @@ from azure.core.pipeline.policies import AzureKeyCredentialPolicy
 from azure.identity import DefaultAzureCredential
 from azure.quantum._constants import (
     EnvironmentKind,
+    WorkspaceKind,
     EnvironmentVariables,
     ConnectionConstants,
     GUID_REGEX_PATTERN,
@@ -48,7 +49,7 @@ class WorkspaceConnectionParams:
             ResourceGroupName=(?P<resource_group>[^\s;]+);
             WorkspaceName=(?P<workspace_name>[^\s;]+);
             ApiKey=(?P<api_key>[^\s;]+);
-            QuantumEndpoint=(?P<quantum_endpoint>https://(?P<location>[a-zA-Z0-9]+)(?:-v2)?.quantum(?:-test)?.azure.com/);
+            QuantumEndpoint=(?P<quantum_endpoint>https://(?P<location>[a-zA-Z0-9]+)(?:-(?P<workspace_kind>v2))?.quantum(?:-test)?.azure.com/);
         """,
         re.VERBOSE | re.IGNORECASE)
     
@@ -80,6 +81,7 @@ class WorkspaceConnectionParams:
         api_version: Optional[str] = None,
         connection_string: Optional[str] = None,
         on_new_client_request: Optional[Callable] = None,
+        workspace_kind: Optional[str] = None,
     ):
         # fields are used for these properties since
         # they have special getters/setters
@@ -87,6 +89,7 @@ class WorkspaceConnectionParams:
         self._environment = None
         self._quantum_endpoint = None
         self._arm_endpoint = None
+        self._workspace_kind = None
         # regular connection properties
         self.subscription_id = None
         self.resource_group = None
@@ -120,6 +123,7 @@ class WorkspaceConnectionParams:
             user_agent=user_agent,
             user_agent_app_id=user_agent_app_id,
             workspace_name=workspace_name,
+            workspace_kind=workspace_kind,
         )
         self.apply_resource_id(resource_id=resource_id)
         # Validate connection parameters if they are set
@@ -272,6 +276,19 @@ class WorkspaceConnectionParams:
             self.credential = AzureKeyCredential(value)
         self._api_key = value
 
+    @property
+    def workspace_kind(self) -> WorkspaceKind:
+        """
+        The workspace kind, such as V1 or V2.
+        Defaults to WorkspaceKind.V1
+        """
+        return self._workspace_kind or WorkspaceKind.V1
+
+    @workspace_kind.setter
+    def workspace_kind(self, value: str):
+        if isinstance(value, str):
+            self._workspace_kind = WorkspaceKind[value.upper()]
+
     def __repr__(self):
         """
         Print all fields and properties.
@@ -331,6 +348,7 @@ class WorkspaceConnectionParams:
         client_id: Optional[str] = None,
         api_version: Optional[str] = None,
         api_key: Optional[str] = None,
+        workspace_kind: Optional[str] = None,
     ):
         """
         Set all fields/properties with `not None` values
@@ -352,6 +370,7 @@ class WorkspaceConnectionParams:
             user_agent_app_id=user_agent_app_id,
             workspace_name=workspace_name,
             api_key=api_key,
+            workspace_kind=workspace_kind,
             merge_default_mode=False,
         )
         return self
@@ -372,6 +391,7 @@ class WorkspaceConnectionParams:
         client_id: Optional[str] = None,
         api_version: Optional[str] = None,
         api_key: Optional[str] = None,
+        workspace_kind: Optional[str] = None,
     ) -> WorkspaceConnectionParams:
         """
         Set all fields/properties with `not None` values
@@ -394,6 +414,7 @@ class WorkspaceConnectionParams:
             user_agent_app_id=user_agent_app_id,
             workspace_name=workspace_name,
             api_key=api_key,
+            workspace_kind=workspace_kind,
             merge_default_mode=True,
         )
         return self
@@ -415,6 +436,7 @@ class WorkspaceConnectionParams:
         client_id: Optional[str] = None,
         api_version: Optional[str] = None,
         api_key: Optional[str] = None,
+        workspace_kind: Optional[str] = None,
     ):
         """
         Set all fields/properties with `not None` values
@@ -447,6 +469,7 @@ class WorkspaceConnectionParams:
         # the private field as the old_value
         self.quantum_endpoint = _get_value_or_default(self._quantum_endpoint, quantum_endpoint)
         self.arm_endpoint = _get_value_or_default(self._arm_endpoint, arm_endpoint)
+        self.workspace_kind = _get_value_or_default(self._workspace_kind, workspace_kind)
         return self
 
     def _merge_connection_params(
@@ -476,6 +499,7 @@ class WorkspaceConnectionParams:
             # pylint: disable=protected-access
             arm_endpoint=connection_params._arm_endpoint,
             quantum_endpoint=connection_params._quantum_endpoint,
+            workspace_kind=connection_params._workspace_kind,
         )
         return self
 
@@ -500,7 +524,7 @@ class WorkspaceConnectionParams:
     def append_user_agent(self, value: str):
         """
         Append a new value to the Workspace's UserAgent and re-initialize the
-        QuantumClient. The values are appended using a dash.
+        WorkspaceClient. The values are appended using a dash.
 
         :param value: UserAgent value to add, e.g. "azure-quantum-<plugin>"
         """
@@ -640,4 +664,5 @@ class WorkspaceConnectionParams:
             quantum_endpoint=get_value('quantum_endpoint'),
             api_key=get_value('api_key'),
             arm_endpoint=get_value('arm_endpoint'),
+            workspace_kind=get_value('workspace_kind'),
         )

azure/quantum/job/base_job.py

@@ -85,6 +85,7 @@ class BaseJob(WorkspaceItem):
         output_data_format: str = None,
         input_params: Dict[str, Any] = None,
         session_id: Optional[str] = None,
+        priority: Optional[str] = None,
         **kwargs
     ) -> "BaseJob":
         """Create a new Azure Quantum job based on a raw input_data payload.
@@ -117,6 +118,8 @@ class BaseJob(WorkspaceItem):
         :type input_params: Dict[str, Any]
         :param input_params: Input params for job
         :type input_params: Dict[str, Any]
+        :param priority: Priority of job.
+        :type priority: str
         :return: Azure Quantum Job
         :rtype: Job
         """
@@ -153,6 +156,7 @@ class BaseJob(WorkspaceItem):
             provider_id=provider_id,
             input_params=input_params,
             session_id=session_id,
+            priority=priority,
             **kwargs
         )
 
@@ -171,6 +175,7 @@ class BaseJob(WorkspaceItem):
         input_params: Dict[str, Any] = None,
         submit_job: bool = True,
         session_id: Optional[str] = None,
+        priority: Optional[str] = None,
         **kwargs
     ) -> "BaseJob":
         """Create new Job from URI if input data is already uploaded
@@ -198,6 +203,8 @@ class BaseJob(WorkspaceItem):
         :type input_params: Dict[str, Any]
         :param submit_job: If job should be submitted to the service, defaults to True
         :type submit_job: bool
+        :param priority: Priority of job.
+        :type priority: str
         :return: Job instance
         :rtype: Job
         """
@@ -223,6 +230,7 @@ class BaseJob(WorkspaceItem):
             target=target,
             input_params=input_params,
             session_id=session_id,
+            priority=priority,
             **kwargs
         )
         job = cls(workspace, details, **kwargs)

azure/quantum/job/job.py

@@ -125,7 +125,7 @@ class Job(BaseJob, FilteredJob):
         if not self.has_completed():
             self.wait_until_completed(timeout_secs=timeout_secs)
 
-        if not self.details.status == "Succeeded" or self.details.status == "Completed":
+        if not self.details.status == "Succeeded" and not self.details.status == "Completed":
             if self.details.status == "Failed" and self._allow_failure_results():
                 job_blob_properties = self.download_blob_properties(self.details.output_data_uri)
                 if job_blob_properties.size > 0:

azure/quantum/job/session.py

@@ -48,6 +48,9 @@ class Session(WorkspaceItem):
                                close and not accept further jobs.
     :type job_failure_policy: Union[str, SessionJobFailurePolicy, None]
 
+    :param priority: Priority of the session.
+    :type priority: Optional[str]
+
     :raises ValueError: if details is passed along individual parameters,
                         or if required parameters are missing.
     """
@@ -61,6 +64,7 @@ class Session(WorkspaceItem):
             id: Optional[str] = None,
             name: Optional[str] = None,
             job_failure_policy: Union[str, SessionJobFailurePolicy, None] = None,
+            priority: Optional[str] = None,
             **kwargs):
         from azure.quantum.target import Target
         target_name = target.name if isinstance(target, Target) else target
@@ -92,6 +96,7 @@ class Session(WorkspaceItem):
                                      provider_id=provider_id,
                                      target=target_name,
                                      job_failure_policy=job_failure_policy,
+                                     priority=priority,
                                      **kwargs)
 
         super().__init__(
@@ -259,6 +264,7 @@ class SessionHost(Protocol):
         id: Optional[str] = None,
         name: Optional[str] = None,
         job_failure_policy: Union[str, SessionJobFailurePolicy, None] = None,
+        priority: Optional[str] = None,
         **kwargs
     ) -> Session:
         """Opens a session and associates all future job submissions to that
@@ -295,6 +301,10 @@ class SessionHost(Protocol):
 
         :param job_failure_policy: The policy that determines when a session would fail,
                                 close and not accept further jobs.
+        :type job_failure_policy: Union[str, SessionJobFailurePolicy, None]
+
+        :param priority: Priority of the session.
+        :type priority: Optional[str]
 
         :return: The session object with updated details after its opening.
         :rtype: Session
@@ -309,6 +319,7 @@ class SessionHost(Protocol):
                           workspace=self._get_azure_workspace(),
                           target=self._get_azure_target_id(),
                           provider_id=self._get_azure_provider_id(),
+                          priority=priority,
                           **kwargs)
         self.latest_session = session
         return session.open()

azure/quantum/target/target.py

@@ -2,7 +2,7 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 ##
-from typing import TYPE_CHECKING, Any, Dict, Union, Type,  Protocol, runtime_checkable
+from typing import TYPE_CHECKING, Any, Dict, Union, Type, Optional, Protocol, runtime_checkable
 from dataclasses import dataclass
 import io
 import json
@@ -210,6 +210,7 @@ target '{self.name}' of provider '{self.provider_id}' not found."
         name: str = "azure-quantum-job",
         shots: int = None,
         input_params: Union[Dict[str, Any], InputParams, None] = None,
+        priority: Optional[str] = None,
         **kwargs
     ) -> Job:
         """Submit input data and return Job.
@@ -225,6 +226,8 @@ target '{self.name}' of provider '{self.provider_id}' not found."
         :type shots: int
         :param input_params: Input parameters
         :type input_params: Dict[str, Any]
+        :param priority: Priority of job.
+        :type priority: str
         :return: Azure Quantum job
         :rtype: azure.quantum.job.Job
         """
@@ -320,6 +323,7 @@ target '{self.name}' of provider '{self.provider_id}' not found."
             output_data_format=output_data_format,
             input_params=input_params,
             session_id=self.get_latest_session_id(),
+            priority=priority,
             **kwargs
         )
 

azure/quantum/target/target_factory.py

@@ -5,6 +5,7 @@
 import warnings
 from typing import Any, Dict, List, TYPE_CHECKING, Union, Type
 from azure.quantum.target import *
+from azure.quantum._constants import WorkspaceKind
 
 if TYPE_CHECKING:
     from azure.quantum import Workspace
@@ -134,10 +135,16 @@ class TargetFactory:
                 return result
 
         else:
-            # Don't return redundant targets
-            return [
-                self.from_target_status(_provider_id, status, **kwargs)
-                for _provider_id, status in target_statuses
-                if _provider_id.lower() in self._default_targets
-                    or status.id in self._all_targets
-            ]
+            if self._workspace._connection_params.workspace_kind == WorkspaceKind.V1:
+                # Filter only relevant targets for user's selected framework like Cirq, Qiskit, etc.
+                return [
+                    self.from_target_status(_provider_id, status, **kwargs)
+                    for _provider_id, status in target_statuses
+                    if _provider_id.lower() in self._default_targets
+                        or status.id in self._all_targets
+                ]
+            else:
+                return [
+                    self.from_target_status(_provider_id, status, **kwargs)
+                    for _provider_id, status in target_statuses
+                ]

azure/quantum/version.py

@@ -5,4 +5,4 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 ##
-__version__ = "3.5.1.dev0"
+__version__ = "3.6.0"