Skip to main content

A transport and architecture agnostic rpc library that focuses on exposing public services with a well-defined API.

Project description

Spyne aims to save the protocol implementers the hassle of
implementing their own remote procedure call api and the application programmers
the hassle of jumping through hoops just to expose their services using multiple
protocols and transports.


* Fix Unicode losing pattern on re-customization
* Fix Duration serialization, add a ton of test cases.
* Fix binary urlsafe_base64 encoding.
* Fix arbitrary exception serialization.
* Fix some doc errors.

* Fix logic error in wsdl caching that prevented the url in Wsdl document from
being customized.
* Fix dictdoc not playing well with functions with empty return values.

* Fix exception serialization regression in DictDocument family.
* Fix xml utils (and its example).

* Fix default value handling in ``HttpRpc``.
* Fix invalid document type raising ``InternalError`` in DictDocument family.
It now raises ``ValidationError``.
* HttpRpc: Fix ``ByteArray`` deserialization.
* HttpRpc: Fix many corner cases with ``Array``s.
* Fix Csv serializer.
* Fix Mandatory variants of ``Double`` and ``Float`` inheriting from decimal.

* Fix handling of ``spyne.model.binary.File.Value`` with just path name.
* Fix decimal restrictions (some more).
* Make user code that doesn't return anything work with twisted server

* Add validation tests for HierDictDocument and fix seen issues.
* Add validation tests for FlatDictDocument and fix seen issues.
* Clarify Json and Http behavior in relevant docstrings.
* Fix Python2.6 generating max_occurs="inf" instead of "unbounded" sometimes.

* Fix ByteArray support accross all protocols.
* Fix namespaces of customized simple types inside ``XmlAttribute`` not being

* Fix confusion in Decimal restriction assignment.
* Fix classmethod calls to ProtocolBase.
* Fix schema generation error in namespaced xml attribute case.

* Returning twisted's Deferred from user code is now supported.
* You can now set Http response headers via ctx.out_header when
out_protocol is HttpRpc.
* lxml is not a hard requirement anymore.
* XmlDocument and friends: cleanup_namespaces is now True by default.
* XmlDocument and friends: Added ``encoding`` and ``pretty_print`` flags that
are directly passed to ``lxml.etree.tostring()``.
* XmlDocument and friends:'attribute_of' added to ModelBase to add attribute
support for primitives. This is currently ignored by (and mostly irrelevant
to) other protocols.
* XmlDocument and friends: Attribute serialization is working for arrays.
* Add support for exposing existing whose source code via the _args argument
to the srpc decorator. See the existing_api example for usage examples.
* Add Streaming versions of Pyramid and Django bridge objects.
* Remove destructor from ``MethodContext``. Now transports need to call
``.close()`` explicitly to close object and fire relevant events.
* Application event 'method_context_constructed' was renamed to
* Application event 'method_context_destroyed' was removed. The
``'method_context_closed'`` event can be used instead.
* SQLAlchemy integration now supports advanced features like specifying
indexing methods.
* The object composition graph can now be cyclic.
* Integers were overhauled. Now boundary values of limited-size types are
accessible via ``Attributes._{min,max}_bounds``.
* We now have six spatial types, ``Point``, ``LineString`` and ``Polygon``
along with their ``Multi*`` variants.
* The deprecated ``ProtocolBase.set_method_descriptor`` function was removed.
* It's now possible to override serialization in service implementations.
You can set ``ctx.out_document`` to have the return value from user funtion
ignored. You can also set ``ctx.out_string`` to have the ``ctx.out_document``
ignored as well.
* Added as_time_zone support to DateTime. It calls
``.astimezone(as_time_zone).replace(tzinfo=None)`` on native values.
* Added YAML support via PyYaml.
* Split dict logic in DictDocument as ``HierDictDocument`` and
* Complete revamp of how DictDocument family work. skip_depth is replaced by
richer functionalty that is enabled by two flags: ``ignore_wrappers`` and
* Added cookie parsing support to HttpRpc via ``Cookie.SimpleCookie``.
* Moved ``{to,from}_string`` logic from data models to ProtocolBase.
This gives us the ability to have more complex fault messages
with other fault subelements that are namespace-qualified without
circular dependency problems - Stefan Andersson <>
* DictDocument and friends: ``ignore_wrappers`` and ``complex_as`` options
added as a way to customize protocol output without hindering other parts
of the interface.

* Fix restriction bases of simple types not being imported.
* Fix for customized subclasses forgetting about their empty base classes.
* Fix Attributes.nullable not surviving customization.

