Skip to main content

Aiohttp transport for Spyne RPC library

Project description

Build status

About

Aiohttp transport for Spyne RPC library.

Requirements:

  • Python >= 3.6
  • Aiohttp >= 3.0.0
  • Spyne >= 2.12.9

Spyne alpha versions should also work.

Installation

Just run pip install aiohttp-spyne :)

Examples

  • Test server: python -m examples.hello_world
  • Threaded test server: python -m examples.hello_world_threads
  • Test client: python -m examples.test_client

Usage

First, initialize your spyne application as normal. Here’s an example for a simple SOAP service (See examples for a more complete service setup).

spyne_app = spyne.Application(
    [HelloWorldService],
    tns='aiohttp_spyne.examples.hello',
    in_protocol=Soap11(validator='lxml'),
    out_protocol=Soap11())

Next, wrap your Spyne application with AIOSpyne. Note that you can run your application entrypoints in a thread by setting the threads parameter. If you want to keep your entrypoints running in the same thread as the main application, just leave this None. If you DO run your entrypoints in threads, be aware that some signals sent by spyne will also be run in threads, and be extra careful of using your main loop!

handler = AIOSpyne(spyne_app, threads=25)

Lastly, make an aiohttp application as usual, and just bind GET and POST entrypoints from AIOSpyne to wherever. Note that both paths need to be the same.

With GET, if the request address ends ?wsdl or .wsdl, a WSDL schema is returned in a response. Otherwise requests are redirected to spynes RPC handler.

app = web.Application()
app.router.add_get('/{tail:.*}', handler.get)
app.router.add_post('/{tail:.*}', handler.post)
web.run_app(app, port=8080)

Testing and formatting

  1. pytest
  2. mypy -p aiohttp_spyne
  3. flake8
  4. black aiohttp_spyne/

License

LGPL-2.1 – Please see LICENSE for details.

Project details


Download files

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

Files for aiohttp-spyne, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size aiohttp_spyne-1.0.1-py3-none-any.whl (15.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size aiohttp-spyne-1.0.1.tar.gz (5.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page