How to use the type AnyXml correctly? #662

random343 · 2021-06-23T10:25:52Z

random343
Jun 23, 2021

I need the service to accept data according to the xsd:

...
<xs:complexType name="QueryExpressionType">
    <xs:sequence>
        <xs:any minOccurs="0" processContents="lax">
    </xs:sequence>
</xs:complexType>
...

My code:

# -*- coding: utf-8 -*-
from spyne.const.xml import XSD
from spyne import Application, rpc, ServiceBase
from spyne.protocol.soap import Soap11
from spyne.model.primitive import AnyXml
from spyne.model.complex import ComplexModel

class QueryExpressionType(ComplexModel):
    Any = AnyXml.customize(max_occurs = 1,
                           schema_tag = XSD('any'),
    )

class TestCls(ServiceBase):
    @rpc(QueryExpressionType,
         _out_variable_names = ["p", ],
         _returns = [QueryExpressionType, ]
        )
    def testMtd(ctx, p):
        return p
...

My request:

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <testMtd xmlns="test.ns">
            <p>
                <!-- Any elements -->
                <q>test</q>
            </p>
        </testMtd>
    </Body>
</Envelope>

Service response:

<soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="test.ns">
    <soap11env:Body>
        <tns:testMtdResponse>
            <tns:p/>
        </tns:testMtdResponse>
    </soap11env:Body>
</soap11env:Envelope>

Why am I getting this?

How do I get the answer:

<soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="test.ns">
    <soap11env:Body>
        <tns:testMtdResponse>
            <tns:p>
                <tns:q>test</tns:q>
            </tns:p>
        </tns:testMtdResponse>
    </soap11env:Body>
</soap11env:Envelope>

plq · 2021-06-23T14:29:32Z

plq
Jun 23, 2021
Maintainer

please move this to discussions so i can answer you.

1 reply

plq Jun 23, 2021
Maintainer

never mind, seems like I can do that myself. neat :)

plq · 2021-06-23T14:52:00Z

plq
Jun 23, 2021
Maintainer

Hello,

Your return type is QueryExpressionType, but you're returning an xml document. Please find the corrected version:

from lxml import etree

from spyne import Application, rpc, ServiceBase
from spyne.protocol.soap import Soap11
from spyne.model.primitive import AnyXml
from spyne.model.complex import ComplexModel
from spyne.server.wsgi import WsgiApplication


class QueryExpressionType(ComplexModel):
    p = AnyXml


class TestCls(ServiceBase):
    @rpc(AnyXml,
        _returns=QueryExpressionType
    )
    def testMtd(ctx, p):
        logging.debug("Received: %s", etree.tostring(p, pretty_print=True))
        return QueryExpressionType(p=p)


application = Application([TestCls], 'test.ns',
                          in_protocol=Soap11(validator='lxml'),
                          out_protocol=Soap11())

wsgi_application = WsgiApplication(application)


if __name__ == '__main__':
    import logging

    from wsgiref.simple_server import make_server

    logging.basicConfig(level=logging.DEBUG)
    logging.getLogger('spyne.protocol.xml').setLevel(logging.DEBUG)

    logging.info("listening to http://127.0.0.1:8000")
    logging.info("wsdl is at: http://localhost:8000/?wsdl")

    server = make_server('127.0.0.1', 8000, wsgi_application)
    server.serve_forever()

Request

curl -s http://localhost:8000 --data-binary @-  <<EOF | tidy -xml -indent -wrap 0 -quiet
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <testMtd xmlns="test.ns">
            <p>
                <!-- Any elements -->
                <q>test</q>
            </p>
        </testMtd>
    </Body>
</Envelope>
EOF

Response:

<?xml version='1.0' encoding='utf-8'?>
<soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="test.ns">
  <soap11env:Body>
    <tns:testMtdResponse>
      <tns:testMtdResult>
        <tns:p>
          <tns:q>test</tns:q>
        </tns:p>
      </tns:testMtdResult>
    </tns:testMtdResponse>
  </soap11env:Body>
</soap11env:Envelope>

0 replies

random343 · 2021-06-24T06:40:49Z

random343
Jun 24, 2021
Author

Thank you. Your option works.

With the return of a value, everything is clear.