* Fix for Python 2.6 quirk where any ``decimal.Decimal()`` is always less than
any ``float()``. Where did that come from?!
* Fix missing '/' in WsgiMounter.
* Fix confusion in ``spyne.model.primitive.Decimal``'s parameter order.
* Add forgotten ``HttpBase`` parameters to ``WsgiApplication``.

* Fix WsgiApplication choking on empty string return value.
* Fix TwistedWebResource choking on generators as return values.
* Fix Csv serializer.

* Fix Array serialization for Html Microformats
* Fix deserialization of Fault objects for Soap11
* Fix Uuid not playing well with soft validation.
* Fix Uuid not playing well with Xml Schema document.

* Spyne is now stable!
* Fix document_built events by adding a ``doc`` attribute to the ServerBase
class. You can now do ``some_server.doc.wsdl11.event_manager.add_listener``
to add events to interface documents.
* Add wsdl_document_built and xml_document_built events to relevant classes.
* Behavioral change for TableModel's relationship handling: It's now an array
by default. The TableModel is deprecated, long live __metadata__ on
* First-class integration with Pyramid.
* First geospatial types: Point and Polygon.
* Initial revision of the http request pattern matching support via
* ``XmlObject`` -> ``XmlDocument``, ``JsonObject`` -> ``JsonDocument``,
``MessagePackObject`` -> ``MessagePackDocument``,
``DictObject`` -> ``DictDocument``.

* integration! See for yourself:
* Python 2.4 compatibility claim was dropped, because this particular Python
version is nowhere to be found.
* Many issues with Python 2.5 compatibility are fixed.

* Misc fixes regarding the spyne.model.binary.File api.

rpclib-2.8.0-rc -> spyne-2.8.0-rc
* Rpclib is dead. Long live Spyne!
* Add support for JsonObject protocol. This initial version is expremental.
* Add support for MessagePackObject and MessagePackRpc protocols. These
initial versions are expremental.
* Make DateTime string format customizable.
* Implement TwistedWebResource that exposes an ``Application`` instance as a
``twisted.web.resource.Resource`` child.
* Remove Deprecated XMLAttribute and XMLAttributeRef. Use ``XmlAttribute``
and ``XmlAttributeRef`` instead.
* Xml Schema: Add support for the <any> tag.
* Add a chapter about Validation to the manual. Thanks Alex!
* Interface documents are no longer subclasses of InterfaceBase. It's up
to the transport to expose the application using a given interface document
standard now. The ``interface`` argument to the ``Application`` constructor
is now ignored.
* Html: Added a very simple lxml-based templating scheme: ``HtmlPage``.
* Html: Added row-based tables: They show fields in rows. It's good for
showing one object per table.
* Html: Added ImageUri support. They render as <img> tags in Html output.
* Html: Added support for locales. You can now render field names as human-
readable strings.
* Add support for async methods, which execute after the primary user code
returns. Currently, the only async execution method is via threads.
* Xml & friends: Start tags are now in the same namespace as the definitions
themselves. Intermediate tags are in the parent's namespace, just as before.
* Xml & friends: Make the 'bare' mode work.
* spyne.util.xml: `get_object_as_xml` can also get class suggestion.
* spyne.util.xml: `get_xml_as_object` has argument order swapped:
cls, elt -> elt, cls. See ab91a3e2ad4756b71d1a2752e5b0d2af8551e061.
* There's a final argument order change in Application ctor:

in_protocol, out_protocol, interface, name


name, in_protocol, out_protocol, interface

* Relevant pull requests with new features and behavioral changes:

* Add support for non-chunked encoding to Wsgi transport.
* Add support for Html Microformats.
* Add ``function`` property to MethodContext that is re-initialized from
``descriptor.function`` for each new request. Stay away from
``descriptor.function`` unless you understand the consequences!..
* String and Unicode models are now separate objects with well-defined
(de)serialization behaviour.
* Argument order change in Application ctor:

interface, in_protocol, out_protocol


in_protocol, out_protocol, interface

See here:

* Full changelog:

* Fix (for real this time) the race condition in wsgi server's wsdl handler.

* HttpRpc now parses POST/PUT/PATCH bodies, can accept file uploads.
Uses werkzeug to do that, which is now a soft dependency.
* ByteArray now child of SimpleModel. It's now possible to customize it simply
by calling it.
* Fix race condition in wsgi server wsdl request.
* Full change log:

* Misc. fixes.
* Full change log:

* Switched to magic cookie constants instead of strings in protocol logic.
* check_validator -> set_validator in ProtocolBase
* Started parsing Http headers in HttpRpc protocol.
* HttpRpc now properly validates nested value frequencies.
* HttpRpc now works with arrays of simple types as well.
* Full change log:

