Description

# Azure Core shared client library for Python Azure core provides shared exceptions and modules for Python SDK client libraries. These libraries follow the [Azure SDK Design Guidelines for Python](https://azure.github.io/azure-sdk/python/guidelines/index.html) . If you are a client library developer, please reference [client library developer reference](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md) for more information. [Source code](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/) | [Package (Pypi)][package] | [Package (Conda)](https://anaconda.org/microsoft/azure-core/) | [API reference documentation](https://learn.microsoft.com/python/api/overview/azure/core-readme) ## Getting started Typically, you will not need to install azure core; it will be installed when you install one of the client libraries using it. In case you want to install it explicitly (to implement your own client library, for example), you can find it [here](https://pypi.org/project/azure-core/). ## Key concepts ### Azure Core Library Exceptions #### AzureError AzureError is the base exception for all errors. ```python class AzureError(Exception): def __init__(self, message, *args, **kwargs): self.inner_exception = kwargs.get("error") self.exc_type, self.exc_value, self.exc_traceback = sys.exc_info() self.exc_type = self.exc_type.__name__ if self.exc_type else type(self.inner_exception) self.exc_msg = "{}, {}: {}".format(message, self.exc_type, self.exc_value) # type: ignore self.message = str(message) self.continuation_token = kwargs.get("continuation_token") super(AzureError, self).__init__(self.message, *args) ``` *message* is any message (str) to be associated with the exception. *args* are any additional args to be included with exception. *kwargs* are keyword arguments to include with the exception. Use the keyword *error* to pass in an internal exception and *continuation_token* for a token reference to continue an incomplete operation. **The following exceptions inherit from AzureError:** #### ServiceRequestError An error occurred while attempt to make a request to the service. No request was sent. #### ServiceResponseError The request was sent, but the client failed to understand the response. The connection may have timed out. These errors can be retried for idempotent or safe operations. #### HttpResponseError A request was made, and a non-success status code was received from the service. ```python class HttpResponseError(AzureError): def __init__(self, message=None, response=None, **kwargs): self.reason = None self.response = response if response: self.reason = response.reason self.status_code = response.status_code self.error = self._parse_odata_body(ODataV4Format, response) # type: Optional[ODataV4Format] if self.error: message = str(self.error) else: message = message or "Operation returned an invalid status '{}'".format( self.reason ) super(HttpResponseError, self).__init__(message=message, **kwargs) ``` *message* is the HTTP response error message (optional) *response* is the HTTP response (optional). *kwargs* are keyword arguments to include with the exception. **The following exceptions inherit from HttpResponseError:** #### DecodeError An error raised during response de-serialization. #### IncompleteReadError An error raised if peer closes the connection before we have received the complete message body. #### ResourceExistsError An error response with status code 4xx. This will not be raised directly by the Azure core pipeline. #### ResourceNotFoundError An error response, typically triggered by a 412 response (for update) or 404 (for get/post). #### ResourceModifiedError An error response with status code 4xx, typically 412 Conflict. This will not be raised directly by the Azure core pipeline. #### ResourceNotModifiedError An error response with status code 304. This will not be raised directly by the Azure core pipeline. #### ClientAuthenticationError An error response with status code 4xx. This will not be raised directly by the Azure core pipeline. #### TooManyRedirectsError An error raised when the maximum number of redirect attempts is reached. The maximum amount of redirects can be configured in the RedirectPolicy. ```python class TooManyRedirectsError(HttpResponseError): def __init__(self, history, *args, **kwargs): self.history = history message = "Reached maximum redirect attempts." super(TooManyRedirectsError, self).__init__(message, *args, **kwargs) ``` *history* is used to document the requests/responses that resulted in redirected requests. *args* are any additional args to be included with exception. *kwargs* are keyword arguments to include with