But I need not AnyXml to be passed to the input, but QueryExpressionType, since it is actually more complicated than in my example.

Is it possible to pass to the input a complex type, one of which is Any?

Example:

<xs:complexType name="QueryExpressionType">
    <xs:sequence>
        <xs:any minOccurs="0" processContents="lax">
    </xs:sequence>
    <attribute name="queryLanguage" type="tns:referenceURI" use="required"/>
</xs:complexType>

0 replies

plq · 2021-06-24T06:48:05Z

plq
Jun 24, 2021
Maintainer

Here's something that sounds like what you need:

class QueryExpressionType(ComplexModel):
    any = AnyXml


class TestCls(ServiceBase):
    @rpc(QueryExpressionType,
        _returns=QueryExpressionType
    )
    def testMtd(ctx, p):
        logging.debug("Received: %s", etree.tostring(p.any, pretty_print=True))
        return p

It should work with the following doc

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <testMtd xmlns="test.ns">
            <p>
                <any>
                    <!-- Any elements -->
                    <q>test</q>
                </any>
            </p>
        </testMtd>
    </Body>
</Envelope>

0 replies

random343 · 2021-06-24T07:05:47Z

random343
Jun 24, 2021
Author

My code:

class QueryExpressionType(ComplexModel):

    __namespace__ = 'test.ns'
    Any = AnyXml.customize(max_occurs = 1,
                           schema_tag = XSD('any'),
                          )
    name = XmlAttribute(String.customize(max_occurs = 1,
                                         is_xml_attribute = '1'
                                        ))

class TestCls(ServiceBase):
    __service_name__ = 'TestCls'
    __port_types__ = ['Application',]

    @rpc(QueryExpressionType,  
         _port_type = 'Application',
         )
    def testMtd(ctx, p):
        print(etree.tostring(p, pretty_print=True))

Query:

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <testMtd xmlns="test.ns">
            <!-- Optional -->
            <p name="qqq">
                <!-- Any elements -->
                <q>ttt</q>
            </p>
        </testMtd>
    </Body>
</Envelope>

I get an error:

    print(etree.tostring(p, pretty_print=True))
  File "src/lxml/etree.pyx", line 3445, in lxml.etree.tostring
TypeError: Type 'QueryExpressionType' cannot be serialized.

0 replies

plq · 2021-06-24T07:15:08Z

plq
Jun 24, 2021
Maintainer

As you now have a working example, you should go from my example to yours in baby steps. When your code stops working, that's your mistake right there.

0 replies

random343 · 2021-06-24T07:29:06Z

random343
Jun 24, 2021
Author

Thank you, I need to be careful.
I missed the tag Any in the request body.

But how then to describe the class QueryExpressionType so that Spyne returns a schema

...
<xs:complexType name="QueryExpressionType">
    <xs:sequence>
        <xs:any minOccurs="0" processContents="lax">
    </xs:sequence>
    <attribute name="queryLanguage" type="tns:referenceURI" use="required"/>
</xs:complexType>
...

but the request did not require the Any tag?

0 replies

plq · 2021-06-24T11:17:56Z

plq
Jun 24, 2021
Maintainer

I'm asking this because I don't have the code handy. What is the current schema you have? What's wrong with it?

0 replies

random343 · 2021-06-25T07:10:49Z

random343
Jun 25, 2021
Author

I'll try to explain it with another example.

xsd:

<xs:schema targetNamespace="test.ns" elementFormDefault="qualified">
  <xs:element name="person">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="firstname" type="xs:string"/>
        <xs:element name="lastname" type="xs:string"/>
        <xs:any minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

My code:


from spyne.const.xml import XSD
from spyne import Application, rpc, ServiceBase, XmlAttribute
from spyne.protocol.soap import Soap11
from spyne.model.primitive import AnyXml, String
from spyne.model.complex import ComplexModel

from lxml import etree


class Person(ComplexModel):

    __namespace__ = 'test.ns'
    firstname = String
    lastname = String
    Any = AnyXml.customize(min_occurs = 0,
                           schema_tag = XSD('any'),
                           namespace = '##other',
                          )

class TestCls(ServiceBase):
    __service_name__ = 'TestCls'
    __port_types__ = ['Application',]

    @rpc(Person,  
         _port_type = 'Application',
         )
    def testMtd(ctx, person):
        print(person)