* Implemented fanout support for transports and protocols that can handle
* Implemented a helper module that generates a Soap/Wsdl 1.1 application in
* Some work towards supporting Python3 using ``2to3``. See issue #113.
* ``ctx.descriptor.reset_function`` implemented. It's now safe to fiddle
with that value in event handlers.
* Added a cleaned-up version of the Django wrapper:
* Fix most of the tests that fail due to api changes.
* Fix Http soap client.
* Full change log:

* Made color in logs optional
* Fixed ByteArray serializer

* Time primitive was implemented.
* Fix for multiple ports was integrated.
* Added http cookie authentication example with suds.
* Full change log:

* Many issues with 'soft' validation was fixed.
* ``MethodDescriptor.udp`` added. Short for "User-Defined Properties", you can
use it to store arbitrary metadata about the decorated method.
* Fix HttpRpc response serialization.
* Documentation updates.

* Fixed import errors in Python<=2.5.
* A problem with rpclib's String and unicode objects was fixed.

* Fixed Fault publishing in Wsdl.
* Implemented 'soft' validation.
* Documentation improvements. It's mostly ready!
* A bug with min/max_occurs logic was fixed. This causes rpclib not to send
null values for elements with min_occurs=0 (the default value).
* Native value for ``rpclib.model.primitive.String`` was changed to
``unicode``. To exchange raw data, you should use
* Full change log:

* Added MAX_CONTENT_LENGTH = 2 * 1024 * 1024 and BLOCK_LENGTH = 8 * 1024
constants to rpclib.server.wsgi module.
* rpclib.model.binary.Attachment is deprecated, and is replaced by ByteArray.
The native format of ByteArray is an iterable of strings.
* Exception handling was formalized. HTTP return codes can be set by exception
classes from rpclib.error or custom exceptions.
* Full change log:

* Limited support for sqlalchemy.orm.relationship (no string arguments)
* Added missing event firings.
* Documented event api and fundamental data structures (rpclib._base)
* Full change log:

* HttpRpc protocol now returns 404 when a requested resource was not found.
* New tests added for HttpRpc protocol.
* Miscellanous other fixes. See:

* Documentation improvements.
* rpclib.protocol.xml.XmlObject is now working as out_protocol.
* Many fixes.

* Documentation improvements.
* rpclib.client.http.Client -> rpclib.client.http.HttpClient
* rpclib.client.zeromq.Client -> rpclib.client.zeromq.ZeroMQClient
* rpclib.server.zeromq.Server -> rpclib.server.zeromq.ZeroMQServer
* rpclib.model.table.TableSerializer -> rpclib.model.table.TableModel

* Fixed call to rpclib.application.Application.call_wrapper
* Fixed HttpRpc server transport instantiation.
* Documentation improvements.

* rpclib.application.Application.call_wrapper introduced
* Documentation improvements.

* The serialization / deserialization logic was redesigned. Now most of the
serialization-related logic is under the responsibility of the ProtocolBase
* Interface generation logic was redesigned. The WSDL logic is separated to
XmlSchema and Wsdl11 classes. 'add_to_schema' calls were renamed to just
'add' and were moved inside rpclib.interface.xml_schema package.
* Interface and Protocol assignment of an rpclib application is now more
explicit. Both are also configurable during instantion. This doesn't mean
there's much to configure :)
* WS-I Conformance is back!. See
for the latest conformance report.
* Numeric types now support range restrictions. e.g. Integer(ge=0) will only
accept positive integers.
* Any -> AnyXml, AnyAsDict -> AnyDict. AnyAsDict is not the child of the AnyXml
* rpclib.model.exception -> rpclib.model.fault.

* The method dispatch logic was rewritten: It's now possible for the protocols
to override how method request strings are matched to methods definitions.
* Unsigned integer primitives were added.
* ZeroMQ client was fixed.
* Header confusion in native http soap client was fixed.
* Grouped transport-specific context information under ctx.transport
* Added a self reference mechanism.

* The inclusion of base xml schemas were made optional.
* WSDL: Fix out header being the same as in header.
* Added type checking to outgoing Integer types. it's not handled as nicely as
it should be.
* Fixed the case where changing the _in_message tag name of the method
prevented it from being called.
* SOAP/WSDL: Added support for multiple {in,out}_header objects.
* Fix some XMLAttribute bugs.

* Added inheritance support to rpclib.model.table.TableSerializer.

* The NullServer now also returns context with the return object to have it
survive past user-defined method return.

