OperationProxy return types

It seems like the OperationProxy might return zeep.xsd.valueobjects.CompoundValue or lxml.etree.Element.

This is an excerpt from WSDL file, this Response is returned as CompundValue:

      <s:element name="LogonResponse">
        <s:complexType>
          <s:sequence>
            <s:element maxOccurs="1" minOccurs="1" name="pstrSessionToken" type="s:string" />
            <s:element maxOccurs="1" minOccurs="1" name="pSessionInfo" type="tns:Element" />
            <s:element maxOccurs="1" minOccurs="1" name="pstrSecurityToken" type="s:string" />
          </s:sequence>
        </s:complexType>
      </s:element>

But in this case an Element is returned:

<s:element name="ExecuteQueryResponse">
    <s:complexType>
        <s:sequence>
            <s:element maxOccurs="1" minOccurs="1" name="pdomOutput" type="tns:Element" />
        </s:sequence>
    </s:complexType>
</s:element>

This leads to confusions as to how to treat the returned values and triggers mypy alerts.
Is it possible to somehow instrument the OperationProxy to always return e.g. CompundValue that could be unpacked manually later on if needed?

To be more specific:

python-zeep/src/zeep/wsdl/messages/soap.py

Lines 126 to 136 in 377d931

    
           # Check if we can remove the wrapping object to make the return value 
        
           # easier to use. 
        
           result = next(iter(result.__values__.values())) 
        
           if isinstance(result, xsd.CompoundValue): 
        
               children = result._xsd_type.elements 
        
               attributes = result._xsd_type.attributes 
        
               if len(children) == 1 and len(attributes) == 0: 
        
                   item_name, item_element = children[0] 
        
                   retval = getattr(result, item_name) 
        
                   return retval 
        
           return result

"to make the return value easier to use" in this particular case makes things more different for the client:

client code has to know which attributes should be passed when calling zeep.proxy.OperationProxy. This knowledge could be obtained from the WSDL definition.
as a return value client code will receive either etree.Element or zeep.xsd.valueobjects.CompundValue

Seems fair enough to always return zeep.xsd.valueobjects.CompundValue so that the client will have to use its properties using the same WSDL definition as a source of truth about the response structure.

Navigation Menu

Repository navigation

OperationProxy return types #1425

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	# Check if we can remove the wrapping object to make the return value
	# easier to use.
	result = next(iter(result.__values__.values()))
	if isinstance(result, xsd.CompoundValue):
	children = result._xsd_type.elements
	attributes = result._xsd_type.attributes
	if len(children) == 1 and len(attributes) == 0:
	item_name, item_element = children[0]
	retval = getattr(result, item_name)
	return retval
	return result

OperationProxy return types #1425

Description

Activity

atatarn commented on Aug 10, 2024

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions