Core HTTP shared client library for Python

corehttp provides shared exceptions and modules for Python SDK client libraries.

Getting started

Typically, you will not need to install corehttp, as it will be installed when you install one of the client libraries using it.

Transports

To use corehttp, you will need to choose a transport implementation. corehttp provides the following transports:

Synchronous transports:

• RequestsTransport - A synchronous transport based on the Requests library.
• HttpXTransport - An synchronous transport based on the HTTPX library.

Asynchronous transports:

• AioHttpTransport - An asynchronous transport based on the aiohttp library.
• AsyncHttpXTransport - An asynchronous transport based on the HTTPX library.

Each transport has its own dependencies, which you can install using the corehttp extras:

# Install individually.
pip install corehttp[requests]
pip install corehttp[aiohttp]
pip install corehttp[httpx]

# Install multiple.
pip install corehttp[requests,httpx]

If no transports are specified, corehttp will default to using RequestsTransport for synchronous pipeline requests and AioHttpTransport for asynchronous pipeline requests.

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.0.0b4 (2024-02-23)

Other Changes

• Relax type checking in Pipeline constructors to only check that each user-supplied policy object has either a send method or both an on_request and on_response method. This allows for more flexible policy implementations. #34296

1.0.0b3 (2024-02-01)

Features Added

• Support tuple input for files values to corehttp.rest.HttpRequest #34082
• Support simultaneous files and data field entry into corehttp.rest.HttpRequest #34082

1.0.0b2 (2023-11-14)

Features Added

• Added the initial implementation of the HTTPX transport. #32813

Breaking Changes

• Removed requests as a default dependency of corehttp. This is now an "extras" dependency and can be installed via corehttp[requests]. #32813
• Renamed the aio extra to aiohttp. #32813

Bugs Fixed

• Fixed an issue with multipart/form-data in the async transport where data was not getting encoded into the request body. #32473
• Fixed an issue with connection_verify, connection_cert, and connection_timeout not being propagated to underlying transports. #33057
• Fixed an issue with the aiohttp transport not using SSL by default. #33057

Other Changes

• Added extras for httpx. #32813

1.0.0b1 (2023-10-18)

• Initial Release