Get simpleType with xsd:restriction using zeep (python)

Question

I'm calling a SOAP Service and one of the elements i need to pass in my request is a simpleType defined with restriction enumeration value as follows:

I read the element using the following statement with zeep library

sample_simple_type = client.get_type("ns0:SAMPLE_SIMPLE_TYPE")

But unfortunately i cannot set any value as i usually do with other elements. (I mean i cannot set "Code", "Description", "Service_Type_Code" and so on)

It seems like i need to retrieve ns0:SAMPLE_SIMPLE_TYPE already with an enumerated value but i don't know how to do it.

Thanks

Bogdan · Accepted Answer

I think you may be overthinking this. That type might be a restriction, but fundamentally it's a string. It can't be any string, just the values in the enumeration, but nonetheless it's a string. So you can treat it as such.

Here is an example.

I have a mock web service running on http://localhost:8080/. It doesn't do much, it just acknowledges requests. The mock service has this interface:

I've added your type to it.

If I run:

python -mzeep http://localhost:8080/test.wsdl

I get the following method definition from zeep:

...
...
Bindings:
     Soap11Binding: {http://tempuri.org/}TestSoap
     Soap12Binding: {http://tempuri.org/}TestSoap12

Service: Test
     Port: TestSoap (Soap11Binding: {http://tempuri.org/}TestSoap)
         Operations:
            Request(simpleString: xsd:string, yourEnumeration: ns0:SAMPLE_SIMPLE_TYPE) -> ack: xsd:string

     Port: TestSoap12 (Soap12Binding: {http://tempuri.org/}TestSoap12)
         Operations:
            Request(simpleString: xsd:string, yourEnumeration: ns0:SAMPLE_SIMPLE_TYPE) -> ack: xsd:string

Now see this code:

from zeep import Client
from zeep.plugins import HistoryPlugin
from lxml import etree

def print_history(h):
    print(etree.tostring(h.last_sent["envelope"], encoding = "unicode", pretty_print = True))
    print(etree.tostring(h.last_received["envelope"], encoding = "unicode", pretty_print = True))

history = HistoryPlugin()
client = Client('http://localhost:8080/test.wsdl', plugins = [history]) 
    
client.service.Request('whatever', 'Service_Type_Code')
print_history(history)

print('--------------------------------
')

client.service.Request('whatever', 'bla bla bla')
print_history(history)

print('--------------------------------
')

sample_simple_type = client.get_type("ns0:SAMPLE_SIMPLE_TYPE")

client.service.Request('whatever', sample_simple_type('Service_Type_Code'))
print_history(history)

print('--------------------------------
')

client.service.Request('whatever', sample_simple_type('bla bla bla'))
print_history(history)

print('--------------------------------
')

print(help(sample_simple_type))

It will produce the following output:


  
    
      whatever
      Service_Type_Code
    
  



   
   
      
         ok
      
   


--------------------------------


  
    
      whatever
      bla bla bla
    
  



   
   
      
         ok
      
   


--------------------------------


  
    
      whatever
      Service_Type_Code
    
  



   
   
      
         ok
      
   


--------------------------------


  
    
      whatever
      bla bla bla
    
  



   
   
      
         ok
      
   


--------------------------------

Help on SAMPLE_SIMPLE_TYPE object:

class SAMPLE_SIMPLE_TYPE(zeep.xsd.types.builtins.String)
 |  SAMPLE_SIMPLE_TYPE(qname=None, is_global=False)
 |  
 |  Method resolution order:
 |      SAMPLE_SIMPLE_TYPE
 |      zeep.xsd.types.builtins.String
 |      zeep.xsd.types.builtins.BuiltinType
 |      zeep.xsd.types.simple.AnySimpleType
 |      zeep.xsd.types.any.AnyType
 |      zeep.xsd.types.base.Type
 |      builtins.object
 |  
 |  Methods inherited from zeep.xsd.types.builtins.String:
 |  
 |  pythonvalue(self, value)
 |  
 |  xmlvalue = _wrapper(self, value)
 |  
 |  ----------------------------------------------------------------------
 |  Data and other attributes inherited from zeep.xsd.types.builtins.String:
 |  
 |  accepted_types = []
 |  
 |  ----------------------------------------------------------------------
 |  Methods inherited from zeep.xsd.types.builtins.BuiltinType:
 |  
 |  __init__(self, qname=None, is_global=False)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |  
 |  ----------------------------------------------------------------------
 |  Methods inherited from zeep.xsd.types.simple.AnySimpleType:
 |  
 |  __call__(self, *args, **kwargs)
 |      Return the xmlvalue for the given value.
 |      
 |      Expects only one argument 'value'.  The args, kwargs handling is done
 |      here manually so that we can return readable error messages instead of
 |      only '__call__ takes x arguments'
 |  
 |  __eq__(self, other)
 |      Return self==value.
 |  
 |  __str__(self)
 |      Return str(self).
 |  
 |  parse_xmlelement(self, xmlelement: lxml.etree._Element, schema: 'Schema' = None, allow_none: bool = True, context: zeep.xsd.context.XmlParserContext = None, schema_type: 'Type' = None) -> Union[str, zeep.xsd.valueobjects.CompoundValue, List[lxml.etree._Element], NoneType]
 |      Try to parse the xml element and return a value for it.
 |      
 |      There is a big chance that we cannot parse this value since it is an
 |      Any. In that case we just return the raw lxml Element nodes.
 |      
 |      :param xmlelement: XML element objects
 |      :param schema: The parent XML schema
 |      :param allow_none: Allow none
 |      :param context: Optional parsing context (for inline schemas)
 |      :param schema_type: The original type (not overriden via xsi:type)
 |  
 |  render(self, node: lxml.etree._Element, value: Union[list, dict, zeep.xsd.valueobjects.CompoundValue], xsd_type: 'ComplexType' = None, render_path=None) -> None
 |  
 |  signature(self, schema=None, standalone=True)
 |  
 |  validate(self, value, required=False)
 |  
 |  ----------------------------------------------------------------------
 |  Data and other attributes inherited from zeep.xsd.types.simple.AnySimpleType:
 |  
 |  __hash__ = None
 |  
 |  ----------------------------------------------------------------------
 |  Methods inherited from zeep.xsd.types.any.AnyType:
 |  
 |  resolve(self)
 |  
 |  ----------------------------------------------------------------------
 |  Methods inherited from zeep.xsd.types.base.Type:
 |  
 |  accept(self, value)
 |  
 |  extend(self, child)
 |  
 |  get_prefixed_name(self, schema)
 |  
 |  parse_kwargs(self, kwargs, name, available_kwargs)
 |  
 |  parsexml(self, xml, schema=None)
 |  
 |  restrict(self, child)
 |  
 |  ----------------------------------------------------------------------
 |  Readonly properties inherited from zeep.xsd.types.base.Type:
 |  
 |  attributes
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from zeep.xsd.types.base.Type:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

None

As you can see, I can treat that parameter as a string because it is a string. From the code, you can see that zeep doesn't even validate that the values are from within the enumeration (at least for now). That's why 'bla bla bla' also works.

The restriction is something that the server should enforce because it's part of its contract. If you send anything else than a value from the enumeration, you should get back a SoapFault. Since my service is just a dumb mock, it does no validation either, it just says it received a request.

Get simpleType with xsd:restriction using zeep (python)

Answers (1)

Related Questions