application=Application([TestCls], tns='test.ns', in_protocol=Soap11(validator='soft'), out_protocol=Soap11())

On request:

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <testMtd xmlns="test.ns">
            <person>
                <firstname>Hege</firstname>
                <lastname>Refsnes</lastname>
                <children>
                    <childname>Cecilie</childname>
                </children>
            </person>
        </testMtd>
    </Body>
</Envelope>

printed:
Person(firstname='Hege', lastname='Refsnes')

On request:

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <testMtd xmlns="test.ns">
            <person>
                <firstname>Hege</firstname>
                <lastname>Refsnes</lastname>
                <Any>
                    <children>
                        <childname>Cecilie</childname>
                    </children>
                </Any>
            </person>
        </testMtd>
    </Body>
</Envelope>

printed:
Person(firstname='Hege', lastname='Refsnes', Any=<Element {test.ns}children at 0x7fcab9134b00>)

How do I configure Spyne so that the request does not require the Any tag?

0 replies

plq · 2021-06-25T11:31:16Z

plq
Jun 25, 2021
Maintainer

Hello,

Any type is for optimizing the transport of xml documents (you need to watch for stuff like namespace spills though). Maybe it has other uses but I have no idea about them. If you have a known schema, you shouldn't use it.

The following models your document in spyne notation:

class Person(ComplexModel):
    _type_info = [
        ('firstname', Unicode),
        ('lastname', Unicode),
        ('children', Array(Unicode(sub_name="childname"))),
    ]


class TestCls(ServiceBase):
    @rpc(Person, _returns=Person)
    def testMtd(ctx, person):
        logging.debug("Received: %r", person)
        return person

Here, you need to use _type_info because you need a <xs:sequence/> and that requires a python list. Class variables are passed inside **kwargs dicts and have random order in some versions of python (fixed in https://www.python.org/dev/peps/pep-0468/)

Anyway, here's a way to test:

$ curl -s http://localhost:8000 --data-binary @- <<EOF | tidy -xml -indent -wrap 0 -quiet
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <testMtd xmlns="test.ns">
            <person>
                <firstname>Hege</firstname>
                <lastname>Refsnes</lastname>
                <children>
                    <childname>Cecilie</childname>
                </children>
            </person>
        </testMtd>
    </Body>
</Envelope>
EOF

Response:

<?xml version='1.0' encoding='utf-8'?>
<soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="test.ns">
  <soap11env:Body>
    <tns:testMtdResponse>
      <tns:testMtdResult>
        <tns:firstname>Hege</tns:firstname>
        <tns:lastname>Refsnes</tns:lastname>
        <tns:children>
          <tns:childname>Cecilie</tns:childname>
        </tns:children>
      </tns:testMtdResult>
    </tns:testMtdResponse>
  </soap11env:Body>
</soap11env:Envelope>

I hope that helps

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

How to use the type AnyXml correctly? #662

{{title}}

Replies: 10 comments 1 reply

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Select a reply

How to use the type AnyXml correctly? #662

random343 Jun 23, 2021

Replies: 10 comments · 1 reply

plq Jun 23, 2021 Maintainer

plq Jun 23, 2021 Maintainer

plq Jun 23, 2021 Maintainer

random343 Jun 24, 2021 Author

plq Jun 24, 2021 Maintainer

random343 Jun 24, 2021 Author

plq Jun 24, 2021 Maintainer

random343 Jun 24, 2021 Author

plq Jun 24, 2021 Maintainer

random343 Jun 25, 2021 Author

plq Jun 25, 2021 Maintainer

random343
Jun 23, 2021

Replies: 10 comments 1 reply

plq
Jun 23, 2021
Maintainer

plq Jun 23, 2021
Maintainer

plq
Jun 23, 2021
Maintainer

random343
Jun 24, 2021
Author

plq
Jun 24, 2021
Maintainer

random343
Jun 24, 2021
Author

plq
Jun 24, 2021
Maintainer

random343
Jun 24, 2021
Author

plq
Jun 24, 2021
Maintainer

random343
Jun 25, 2021
Author

plq
Jun 25, 2021
Maintainer