Zeep - Python SOAP Client

4.3.2 · active · verified Sat Mar 28

Zeep is a fast and modern Python SOAP client library, currently at version 4.3.2. It simplifies interactions with SOAP web services by inspecting WSDL documents and generating a Pythonic interface. The library is considered stable, focusing on bug fixes, with major releases occurring less frequently, typically when significant changes to Python support or underlying dependencies are required.

Warnings

breaking Zeep v4.3.0 dropped official support for Python 3.7 and 3.8. Version 4.2.0 dropped support for Python 3.6. Ensure your Python environment meets the `requires_python>=3.8` requirement.
Fix: Upgrade your Python environment to 3.9 or newer. The latest versions of Zeep (e.g., 4.3.2) support Python 3.9 through 3.13.
breaking Starting with Zeep v4.3.0, the project fully migrated to `pyproject.toml`, removing `setup.py`. This impacts build systems that might rely on the presence of `setup.py`.
Fix: Update your build and packaging tools to correctly handle projects using `pyproject.toml` and PEP 517/518 standards.
gotcha A regression in parsing `xsd:Date` with negative timezones was introduced and fixed in version 4.3.1. This issue could occur when using `isodate==0.7.2` with `zeep` versions prior to 4.3.1, leading to incorrect date interpretations or exceptions.
Fix: Upgrade to Zeep 4.3.1 or newer to correctly handle `xsd:Date` values, especially when dealing with negative timezone offsets.
gotcha When using `httpx` for asynchronous transport, passing `data` for POST requests might trigger `DeprecationWarning` in older `httpx` versions. Zeep v4.2.0 includes a fix for this.
Fix: Upgrade to Zeep 4.2.0 or newer to avoid `httpx` deprecation warnings related to `post data`. Ensure your `httpx` version is also up-to-date.
gotcha Disabling TLS/SSL verification (e.g., `session.verify = False` for synchronous `requests`-based transport, or similar for `httpx`) is generally discouraged in production environments due to security risks. Zeep will pass these settings to the underlying transport.
Fix: Always use proper certificate validation by providing a path to a CA bundle (`session.verify = 'path/to/ca_bundle.pem'`) or a client certificate, rather than disabling verification.
gotcha Zeep operates in a 'strict' mode by default, which rigorously checks WSDL and XML against standards. While robust, some non-compliant SOAP servers might require disabling strict mode (`zeep.Settings(strict=False)`), which could potentially lead to data-loss or unexpected behavior.
Fix: Only disable strict mode as a last resort for known non-compliant services, and thoroughly test the interaction to ensure data integrity.
breaking For `AsyncTransport` (used with `AsyncClient`), the `session` argument that previously accepted a `requests.Session` object is deprecated. It now expects an `httpx.AsyncClient` object to be passed via the `client` argument.
Fix: When initializing `AsyncTransport`, provide an `httpx.AsyncClient` instance to the `client` parameter, e.g., `AsyncTransport(client=httpx.AsyncClient())`.

Install

pip install zeep Install stable version

Imports

Client
```
from zeep import Client
```
AsyncClient
```
from zeep import AsyncClient
```
Settings
```
from zeep import Settings
```
Transport
```
from zeep.transports import Transport
```

AsyncTransport

from zeep.transports import AsyncTransport

Quickstart

Initializes a Zeep client with a WSDL URL and makes a synchronous call to a public SOAP service. This example demonstrates basic client instantiation and calling a service operation. Replace the WSDL_URL with your target service's WSDL. For asynchronous operations, use `AsyncClient` and `AsyncTransport`.

import os
from zeep import Client

# A public WSDL for demonstration purposes
wsdl_url = os.environ.get('ZEEP_WSDL_URL', 'http://www.webservicex.net/ConvertSpeed.asmx?WSDL')

try:
    client = Client(wsdl_url)
    # Inspect available services and operations
    print(f"Service operations: {list(client.service._operations.keys())}")

    # Call a service operation
    result = client.service.ConvertSpeed(100, 'kilometersPerhour', 'milesPerhour')
    print(f"100 km/h in mph: {result}")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Please ensure the WSDL URL is accessible and valid.")
    print("You can try setting the ZEEP_WSDL_URL environment variable.")

view raw JSON →