WSDL (Experimental)

The implementation is experimental and currently only WSDL 1.1 and SOAP 1.1 bindings have been implemented.

The code generator in addition to models derived from xml schemas will also generate dataclasses for messages and simple classes to describe the unique operations.

$ xsdata --wsdl --package calculator http://www.dneonline.com/calculator.asmx?WSDL

Message Model

The message models are not any different to xsd derived classes and include the complete structure of the Envelope wrapper.

@dataclass
class CalculatorSoapAddInput:
    """
    :ivar body:
    """
    class Meta:
        name = "Envelope"
        namespace = "http://schemas.xmlsoap.org/soap/envelope/"

    body: Optional["CalculatorSoapAddInput.Body"] = field(
        default=None,
        metadata={
            "name": "Body",
            "type": "Element",
        }
    )

    @dataclass
    class Body:
        """
        :ivar add:
        """
        add: Optional[Add] = field(
            default=None,
            metadata={
                "name": "Add",
                "type": "Element",
                "namespace": "http://tempuri.org/",
            }
        )

Operation Class

The DefinitionsMapper will generate simple static classes to describe all the unique operations and the binding procedure.

class CalculatorSoapAdd:
    style = "document"
    location = "http://www.dneonline.com/calculator.asmx"
    transport = "http://schemas.xmlsoap.org/soap/http"
    soap_action = "http://tempuri.org/Add"
    input = CalculatorSoapAddInput
    output = CalculatorSoapAddOutput

Client

The Client is a proxy for consuming web services. The client needs a web service Config with the directives to process requests and responses.

Optionally you can also provide and override

• the default transport implementation Transport

• the XmlParser with your custom config

• the XmlSerializer with your custom config

Creating instances

The client can be initialized from the an operation class directly

>>> client = Client.from_service(CalculatorSoapAdd)
>>> client.config
Config(style='document', location='http://www.dneonline.com/calculator.asmx', transport='http://schemas.xmlsoap.org/soap/http', soap_action='http://tempuri.org/Add', input=<class 'tests.fixtures.calculator.services.CalculatorSoapAddInput'>, output=<class 'tests.fixtures.calculator.services.CalculatorSoapAddOutput'>)

But you can also override any properties as you see fit

>>> client = Client.from_service(CalculatorSoapAdd, location="http://testurl.com")
>>> client.config
Config(style='document', location='http://testurl.com', transport='http://schemas.xmlsoap.org/soap/http', soap_action='http://tempuri.org/Add', input=<class 'tests.fixtures.calculator.services.CalculatorSoapAddInput'>, output=<class 'tests.fixtures.calculator.services.CalculatorSoapAddOutput'>)

Or if you know what you are doing

>>> config = Config(
...         style="document",
...         location="",
...         transport=TransportTypes.SOAP,
...         soap_action="",
...         input=None,
...         output=None,
...     )
>>> client = Client(config=config)

Performing Requests

The send method requires either an object that matches the config input type or a dictionary with raw values that matches the input dataclass field names and structure.

>>> request = CalculatorSoapAddInput(body=CalculatorSoapAddInput.Body(add=Add(10, 2)))
>>> res = client.send(request)
>>> res
CalculatorSoapAddOutput(body=CalculatorSoapAddOutput.Body(add_response=AddResponse(add_result=12)))

>>> client = Client.from_service(CalculatorSoapAdd)
>>> params = {"body": {"add": {"int_a": 3, "int_b": 4}}}
>>> res = client.send(params)
>>> res
CalculatorSoapAddOutput(body=CalculatorSoapAddOutput.Body(add_response=AddResponse(add_result=7)))
>>>

You can also provide a dictionary of custom headers as well, although the headers that are needed for the webservice to work can not be overwritten.,

>>> client.send(params, headers={"User-Agent": "xsdata"})