azure-quantum 1.1.1__py3-none-any.whl → 1.1.2.dev0__py3-none-any.whl

azure/quantum/workspace.py

@@ -2,17 +2,19 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 ##
+
+from __future__ import annotations
 from datetime import datetime
 import logging
-import os
-import re
-
-from typing import Any, Dict, Iterable, List, Optional, TYPE_CHECKING, Tuple, Union
-
-# Temporarily replacing the DefaultAzureCredential with
-# a custom _DefaultAzureCredential
-#   from azure.identity import DefaultAzureCredential
-from azure.quantum._authentication import _DefaultAzureCredential
+from typing import (
+    Any,
+    Dict,
+    Iterable,
+    List,
+    Optional,
+    TYPE_CHECKING,
+    Tuple,
+    Union)
 
 from azure.quantum._client import QuantumClient
 from azure.quantum._client.operations import (
@@ -23,10 +25,18 @@ from azure.quantum._client.operations import (
     TopLevelItemsOperations
 )
 from azure.quantum._client.models import BlobDetails, JobStatus
-from azure.quantum import Job, Session
-from azure.quantum.storage import create_container_using_client, get_container_uri, ContainerClient
-
-from .version import __version__
+from azure.quantum import  Job, Session
+from azure.quantum._workspace_connection_params import (
+    WorkspaceConnectionParams
+)
+from azure.quantum._constants import (
+    ConnectionConstants,
+)
+from azure.quantum.storage import (
+    create_container_using_client,
+    get_container_uri,
+    ContainerClient
+)
 
 if TYPE_CHECKING:
     from azure.quantum._client.models import TargetStatus
@@ -36,65 +46,36 @@ logger = logging.getLogger(__name__)
 
 __all__ = ["Workspace"]
 
-DEFAULT_CONTAINER_NAME_FORMAT = "job-{job_id}"
-USER_AGENT_APPID_ENV_VAR_NAME = "AZURE_QUANTUM_PYTHON_APPID"
-
-
-def sdk_environment(name):
-    return (
-        "AZURE_QUANTUM_ENV" in os.environ
-        and os.environ["AZURE_QUANTUM_ENV"] == name
-    )
-
-
-# Settings based on environment variables:
-BASE_URL_FROM_ENV = (
-    os.environ["AZURE_QUANTUM_BASEURL"]
-    if "AZURE_QUANTUM_BASEURL" in os.environ
-    else None
-)
-if sdk_environment("dogfood"):
-    logger.info("Using DOGFOOD configuration.")
-    BASE_URL = (
-        lambda location: BASE_URL_FROM_ENV
-        or f"https://{location}.quantum-test.azure.com/"
-    )
-    ARM_BASE_URL = "https://api-dogfood.resources.windows-int.net/"
-else:
-    if sdk_environment("canary"):
-        logger.info("Using CANARY configuration.")
-        BASE_URL = (
-            lambda location: BASE_URL_FROM_ENV
-            or f'{"https://eastus2euap.quantum.azure.com/"}'
-        )
-    else:
-        logger.debug("Using production configuration.")
-        BASE_URL = (
-            lambda location: BASE_URL_FROM_ENV
-            or f"https://{location}.quantum.azure.com/"
-        )
-    ARM_BASE_URL = "https://management.azure.com/"
-
 
 class Workspace:
+    DEFAULT_CONTAINER_NAME_FORMAT = "job-{job_id}"
+
     """Represents an Azure Quantum workspace.
 
-    When creating a Workspace object, callers have two options for identifying
-    the Azure Quantum workspace:
-    1. specify a valid resource ID, or
-    2. specify a valid subscription ID, resource group, and workspace name.
+    When creating a Workspace object, callers have two options for
+    identifying the Azure Quantum workspace (in order of precedence):
+    1. specify a valid location and resource ID; or
+    2. specify a valid location, subscription ID,
+       resource group, and workspace name.
+
+    You can also use a connection string to specify the connection parameters
+    to a Azure Quantum Workspace by calling:
+        Workspace.from_connection_string()
 
     If the Azure Quantum workspace does not have linked storage, the caller
     must also pass a valid Azure storage account connection string.
 
     :param subscription_id:
-        The Azure subscription ID. Ignored if resource_id is specified.
+        The Azure subscription ID.
+        Ignored if resource_id is specified.
 
     :param resource_group:
-        The Azure resource group name. Ignored if resource_id is specified.
+        The Azure resource group name.
+        Ignored if resource_id is specified.
 
     :param name:
-        The Azure Quantum workspace name. Ignored if resource_id is specified.
+        The Azure Quantum workspace name.
+        Ignored if resource_id is specified.
 
     :param storage:
         The Azure storage account connection string.
@@ -113,15 +94,12 @@ class Workspace:
         The credential to use to connect to Azure services.
         Normally one of the credential types from Azure.Identity (https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#credential-classes).
 
-        Defaults to \"DefaultAzureCredential\", which will attempt multiple 
+        Defaults to \"DefaultAzureCredential\", which will attempt multiple
         forms of authentication.
 
     :param user_agent:
         Add the specified value as a prefix to the HTTP User-Agent header when communicating to the Azure Quantum service.
     """
-
-    credentials = None
-
     def __init__(
         self,
         subscription_id: Optional[str] = None,
@@ -132,110 +110,107 @@ class Workspace:
         location: Optional[str] = None,
         credential: Optional[object] = None,
         user_agent: Optional[str] = None,
+        **kwargs: Any,
     ):
-        if resource_id is not None:
-            # A valid resource ID looks like:
-            # /subscriptions/f846b2bd-d0e2-4a1d-8141-4c6944a9d387/resourceGroups/
-            # RESOURCE_GROUP_NAME/providers/Microsoft.Quantum/Workspaces/WORKSPACE_NAME
-            regex = r"^/subscriptions/([a-fA-F0-9-]*)/resourceGroups/([^\s/]*)/providers/Microsoft\.Quantum/Workspaces/([^\s/]*)$"
-            match = re.search(regex, resource_id, re.IGNORECASE)
-            if match:
-                # match should contain four groups:
-                # -> match.group(0):
-                # The full resource ID for the Azure Quantum workspace
-                # -> match.group(1): The Azure subscription ID
-                # -> match.group(2): The Azure resource group name
-                # -> match.group(3): The Azure Quantum workspace name
-                subscription_id = match.group(1)
-                resource_group = match.group(2)
-                name = match.group(3)
-
-        if not subscription_id or not resource_group or not name:
-            raise ValueError(
-                "Azure Quantum workspace not fully specified."
-                + "Please specify either a valid resource ID "
-                + "or a valid combination of subscription ID,"
-                + "resource group name, and workspace name."
-            )
+        connection_params = WorkspaceConnectionParams(
+            location=location,
+            subscription_id=subscription_id,
+            resource_group=resource_group,
+            workspace_name=name,
+            credential=credential,
+            resource_id=resource_id,
+            user_agent=user_agent,
+            **kwargs
+        ).default_from_env_vars()
+        
+        logger.info("Using %s environment.", connection_params.environment)
+
+        connection_params.assert_complete()
 
-        if not location:
-            raise ValueError(
-                "Azure Quantum workspace does not have an associated location. " +
-                "Please specify the location associated with your workspace.")
-
-        # Temporarily using a custom _DefaultAzureCredential
-        # instead of Azure.Identity.DefaultAzureCredential
-        # See _DefaultAzureCredential documentation for more info.
-        if credential is None:
-            credential = _DefaultAzureCredential(exclude_interactive_browser_credential=False,
-                                                 exclude_shared_token_cache_credential=True,
-                                                 subscription_id=subscription_id,
-                                                 arm_base_url=ARM_BASE_URL)
-
-        self.credentials = credential
-        self.name = name
-        self.resource_group = resource_group
-        self.subscription_id = subscription_id
-        self.storage = storage
-        self._user_agent = user_agent
-
-        # Convert user-provided location into names
-        # recognized by Azure resource manager.
-        # For example, a customer-provided value of
-        # "West US" should be converted to "westus".
-        self.location = "".join(location.split()).lower()
+        connection_params.on_new_client_request = self.on_new_client_request
+
+        self._connection_params = connection_params
+        self._storage = storage
 
         # Create QuantumClient
         self._client = self._create_client()
 
-    def _create_client(self) -> QuantumClient:
-        endpoint = BASE_URL(self.location)
-        logger.debug(
-            f"Creating client for: subs:{self.subscription_id},"
-            + f"rg={self.resource_group}, ws={self.name}, frontdoor={endpoint}"
-        )
+    def on_new_client_request(self):
+        self._client = self._create_client()
+
+    @property
+    def location(self):
+        return self._connection_params.location
 
+    @property
+    def subscription_id(self):
+        return self._connection_params.subscription_id
+
+    @property
+    def resource_group(self):
+        return self._connection_params.resource_group
+
+    @property
+    def name(self):
+        return self._connection_params.workspace_name
+
+    @property
+    def credential(self):
+        return self._connection_params.credential
+
+    @property
+    def storage(self):
+        return self._storage
+
+    def _create_client(self) -> QuantumClient:
+        connection_params = self._connection_params
+        kwargs = {}
+        if connection_params.api_version:
+            kwargs["api_version"] = connection_params.api_version
         client = QuantumClient(
-            credential=self.credentials,
-            subscription_id=self.subscription_id,
-            resource_group_name=self.resource_group,
-            workspace_name=self.name,
-            endpoint=endpoint,
-            user_agent=self.user_agent
+            credential=connection_params.get_credential_or_default(),
+            subscription_id=connection_params.subscription_id,
+            resource_group_name=connection_params.resource_group,
+            workspace_name=connection_params.workspace_name,
+            azure_region=connection_params.location,
+            user_agent=connection_params.get_full_user_agent(),
+            credential_scopes = [ConnectionConstants.DATA_PLANE_CREDENTIAL_SCOPE],
+            endpoint=connection_params.quantum_endpoint,
+            authentication_policy=connection_params.get_auth_policy(),
+            **kwargs
         )
         return client
 
     @property
     def user_agent(self):
         """
-        Get the Workspace's UserAgent that is sent to the service via the header.
-        Uses the value specified during initialization and appends the environment
-        variable AZURE_QUANTUM_PYTHON_APPID if specified.
+        Get the Workspace's UserAgent that is sent to
+        the service via the header.
         """
-        full_user_agent = self._user_agent
-        env_app_id = os.environ.get(USER_AGENT_APPID_ENV_VAR_NAME)
-        if env_app_id:
-            full_user_agent = f"{full_user_agent}-{env_app_id}" if full_user_agent else env_app_id
-        return full_user_agent
+        return self._connection_params.get_full_user_agent()
 
-    def append_user_agent(self, value: Union[str, None]):
+    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.
 
         :param value: UserAgent value to add, e.g. "azure-quantum-<plugin>"
         """
-        new_user_agent = None
-
-        if value is not None and value not in (self._user_agent or ""):
-            new_user_agent = f"{self._user_agent}-{value}" if self._user_agent else value
+        self._connection_params.append_user_agent(value=value)
 
-        if new_user_agent != self._user_agent:
-            self._user_agent = new_user_agent
-            # We need to recreate the client for it to
-            # pick the new UserAgent
-            if self._client is not None:
-                self._client = self._create_client()
+    @classmethod
+    def from_connection_string(cls, connection_string: str, **kwargs) -> Workspace:
+        """
+        Creates a new Azure Quantum Workspace client from a connection string.
+        """
+        connection_params = WorkspaceConnectionParams(connection_string=connection_string)
+        return cls(
+            subscription_id=connection_params.subscription_id,
+            resource_group=connection_params.resource_group,
+            name=connection_params.workspace_name,
+            location=connection_params.location,
+            credential=connection_params.get_credential_or_default(),
+            **kwargs)
 
     def _get_top_level_items_client(self) -> TopLevelItemsOperations:
         return self._client.top_level_items
@@ -252,9 +227,6 @@ class Workspace:
     def _get_quotas_client(self) -> QuotasOperations:
         return self._client.quotas
 
-    def _custom_headers(self):
-        return {"x-ms-azurequantum-sdk-version": __version__}
-
     def _get_linked_storage_sas_uri(
         self, container_name: str, blob_name: str = None
     ) -> str:

{azure_quantum-1.1.1.dist-info → azure_quantum-1.1.2.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: azure-quantum
-Version: 1.1.1
+Version: 1.1.2.dev0
 Summary: Python client for Azure Quantum
 Home-page: https://github.com/microsoft/azure-quantum-python
 Author: Microsoft

{azure_quantum-1.1.1.dist-info → azure_quantum-1.1.2.dev0.dist-info}/RECORD

@@ -1,24 +1,26 @@
 azure/quantum/__init__.py,sha256=Za8xZY4lzFkW8m4ero-bqrfN437D2NRukM77ukb4GPM,508
+azure/quantum/_constants.py,sha256=6FCBpjUK2GHeycKejgGYTvxtlSsfWdbG2iOXGQg8NaM,3219
+azure/quantum/_workspace_connection_params.py,sha256=fGha3ALz1YRnKo07xHCbDzDcmUS7rsaakGvx_pvVINo,21632
 azure/quantum/storage.py,sha256=_4bMniDk9LrB_K5CQwuCivJFZXdmhRvU2b6Z3xxXw9I,12556
-azure/quantum/version.py,sha256=_ggGKCYTcHkMXXBdnBqCf8DkjOIdLBgQe0iSM5GGXhA,235
-azure/quantum/workspace.py,sha256=a-KjVbDbnPNBzsCzDmQOv90Dh6WGVuZn3UiuL7jNDPk,19757
+azure/quantum/version.py,sha256=-vAeAqsgIjIU8KmFftm1j4jiGOI7BOHvbIG4ovYqcv4,240
+azure/quantum/workspace.py,sha256=QXnIHOOYEGixajbZ8oeEWu-fAUI_Fms4zkA_amurm3g,17607
 azure/quantum/_authentication/__init__.py,sha256=bniNZlS0hMIjO_y7DevGBAS6MixyA5pbPHcdGipUWM4,236
-azure/quantum/_authentication/_chained.py,sha256=bs4w7auiCoRaNB0f86yAQU04Jgmd8VcKfy1wWmUxt6Q,5047
-azure/quantum/_authentication/_default.py,sha256=efU7o2yqsm7TJ88H6LEP2IZYL0Wj7cqcEmXv_rvELKo,10502
-azure/quantum/_authentication/_token.py,sha256=1rEmuu5XY3MApx_rCo7lnsi0qhch-y3goK5zXriXS7A,3570
+azure/quantum/_authentication/_chained.py,sha256=0rdohB_fVGFHUhlly9sGxqQTBTZGpGxtlBqNHDFbAqE,4848
+azure/quantum/_authentication/_default.py,sha256=RzhK5UNQb6TK95VQI4o8Gm2nxtOaz64yA0J9Tw9zpW4,6625
+azure/quantum/_authentication/_token.py,sha256=mOrvibDiOgkDnqU1OBIw9PyIv-np6DkdxMNC4UtuGkc,3616
 azure/quantum/_client/__init__.py,sha256=kzaVxPfnju-Y_EGMfOVYVB7pHjPvc-IWrkFI2eNk68s,896
-azure/quantum/_client/_client.py,sha256=Ze9RgPOC2ByOei_sZ-t-HrIjr9gk9TisJQigp_zkHgs,5854
-azure/quantum/_client/_configuration.py,sha256=bPbYqPE6tVIH1ApQ0X5GybMykYQs-hu2i5d05BRFx8E,4444
+azure/quantum/_client/_client.py,sha256=ZG-zalnITLyBk3BSMjLt4PtnNv8Nky5-kcmnIrk1IkQ,7143
+azure/quantum/_client/_configuration.py,sha256=5uktKtZxoVVAoSyeL0VNGS9AfPERp-9rU5Vn30dgY7o,4440
 azure/quantum/_client/_patch.py,sha256=YTV6yZ9bRfBBaw2z7v4MdzR-zeHkdtKkGb4SU8C25mE,694
-azure/quantum/_client/_serialization.py,sha256=CMxjYOWCILsk7kozMUGRsyeKUw-tkxI_k0EvYkqQZKU,80832
+azure/quantum/_client/_serialization.py,sha256=KJSS6KWgnKcz-cENQCmWZ9Ziv303lnBbLwFIpYZeKFU,81097
 azure/quantum/_client/_vendor.py,sha256=h8ByiyZ4cCQyFxqnuhTQdv1Rms3dVjKsrgZDzwMcSJ0,996
-azure/quantum/_client/_version.py,sha256=yBnfwkwYY2laMqv1FZa-C3phZufP-IQzzwdy5sE7BLY,495
+azure/quantum/_client/_version.py,sha256=1BvMPpsGTc8vSsVvDoi2TMiSVPtozGm87WOCYKmau7Q,500
 azure/quantum/_client/models/__init__.py,sha256=c1PRpzNsQTcDk4GkrFMMIlwNQQa2c0p5N0Lzd-23YBA,2100
 azure/quantum/_client/models/_enums.py,sha256=omj_B8_E8ONzTHg5hLgDlFYibRRbdr9sEN298im_otA,2977
-azure/quantum/_client/models/_models.py,sha256=LxIEord6GsqPbFqS4TWWqxVL9w7-TbsbVhsaUGwyP9M,41802
+azure/quantum/_client/models/_models.py,sha256=wktCM5oBVfwQetNoHobL1wNsC3knXV-HmqBq_Q77Kw4,41810
 azure/quantum/_client/models/_patch.py,sha256=YTV6yZ9bRfBBaw2z7v4MdzR-zeHkdtKkGb4SU8C25mE,694
 azure/quantum/_client/operations/__init__.py,sha256=1mIl1WjHa-yFdX45TZayC1JfYeEPj5v7E2i7vck69qM,1154
-azure/quantum/_client/operations/_operations.py,sha256=qEsFFyPozfw384AV8EkDQJKiKG2Q8NRb4GoDYqKRpqQ,75919
+azure/quantum/_client/operations/_operations.py,sha256=N_96-hfw6dYL3xfOI1mrYiXWAbWhNBNsV8EFpHtjW4U,81928
 azure/quantum/_client/operations/_patch.py,sha256=YTV6yZ9bRfBBaw2z7v4MdzR-zeHkdtKkGb4SU8C25mE,694
 azure/quantum/argument_types/__init__.py,sha256=S3-qpSHPz2d27xrgYbWvnv76OzULIONTp9mSGXu2ATM,271
 azure/quantum/argument_types/types.py,sha256=2mM8s37DKgNfSsjzwmg4dnmj9roSeHY1ZT5vKnpjAYM,1041
@@ -70,7 +72,7 @@ azure/quantum/target/pasqal/target.py,sha256=j9xK9chbmo-FL4Y9HBVqtL14Rr6lxQK6UN-
 azure/quantum/target/rigetti/__init__.py,sha256=I1vyzZBYGI540pauTqJd0RSSyTShGqkEL7Yjo25_RNY,378
 azure/quantum/target/rigetti/result.py,sha256=yDtT1y-JZFU7_mCaN1V_E6LPjJVD2vn4jvHOPT0IP9k,2278
 azure/quantum/target/rigetti/target.py,sha256=hGZm1wkBb1CBtDBWXEFS2Nje6gRXBTjOYgFkjOJ7TZ8,6458
-azure_quantum-1.1.1.dist-info/METADATA,sha256=xE8CjqqeGlNfvT77hOhtsmod66bCJpd3n8vK8ERQKUM,7304
-azure_quantum-1.1.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-azure_quantum-1.1.1.dist-info/top_level.txt,sha256=S7DhWV9m80TBzAhOFjxDUiNbKszzoThbnrSz5MpbHSQ,6
-azure_quantum-1.1.1.dist-info/RECORD,,
+azure_quantum-1.1.2.dev0.dist-info/METADATA,sha256=Zorh_0O9e8Wlm5o9DWOxLThwb2Evn68rVPmzrct02MU,7309
+azure_quantum-1.1.2.dev0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+azure_quantum-1.1.2.dev0.dist-info/top_level.txt,sha256=S7DhWV9m80TBzAhOFjxDUiNbKszzoThbnrSz5MpbHSQ,6
+azure_quantum-1.1.2.dev0.dist-info/RECORD,,