Suds-py3

Warnings

• breaking The original `suds` library (Python 2) is unmaintained, and its documentation has disappeared. `suds-py3` is a separate fork for Python 3 compatibility and ongoing fixes. Ensure you are installing `suds-py3` for Python 3 projects to avoid compatibility issues and use the maintained version.
  Fix: Always `pip install suds-py3` for Python 3 applications. Consult `suds-py3` specific documentation at https://suds-py3.readthedocs.io/en/latest/ for the correct usage.
• breaking Older versions of `suds` and `suds-py3` (specifically `suds` <= 0.4 and `suds-py3` < 1.4.4.1) were vulnerable to CVE-2013-2217, an improper link resolution before file access, allowing local users to redirect SOAP queries via a symlink attack on temporary cache files.
  Fix: Upgrade to `suds-py3` version 1.4.4.1 or newer to mitigate this vulnerability.
• gotcha Handling Unicode characters with web services, especially when interfacing with older or poorly configured SOAP services, can lead to `UnicodeDecodeError` or `UnicodeEncodeError`. While `suds-py3` aims to be Python 3 compatible, explicit encoding/decoding may still be necessary at the application level.
  Fix: Ensure all string inputs and outputs are correctly handled with appropriate encodings (e.g., UTF-8). Decode incoming data as early as possible to `unicode` (Python 3 strings) and encode to bytes only when sending.
• gotcha SOAP WSDLs and schemas are often malformed or contain incorrect import rules, leading to `suds` failing to parse the service definition correctly. `suds` provides 'doctors' to mend broken schemas at runtime.
  Fix: Utilize `suds.xsd.doctor.ImportDoctor` (or custom doctors) to fix common schema import problems. Pass a doctor instance to the `Client` constructor via `client_options=dict(doctor=ImportDoctor())`.
• gotcha Debugging SOAP interactions can be challenging. `suds-py3` relies on Python's standard `logging` module, and by default, detailed SOAP messages (sent/received) are not shown.
  Fix: To see SOAP messages and HTTP headers for debugging, configure Python's logging. A common practice is `import logging; logging.basicConfig(level=logging.INFO); logging.getLogger('suds.client').setLevel(logging.DEBUG)` to get detailed output.
• gotcha When working with complex types defined in the WSDL, merely passing Python dictionaries may not always work as expected for creating input objects. `suds-py3` provides a factory to explicitly create these types.
  Fix: Use `client.factory.create('TypeName')` to instantiate complex types defined in the WSDL. This ensures the object is correctly structured for the SOAP service.
• gotcha The OpenSSF Scorecard indicates that `suds-py3` has low activity in terms of commits and issue resolution (0 commits/issues in the last 90 days as of March 2, 2026). This suggests that active development might be slow.
  Fix: Be aware that new features or rapid bug fixes might not be implemented quickly. Consider contributing to the project or having a fallback plan if critical issues arise that require upstream changes.

Install

• pip install suds-py3 Install suds-py3

Imports

• Client

  from suds.client import Client

  While 'import suds' might work for some internal modules due to its structure, the standard and recommended way to access the Client class is via 'from suds.client import Client'.

Quickstart

The quickstart demonstrates connecting to a SOAP web service using `suds-py3`'s `Client` and invoking a simple method. It includes an example with a public temperature conversion WSDL. For services requiring authentication, username and password can be passed to the Client constructor. Enabling debug logging for `suds.client` is recommended for troubleshooting SOAP message exchanges.

import os
from suds.client import Client

# Replace with your WSDL URL. Use a placeholder for demonstration.
# A public WSDL for testing temperature conversion:
# wsdl_url = "http://www.w3schools.com/xml/tempconvert.asmx?WSDL"
wsdl_url = os.environ.get('SOAP_WSDL_URL', 'http://www.w3schools.com/xml/tempconvert.asmx?WSDL')

try:
    # Initialize the SOAP client
    client = Client(wsdl_url)
    print(f"Connected to SOAP service at: {wsdl_url}")

    # Optionally, print available services and methods
    # print(client)
    # print("Available services:", client.service)
    # print("Available factory types:", client.factory)

    # Example: Call a method (assuming TemperatureConvert service)
    # If the WSDL had authentication, you'd pass username/password to Client constructor
    # client = Client(wsdl_url, username=os.environ.get('SOAP_USERNAME', ''), password=os.environ.get('SOAP_PASSWORD', ''))

    # Convert Fahrenheit to Celsius
    fahrenheit_temp = 32.0
    celsius_temp = client.service.FahrenheitToCelsius(fahrenheit_temp)
    print(f"{fahrenheit_temp}°F is {celsius_temp}°C")

    # Convert Celsius to Fahrenheit
    celsius_temp_input = 0.0
    fahrenheit_temp_output = client.service.CelsiusToFahrenheit(celsius_temp_input)
    print(f"{celsius_temp_input}°C is {fahrenheit_temp_output}°F")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Please ensure the WSDL URL is correct and the service is accessible.")
    print("For debugging, you can enable logging: import logging; logging.getLogger('suds.client').setLevel(logging.DEBUG)")