Microsoft Azure Core Library for Python
Project 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 .
If you are a client library developer, please reference client library developer reference for more information.
Source code | Package (Pypi) | Package (Conda) | API reference documentation
Disclaimer
Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691
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.
Key concepts
Azure Core Library Exceptions
AzureError
AzureError is the base exception for all errors.
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.
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.
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 the exception.
StreamConsumedError
An error thrown if you try to access the stream of azure.core.rest.HttpResponse
or azure.core.rest.AsyncHttpResponse
once
the response stream has been consumed.
StreamClosedError
An error thrown if you try to access the stream of the azure.core.rest.HttpResponse
or azure.core.rest.AsyncHttpResponse
once
the response stream has been closed.
ResponseNotReadError
An error thrown if you try to access the content
of azure.core.rest.HttpResponse
or azure.core.rest.AsyncHttpResponse
before
reading in the response's bytes first.
Configurations
When calling the methods, some properties can be configured by passing in as kwargs arguments.
Parameters | Description |
---|---|
headers | The HTTP Request headers. |
request_id | The request id to be added into header. |
user_agent | If specified, this will be added in front of the user agent string. |
logging_enable | Use to enable per operation. Defaults to False . |
logger | If specified, it will be used to log information. |
response_encoding | The encoding to use if known for this service (will disable auto-detection). |
proxies | Maps protocol or protocol and hostname to the URL of the proxy. |
raw_request_hook | Callback function. Will be invoked on request. |
raw_response_hook | Callback function. Will be invoked on response. |
network_span_namer | A callable to customize the span name. |
tracing_attributes | Attributes to set on all created spans. |
permit_redirects | Whether the client allows redirects. Defaults to True . |
redirect_max | The maximum allowed redirects. Defaults to 30 . |
retry_total | Total number of retries to allow. Takes precedence over other counts. Default value is 10 . |
retry_connect | How many connection-related errors to retry on. These are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request. Default value is 3 . |
retry_read | How many times to retry on read errors. These errors are raised after the request was sent to the server, so the request may have side-effects. Default value is 3 . |
retry_status | How many times to retry on bad status codes. Default value is 3 . |
retry_backoff_factor | A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a second try without a delay). Retry policy will sleep for: {backoff factor} * (2 ** ({number of total retries} - 1)) seconds. If the backoff_factor is 0.1, then the retry will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. The default value is 0.8 . |
retry_backoff_max | The maximum back off time. Default value is 120 seconds (2 minutes). |
retry_mode | Fixed or exponential delay between attempts, default is Exponential . |
timeout | Timeout setting for the operation in seconds, default is 604800 s (7 days). |
connection_timeout | A single float in seconds for the connection timeout. Defaults to 300 seconds. |
read_timeout | A single float in seconds for the read timeout. Defaults to 300 seconds. |
connection_verify | SSL certificate verification. Enabled by default. Set to False to disable, alternatively can be set to the path to a CA_BUNDLE file or directory with certificates of trusted CAs. |
connection_cert | Client-side certificates. You can specify a local cert to use as client side certificate, as a single file (containing the private key and the certificate) or as a tuple of both files' paths. |
proxies | Dictionary mapping protocol or protocol and hostname to the URL of the proxy. |
cookies | Dict or CookieJar object to send with the Request . |
connection_data_block_size | The block size of data sent over the connection. Defaults to 4096 bytes. |
Async transport
The async transport is designed to be opt-in. AioHttp is one of the supported implementations of async transport. It is not installed by default. You need to install it separately.
Shared modules
MatchConditions
MatchConditions is an enum to describe match conditions.
class MatchConditions(Enum):
Unconditionally = 1 # Matches any condition
IfNotModified = 2 # If the target object is not modified. Usually it maps to etag=<specific etag>
IfModified = 3 # Only if the target object is modified. Usually it maps to etag!=<specific etag>
IfPresent = 4 # If the target object exists. Usually it maps to etag='*'
IfMissing = 5 # If the target object does not exist. Usually it maps to etag!='*'
CaseInsensitiveEnumMeta
A metaclass to support case-insensitive enums.
from enum import Enum
from azure.core import CaseInsensitiveEnumMeta
class MyCustomEnum(str, Enum, metaclass=CaseInsensitiveEnumMeta):
FOO = 'foo'
BAR = 'bar'
Null Sentinel Value
A falsy sentinel object which is supposed to be used to specify attributes
with no data. This gets serialized to null
on the wire.
from azure.core.serialization import NULL
assert bool(NULL) is False
foo = Foo(
attr=NULL
)
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Release History
1.29.3 (2023-08-22)
Bugs Fixed
- Typing fix:
message
cannot beNone
inAzureError
. #31564
1.29.2 (2023-08-14)
Bugs Fixed
- Added a default implementation for
AsyncTokenCredential.__aexit__()
#31573
Other Changes
- Bumped
typing-extensions
version to 4.6.0.
1.29.1 (2023-08-09)
Bugs Fixed
- Not pass
enabled_cae
unless it is explicitly enabled.
1.29.0 (2023-08-03)
Features Added
- A keyword argument
enable_cae
was added to theget_token
method of theTokenCredential
protocol. #31012 BearerTokenCredentialPolicy
andAsyncBearerTokenCredentialPolicy
now acceptenable_cae
keyword arguments in their constructors. This is used in determining if Continuous Access Evaluation (CAE) should be enabled for eachget_token
request. #31012
1.28.0 (2023-07-06)
Features Added
- Added header name parameter to
RequestIdPolicy
. #30772 - Added
SensitiveHeaderCleanupPolicy
that cleans up sensitive headers if a redirect happens and the new destination is in another domain. #28349
Other Changes
- Catch aiohttp errors and translate them into azure-core errors.
1.27.1 (2023-06-13)
Bugs Fixed
- Fix url building for some complex query parameters scenarios #30707
1.27.0 (2023-06-01)
Features Added
- Added support to use sync credentials in
AsyncBearerTokenCredentialPolicy
. #30381 - Added "prefix" parameter to AzureKeyCredentialPolicy #29901
Bugs Fixed
- Improve error message when providing the wrong credential type for AzureKeyCredential #30380
1.26.4 (2023-04-06)
Features Added
- Updated settings to include OpenTelemetry as a tracer provider. #29095
Other Changes
- Improved typing
1.26.3 (2023-02-02)
Bugs Fixed
- Fixed deflate decompression for aiohttp #28483
1.26.2 (2023-01-05)
Bugs Fixed
- Fix 'ClientSession' object has no attribute 'auto_decompress' (thanks to @mghextreme for the contribution)
Other Changes
- Add "x-ms-error-code" as secure header to log
- Rename "DEFAULT_HEADERS_WHITELIST" to "DEFAULT_HEADERS_ALLOWLIST". Added a backward compatible alias.
1.26.1 (2022-11-03)
Other Changes
- Added example of RequestsTransport with custom session. (thanks to @inirudebwoy for the contribution) #26768
- Added Python 3.11 support.
1.26.0 (2022-10-06)
Other Changes
- LRO polling will not wait anymore before doing the first status check #26376
- Added extra dependency for [aio]. pip install azure-core[aio] installs aiohttp too.
1.25.1 (2022-09-01)
Bugs Fixed
- Added @runtime_checkable to
TokenCredential
protocol definitions #25187
1.25.0 (2022-08-04)
Azure-core is supported on Python 3.7 or later. For more details, please read our page on Azure SDK for Python version support policy.
Features Added
- Added
CaseInsensitiveDict
implementation inazure.core.utils
removing dependency onrequests
andaiohttp
1.24.2 (2022-06-30)
Bugs Fixed
- Fixed the bug that azure-core could not be imported under Python 3.11.0b3 #24928
ContentDecodePolicy
can now correctly deserialize more JSON bodies with different mime types #22410
1.24.1 (2022-06-01)
Bugs Fixed
- Declare method level span as INTERNAL by default #24492
- Fixed type hints for
azure.core.paging.ItemPaged
#24548
1.24.0 (2022-05-06)
Features Added
- Add
SerializationError
andDeserializationError
inazure.core.exceptions
for errors raised during serialization / deserialization #24312
1.23.1 (2022-03-31)
Bugs Fixed
- Allow stream inputs to the
content
kwarg ofazure.core.rest.HttpRequest
from objects with aread
method #23578
1.23.0 (2022-03-03)
Features Added
-
Improve intellisense type hinting for service client methods. #22891
-
Add a case insensitive dict
case_insensitive_dict
inazure.core.utils
. #23206
Bugs Fixed
- Use "\n" rather than "/n" for new line in log. #23261
Other Changes
- Log "WWW-Authenticate" header in
HttpLoggingPolicy
#22990 - Added dependency on
typing-extensions
>= 4.0.1
1.22.1 (2022-02-09)
Bugs Fixed
- Limiting
final-state-via
scope to POST until consuming SDKs has been fixed to use this option properly on PUT. #22989
1.22.0 (2022-02-03)
[This version is deprecated.]
Features Added
- Add support for
final-state-via
LRO option in core. #22713
Bugs Fixed
- Add response body to string representation of
HttpResponseError
if we're not able to parse out information #22302 - Raise
AttributeError
when calling azure.core.pipeline.transport.__bases__ #22469
Other Changes
- Python 2.7 is no longer supported. Please use Python version 3.6 or later.
1.21.1 (2021-12-06)
Other Changes
- Revert change in str method #22023
1.21.0 (2021-12-02)
Breaking Changes
- Sync stream downloading now raises
azure.core.exceptions.DecodeError
rather thanrequests.exceptions.ContentDecodingError
Bugs Fixed
- Add response body to string representation of
HttpResponseError
if we're not able to parse out information #21800
1.20.1 (2021-11-08)
Bugs Fixed
- Correctly set response's content to decompressed body when users are using aiohttp transport with decompression headers #21620
1.20.0 (2021-11-04)
Features Added
- GA
send_request
onto theazure.core.PipelineClient
andazure.core.AsyncPipelineClient
. This method takes in requests and sends them through our pipelines. - GA
azure.core.rest
.azure.core.rest
is our new public simple HTTP library inazure.core
that users will use to create requests, and consume responses. - GA errors
StreamConsumedError
,StreamClosedError
, andResponseNotReadError
toazure.core.exceptions
. These errors are thrown if you mishandle streamed responses from theazure.core.rest
module - add kwargs to the methods for
iter_raw
anditer_bytes
#21529 - no longer raise JSON errors if users pass in file descriptors of JSON to the
json
kwarg inHttpRequest
#21504 - Added new error type
IncompleteReadError
which is raised if peer closes the connection before we have received the complete message body.
Breaking Changes
- SansIOHTTPPolicy.on_exception returns None instead of bool.
Bugs Fixed
- The
Content-Length
header in a http response is strictly checked against the actual number of bytes in the body, rather than silently truncating data in case the underlying tcp connection is closed prematurely. (thanks to @jochen-ott-by for the contribution) #20412 - UnboundLocalError when SansIOHTTPPolicy handles an exception #15222
- Add default content type header of
text/plain
and content length header for users who pass unicode strings to thecontent
kwarg ofHttpRequest
in 2.7 #21550
1.19.1 (2021-11-01)
Bugs Fixed
- respect text encoding specified in argument (thanks to @ryohji for the contribution) #20796
- Fix "coroutine x.read() was never awaited" warning from
ContentDecodePolicy
#21318 - fix type check for
data
input toazure.core.rest
for python 2.7 users #21341 - use
charset_normalizer
ifchardet
is not installed to migrate aiohttp 3.8.0 changes.
Other Changes
- Refactor AzureJSONEncoder (thanks to @Codejune for the contribution) #21028
1.19.0 (2021-09-30)
Breaking Changes in the Provisional azure.core.rest
package
-
azure.core.rest.HttpResponse
andazure.core.rest.AsyncHttpResponse
are now abstract base classes. They should not be initialized directly, instead your transport responses should inherit from them and implement them. -
The properties of the
azure.core.rest
responses are now all read-only -
HttpLoggingPolicy integrates logs into one record #19925
1.18.0 (2021-09-02)
Features Added
azure.core.serialization.AzureJSONEncoder
(introduced in 1.17.0) serializesdatetime.datetime
objects in ISO 8601 format, conforming to RFC 3339's specification. #20190- We now use
azure.core.serialization.AzureJSONEncoder
to serializejson
input toazure.core.rest.HttpRequest
.
Breaking Changes in the Provisional azure.core.rest
package
- The
text
property onazure.core.rest.HttpResponse
andazure.core.rest.AsyncHttpResponse
has changed to a method, which also takes anencoding
parameter. - Removed
iter_text
anditer_lines
fromazure.core.rest.HttpResponse
andazure.core.rest.AsyncHttpResponse
Bugs Fixed
- The behaviour of the headers returned in
azure.core.rest
responses now aligns across sync and async. Items can now be checked case-insensitively and without raising an error for format.
1.17.0 (2021-08-05)
Features Added
- Cut hard dependency on requests library
- Added a
from_json
method which now accepts storage QueueMessage, eventhub's EventData or ServiceBusMessage or simply json bytes to return aCloudEvent
Fixed
- Not override "x-ms-client-request-id" if it already exists in the header. #17757
Breaking Changes in the Provisional azure.core.rest
package
azure.core.rest
will not try to guess thecharset
anymore if it was impossible to extract it fromHttpResponse
analysis. This removes our dependency oncharset
.
1.16.0 (2021-07-01)
Features Added
- Add new provisional methods
send_request
onto theazure.core.PipelineClient
andazure.core.AsyncPipelineClient
. This method takes in requests and sends them through our pipelines. - Add new provisional module
azure.core.rest
.azure.core.rest
is our new public simple HTTP library inazure.core
that users will use to create requests, and consume responses. - Add new provisional errors
StreamConsumedError
,StreamClosedError
, andResponseNotReadError
toazure.core.exceptions
. These errors are thrown if you mishandle streamed responses from the provisionalazure.core.rest
module
Fixed
- Improved error message in the
from_dict
method ofCloudEvent
when a wrong schema is sent.
1.15.0 (2021-06-04)
New Features
- Added
BearerTokenCredentialPolicy.on_challenge
and.authorize_request
to allow subclasses to optionally handle authentication challenges
Bug Fixes
- Retry policies don't sleep after operations time out
- The
from_dict
methhod in theCloudEvent
can now convert a datetime string to datetime object when microsecond exceeds the python limitation
1.14.0 (2021-05-13)
New Features
- Added
azure.core.credentials.AzureNamedKeyCredential
credential #17548. - Added
decompress
parameter forstream_download
method. If it is set toFalse
, will not do decompression upon the stream. #17920
1.13.0 (2021-04-02)
Azure core requires Python 2.7 or Python 3.6+ since this release.
New Features
- Added
azure.core.utils.parse_connection_string
function to parse connection strings across SDKs, with common validation and support for case insensitive keys. - Supported adding custom policies #16519
- Added
~azure.core.tracing.Link
that should be used while passingLinks
toAbstractSpan
. AbstractSpan
constructor can now take in additional keyword only args.
Bug fixes
- Make NetworkTraceLoggingPolicy show the auth token in plain text. #14191
- Fixed RetryPolicy overriding default connection timeout with an extreme value #17481
1.12.0 (2021-03-08)
This version will be the last version to officially support Python 3.5, future versions will require Python 2.7 or Python 3.6+.
Features
- Added
azure.core.messaging.CloudEvent
model that follows the cloud event spec. - Added
azure.core.serialization.NULL
sentinel value - Improve
repr
s forHttpRequest
andHttpResponse
s #16972
Bug Fixes
- Disable retry in stream downloading. (thanks to @jochen-ott-by @hoffmann for the contribution) #16723
1.11.0 (2021-02-08)
Features
- Added
CaseInsensitiveEnumMeta
class for case-insensitive enums. #16316 - Add
raise_for_status
method ontoHttpResponse
. Callingresponse.raise_for_status()
on a response with an error code will raise anHttpResponseError
. Calling it on a good response will do nothing #16399
Bug Fixes
- Update conn.conn_kw rather than overriding it when setting block size. (thanks for @jiasli for the contribution) #16587
1.10.0 (2021-01-11)
Features
- Added
AzureSasCredential
and its respective policy. #15946
1.9.0 (2020-11-09)
Features
- Add a
continuation_token
attribute to the baseAzureError
exception, and set this value for errors raised during paged or long-running operations.
Bug Fixes
- Set retry_interval to 1 second instead of 1000 seconds (thanks vbarbaresi for contributing) #14357
1.8.2 (2020-10-05)
Bug Fixes
- Fixed bug to allow polling in the case of parameterized endpoints with relative polling urls #14097
1.8.1 (2020-09-08)
Bug fixes
- SAS credential replicated "/" fix #13159
1.8.0 (2020-08-10)
Features
- Support params as list for exploding parameters #12410
1.7.0 (2020-07-06)
Bug fixes
AzureKeyCredentialPolicy
will now accept (and ignore) passed in kwargs #11963- Better error messages if passed endpoint is incorrect #12106
- Do not JSON encore a string if content type is "text" #12137
Features
- Added
http_logging_policy
property on theConfiguration
object, allowing users to individually set the http logging policy of the config #12218
1.6.0 (2020-06-03)
Bug fixes
- Fixed deadlocks in AsyncBearerTokenCredentialPolicy #11543
- Fix AttributeException in StreamDownloadGenerator #11462
Features
- Added support for changesets as part of multipart message support #10485
- Add AsyncLROPoller in azure.core.polling #10801
- Add get_continuation_token/from_continuation_token/polling_method methods in pollers (sync and async) #10801
- HttpResponse and PipelineContext objects are now pickable #10801
1.5.0 (2020-05-04)
Features
- Support "x-ms-retry-after-ms" in response header #10743
link
andlink_from_headers
now accepts attributes #10765
Bug fixes
- Not retry if the status code is less than 400 #10778
- "x-ms-request-id" is not considered safe header for logging #10967
1.4.0 (2020-04-06)
Features
- Support a default error type in map_error #9773
- Added
AzureKeyCredential
and its respective policy. #10509 - Added
azure.core.polling.base_polling
module with a "Microsoft One API" polling implementation #10090 Also contains the async version inazure.core.polling.async_base_polling
- Support kwarg
enforce_https
to disable HTTPS check on authentication #9821 - Support additional kwargs in
HttpRequest.set_multipart_mixed
that will be passed into pipeline context.
1.3.0 (2020-03-09)
Bug fixes
- Appended RequestIdPolicy to the default pipeline #9841
- Rewind the body position in async_retry #10117
Features
- Add raw_request_hook support in custom_hook_policy #9958
- Add timeout support in retry_policy #10011
- Add OdataV4 error format auto-parsing in all exceptions ('error' attribute) #9738
1.2.2 (2020-02-10)
Bug fixes
- Fixed a bug that sends None as request_id #9545
- Enable mypy for customers #9572
- Handle TypeError in deep copy #9620
- Fix text/plain content-type in decoder #9589
1.2.1 (2020-01-14)
Bug fixes
- Fixed a regression in 1.2.0 that was incompatible with azure-keyvault-* 4.0.0 #9462
1.2.0 (2020-01-14)
Features
- Add user_agent & sdk_moniker kwargs in UserAgentPolicy init #9355
- Support OPTIONS HTTP verb #9322
- Add tracing_attributes to tracing decorator #9297
- Support auto_request_id in RequestIdPolicy #9163
- Support fixed retry #6419
- Support "retry-after-ms" in response header #9240
Bug fixes
- Removed
__enter__
and__exit__
from async context managers #9313
1.1.1 (2019-12-03)
Bug fixes
- Bearer token authorization requires HTTPS
- Rewind the body position in retry #8307
1.1.0 (2019-11-25)
Features
- New RequestIdPolicy #8437
- Enable logging policy in default pipeline #8053
- Normalize transport timeout. #8000
Now we have:
- 'connection_timeout' - a single float in seconds for the connection timeout. Default 5min
- 'read_timeout' - a single float in seconds for the read timeout. Default 5min
Bug fixes
- RequestHistory: deepcopy fails if request contains a stream #7732
- Retry: retry raises error if response does not have http_response #8629
- Client kwargs are now passed to DistributedTracingPolicy correctly #8051
- NetworkLoggingPolicy now logs correctly all requests in case of retry #8262
1.0.0 (2019-10-29)
Features
- Tracing: DistributedTracingPolicy now accepts kwargs network_span_namer to change network span name #7773
- Tracing: Implementation of AbstractSpan can now use the mixin HttpSpanMixin to get HTTP span update automatically #7773
- Tracing: AbstractSpan contract "change_context" introduced #7773
- Introduce new policy HttpLoggingPolicy #7988
Bug fixes
- Fix AsyncioRequestsTransport if input stream is an async generator #7743
- Fix form-data with aiohttp transport #7749
Breaking changes
- Tracing: AbstractSpan.set_current_span is longer supported. Use change_context instead. #7773
- azure.core.pipeline.policies.ContentDecodePolicy.deserialize_from_text changed
1.0.0b4 (2019-10-07)
Features
-
Tracing: network span context is available with the TRACING_CONTEXT in pipeline response #7252
-
Tracing: Span contract now has
kind
,traceparent
and is a context manager #7252 -
SansIOHTTPPolicy methods can now be coroutines #7497
-
Add multipart/mixed support #7083:
- HttpRequest now has a "set_multipart_mixed" method to set the parts of this request
- HttpRequest now has a "prepare_multipart_body" method to build final body.
- HttpResponse now has a "parts" method to return an iterator of parts
- AsyncHttpResponse now has a "parts" methods to return an async iterator of parts
- Note that multipart/mixed is a Python 3.x only feature
Bug fixes
- Tracing: policy cannot fail the pipeline, even in the worst condition #7252
- Tracing: policy pass correctly status message if exception #7252
- Tracing: incorrect span if exception raised from decorated function #7133
- Fixed urllib3 ConnectTimeoutError being raised by Requests during a socket timeout. Now this exception is caught and wrapped as a
ServiceRequestError
#7542
Breaking changes
-
Tracing:
azure.core.tracing.context
removed -
Tracing:
azure.core.tracing.context.tracing_context.with_current_context
renamed toazure.core.tracing.common.with_current_context
#7252 -
Tracing:
link
renamedlink_from_headers
andlink
takes now a string -
Tracing: opencensus implementation has been moved to the package
azure-core-tracing-opencensus
-
Some modules and classes that were importables from several different places have been removed:
azure.core.HttpResponseError
is now onlyazure.core.exceptions.HttpResponseError
azure.core.Configuration
is now onlyazure.core.configuration.Configuration
azure.core.HttpRequest
is now onlyazure.core.pipeline.transport.HttpRequest
azure.core.version
module has been removed. Useazure.core.__version__
to get version number.azure.core.pipeline_client
has been removed. Import fromazure.core
instead.azure.core.pipeline_client_async
has been removed. Import fromazure.core
instead.azure.core.pipeline.base
has been removed. Import fromazure.core.pipeline
instead.azure.core.pipeline.base_async
has been removed. Import fromazure.core.pipeline
instead.azure.core.pipeline.policies.base
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.base_async
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.authentication
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.authentication_async
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.custom_hook
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.redirect
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.redirect_async
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.retry
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.retry_async
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.distributed_tracing
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.pipeline.policies.universal
has been removed. Import fromazure.core.pipeline.policies
instead.azure.core.tracing.abstract_span
has been removed. Import fromazure.core.tracing
instead.azure.core.pipeline.transport.base
has been removed. Import fromazure.core.pipeline.transport
instead.azure.core.pipeline.transport.base_async
has been removed. Import fromazure.core.pipeline.transport
instead.azure.core.pipeline.transport.requests_basic
has been removed. Import fromazure.core.pipeline.transport
instead.azure.core.pipeline.transport.requests_asyncio
has been removed. Import fromazure.core.pipeline.transport
instead.azure.core.pipeline.transport.requests_trio
has been removed. Import fromazure.core.pipeline.transport
instead.azure.core.pipeline.transport.aiohttp
has been removed. Import fromazure.core.pipeline.transport
instead.azure.core.polling.poller
has been removed. Import fromazure.core.polling
instead.azure.core.polling.async_poller
has been removed. Import fromazure.core.polling
instead.
1.0.0b3 (2019-09-09)
Bug fixes
- Fix aiohttp auto-headers #6992
- Add tracing to policies module init #6951
1.0.0b2 (2019-08-05)
Breaking changes
- Transport classes don't take
config
parameter anymore (use kwargs instead) #6372 azure.core.paging
has been completely refactored #6420- HttpResponse.content_type attribute is now a string (was a list) #6490
- For
StreamDownloadGenerator
subclasses,response
is now anHttpResponse
, and not a transport response likeaiohttp.ClientResponse
orrequests.Response
. The transport response is available ininternal_response
attribute #6490
Bug fixes
- aiohttp is not required to import async pipelines classes #6496
AsyncioRequestsTransport.sleep
is now a coroutine as expected #6490RequestsTransport
is not tight toProxyPolicy
implementation details anymore #6372AiohttpTransport
does not raise on unexpected kwargs #6355
Features
- New paging base classes that support
continuation_token
andby_page()
#6420 - Proxy support for
AiohttpTransport
#6372
1.0.0b1 (2019-06-26)
- Preview 1 release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file azure-core-1.29.3.tar.gz
.
File metadata
- Download URL: azure-core-1.29.3.tar.gz
- Upload date:
- Size: 258.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: RestSharp/106.13.0.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c92700af982e71c8c73de9f4c20da8b3f03ce2c22d13066e4d416b4629c87903 |
|
MD5 | cff99256aa293d8417f0ddae8adb60e9 |
|
BLAKE2b-256 | 63c58023aaea4f8b8a512e883a4f8933fb6e5241b0e6db6f0f992bf9d89759ae |
File details
Details for the file azure_core-1.29.3-py3-none-any.whl
.
File metadata
- Download URL: azure_core-1.29.3-py3-none-any.whl
- Upload date:
- Size: 191.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: RestSharp/106.13.0.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8b2910f92b66293d93bd00564924ad20ad48f4a1e150577cf18d1e7d4f9263c |
|
MD5 | fd9e7a6d052bc2f9d8d5f07579781070 |
|
BLAKE2b-256 | 0e202f7a562c6a600b32c64ebe00cc9e4c3099bc42d52aadcafd3a2a8fa0d68a |