* More tests are migrated to the new api.
* Function identifier strings are no more created directly from the function
object itself. Function's key in the class definition is used as default
* Base xml schemas are no longer imported.

* Added rpclib.server.null.NullServer, which is a server class with a client
interface that attempts to do no (de)serialization at all. It's intended to
be used in tests.

* Add late mapping support to sqlalchemy table serializer.

* Add preliminary support for a sqlalchemy-0.7-compatible serializer.

* Migrate the HttpRpc serializer to the new internal api.

* SimpleType -> SimpleModel
* Small bugfixes.

* EventManager now uses ordered sets instead of normal sets to store event
* Implemented sort_wsdl, a small hack to sort wsdl output in order to ease

* Implemented EventManager and replaced hook calls with events.
* The rpc decorator now produces static methods. The methods still get an implicit
first argument that holds the service contexts. It's an instance of the
MethodContext class, and not the ServiceBase (formerly DefinitionBase) class.
* The new srpc decorator doesn't force the methods to have an implicit first
* Fixed fault namespace resolution.
* Moved xml constants to rpclib.const.xml_ns
* The following changes to soaplib were ported to rpclib's SOAP/WSDL parts:
* duration object is now compatible with Python's native timedelta.
* WSDL: Support for multiple <service> tags in the wsdl (one for each class in the
* WSDL: Support for multiple <portType> tags and multiple ports.
* WSDL: Support for enumerating exceptions a method can throw was added.
* SOAP: Exceptions got some love to be more standards-compliant.
* SOAP: Xml attribute support
* Moved all modules with packagename.base to packagename._base.
* Renamed classes to have module name as a prefix:
* rpclib.client._base.Base -> rpclib.client._base.ClientBase
* rpclib.model._base.Base -> rpclib.model._base.ModelBase
* rpclib.protocol._base.Base -> rpclib.protocol._base.ProtocolBase
* rpclib.server._base.Base -> rpclib.server._base.ServerBase
* rpclib.service.DefinitionBase -> rpclib.service.ServiceBase
* rpclib.server.wsgi.Application -> rpclib.server.wsgi.WsgiApplication
* Moved some classes and modules around:
* rpclib.model.clazz -> rpclib.model.complex
* rpclib.model.complex.ClassSerializer -> rpclib.model.complex.ComplexModel
* rpclib.Application -> rpclib.application.Application
* rpclib.service.rpc, srpc -> rpclib.decorator.rpc, srpc

soaplib-3.x -> rpclib-1.1.1-alpha
* Soaplib is now also protocol agnostic. As it now supports protocols other
than soap (like Rest-minus-the-verbs HttpRpc), it's renamed to rpclib. This
also means soaplib can now support multiple versions of soap and wsdl
* Mention of xml and soap removed from public api where it's not directly
related to soap or xml. (e.g. a hook rename: on_method_exception_xml ->
* Protocol serializers now return iterables instead of complete messages. This
is a first step towards eliminating the need to have the whole message in
memory during processing.

* This release transformed soaplib from a soap server that exclusively supported
http to a soap serialization/deserialization library that is architecture and
transport agnostic.
* Hard dependency on WSGI removed.
* Sphinx docs with working examples:
* Serializers renamed to Models.
* Standalone xsd generation for ClassSerializer objects has been added. This
allows soaplib to be used to define generic XML schemas, without SOAP
* Annotation Tags for primitive Models has been added.
* The soaplib client has been re-written after having been dropped from
recent releases. It follows the suds API but is based on lxml for better
WARNING: the soaplib client is not well-tested and future support is tentative
and dependent on community response.
* 0mq support added.
* Twisted supported via WSGI wrappers.
* Increased test coverage for soaplib and supported servers

* Standards-compliant Soap Faults
* Allow multiple return values and return types

* pritimitive.Array -> clazz.Array
* Support for SimpleType restrictions (pattern, length, etc.)

* Soap header support
* Tried the WS-I Test first time. Many bug fixes.

* Support for inheritance.

* Support for publishing multiple service classes.

* Soap server logic almost completely rewritten.
* Soap client removed in favor of suds.
* Object definition api no longer needs a class types: under class definition.
* XML Schema validation is supported.
* Support for publishing multiple namespaces. (multiple <schema> tags in the wsdl)
* Support for enumerations.
* Application and Service Definition are separated. Application is instantiated
on server start, and Service Definition is instantiated for each new request.
* @soapmethod -> @rpc

* Switched to lxml for proper xml namespace support.

* First public stable release.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spyne-2.10.7.tar.gz (174.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page