suds (community fork)

Warnings

• breaking The `suds` project (version 1.x) is a community fork that explicitly supports Python 3.7+ only. Older versions of `suds` (0.4 and prior) were Python 2.x only. Trying to use this `suds` version with Python 2.x or an older Python 3.x interpreter (e.g., <3.7) will result in compatibility errors. Users migrating from the original `suds` or `suds-jurko` must ensure their Python environment is 3.7 or newer.
  Fix: Ensure your project uses Python 3.7 or a newer version. Install using `pip install suds` to get the latest Python 3 compatible community fork.
• gotcha When dealing with complex WSDL types that are subclasses or extensions of other types, directly passing a Python dictionary to represent these objects may cause issues. `suds` might not correctly infer the `xsi:type`, leading the server to reject the request (e.g., trying to instantiate an abstract base type instead of the concrete subclass).
  Fix: Always use `client.factory.create('TypeName')` to instantiate complex types defined in the WSDL. This ensures `suds` correctly sets the `xsi:type` attribute in the SOAP request.
• gotcha By default, `suds` logging is not verbose. It's common to miss crucial debug information (like the actual SOAP request/response XML or HTTP headers) when troubleshooting issues with web service calls.
  Fix: To enable detailed logging, configure Python's standard `logging` module. Set levels to `DEBUG` for `suds.client`, `suds.transport`, `suds.xsd.schema`, and `suds.wsdl` to see SOAP messages and other internal processes.
• breaking Version 0.8.0 introduced a change where objects are no longer instantiated with empty optional attributes by default. This changes the behavior from previous versions where such attributes might have been present as empty lists or `None` without explicit definition.
  Fix: Review code that relies on optional attributes being implicitly present in instantiated objects. You may need to explicitly check for attribute existence or modify your handling of service object structures.
• gotcha Many WSDLs or their imported schemas can be malformed or follow incorrect import rules, causing `suds` to fail during WSDL parsing or schema digestion. This is a common external factor leading to `suds` errors.
  Fix: Use the `suds.xsd.doctor.ImportDoctor` to fix broken schema imports at runtime if you encounter `schema not found` or similar errors during client initialization. This allows you to patch WSDLs with missing or incorrect schema references. For example: `from suds.xsd.doctor import Import, ImportDoctor; imp = Import('http://schemas.xmlsoap.org/soap/encoding/'); doctor = ImportDoctor(imp); client = Client(wsdl_url, doctor=doctor)`.

Install

• pip install suds Install latest version

Imports

• Client

  from suds.client import Client

  While `import suds.client` works, `from suds.client import Client` is the idiomatic and recommended way to access the primary client class.

Quickstart

This quickstart demonstrates how to create a `suds` client, inspect available service methods, and invoke a simple SOAP operation using a publicly available temperature conversion WSDL. It also includes basic logging configuration essential for debugging SOAP interactions.

import logging
import os
from suds.client import Client

# Configure logging to see SOAP requests/responses for debugging
logging.basicConfig(level=logging.INFO)
logging.getLogger('suds.client').setLevel(logging.DEBUG)

# A public WSDL for temperature conversion
wsdl_url = 'http://www.w3schools.com/xml/tempconvert.asmx?WSDL'

try:
    # Create a Suds client
    client = Client(wsdl_url)
    print(f"Connected to SOAP service at: {wsdl_url}")
    print("\nAvailable service methods:")
    print(client)

    # Invoke a method: FahrenheitToCelsius
    fahrenheit_temp = 68.0
    result = client.service.FahrenheitToCelsius(fahrenheit_temp)
    print(f"\n{fahrenheit_temp}°F is {result}°C")

    # Invoke another method: CelsiusToFahrenheit
    celsius_temp = 20.0
    result = client.service.CelsiusToFahrenheit(celsius_temp)
    print(f"{celsius_temp}°C is {result}°F")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Ensure the WSDL URL is correct and reachable, and that the service is active.")