Skip to main content

Transport classes and utilities shared among Python Elastic client libraries

Project description


PyPI Python Versions PyPI Downloads CI Status

Transport classes and utilities shared among Python Elastic client libraries

This library was lifted from elasticsearch-py and then transformed to be used across all Elastic services rather than only Elasticsearch.

Installing from PyPI

$ python -m pip install elastic-transport

Versioning follows the major and minor version of the Elastic Stack version and the patch number is incremented for bug fixes within a minor release.

elastic-transport-python supports Python 2.7 and Python 3.6+

User Guide

For almost all use-cases you should not need this library. The below use-cases are the common ones:

Creating your own Connection Class

If you need to have custom behavior for a Connection you can subclass the base connection class you want and then pass the class in via connection_class:

from elastic_transport import Urllib3HttpConnection
from elastic_enterprise_search import EnterpriseSearch

class CustomHttpConnection(Urllib3HttpConnection):
    ... # Custom HTTP behavior

# Create the Client with 'connection_class' defined
client = EnterpriseSearch(

The above also works for ConnectionPool (via connection_pool_class) and Transport (via transport_class).

Connection Classes

elastic-transport-python supports two HTTP client libraries:


This is the default connection class. This connection class uses urllib3` to issue requests. Read more about urllib3 on Read the Docs.


This connection class requires the Requests library to be installed to use:

$ python -m pip install requests

This class is often useful when using libraries that integrate with Requests. Read more about Requests on Read the Docs.

Supported Connection Options

The two connection classes support a variety of options, some connection classes only support a subset of the total options:

Option Description Default Supported by urllib3 Supported by requests
host TCP host to connect localhost
port TCP port to connect
use_ssl Should connect via TLS/SSL? False
url_prefix Path prefix for all requests ""
request_timeout Default request timeout 10.0
headers HTTP headers to add to every request {}
user_agent Default User-Agent HTTP header None
connections_per_host Number of HTTP connections per host 10
verify_certs Whether to verify server certificate True
ca_certs CA certificates to use with TLS/SSL certifi
client_cert Client certificate to present during TLS/SSL handshake None
client_key Client certificate key that goes with client_cert None
ssl_version Version of TLS/SSL to use None
ssl_assert_hostname Host to verify on the server TLS certificate. Set to False to disable certificate hostname verification None
ssl_assert_fingerprint Checksum to verify against the server TLS certificate None
ssl_context Preconfigured SSLContext instance None


elastic-transport-python is available under the Apache-2.0 license. For more details see LICENSE.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elastic-transport-7.12.0.tar.gz (27.0 kB view hashes)

Uploaded Source

Built Distribution

elastic_transport-7.12.0-py2.py3-none-any.whl (35.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page