PyXB: Python XML Schema Bindings

PyXB (“pixbee”) is a pure Python package that generates Python source code for classes that correspond to data structures defined by XMLSchema. The generated classes support bi-directional conversion between XML documents and Python objects. In concept it is similar to JAXB for Java and CodeSynthesis XSD for C++. A Thirty Second Example is at the bottom of this page. Step-by-step examples are in User Reference.

Getting Help

PyXB is distributed on SourceForge.

For support, consult the Help Forum, or subscribe to and email the mailing list.

To file a bug report or see the status of defects reported against the current release, visit the Trac database.

For a history of releases, see Release History.

Contents

• Overview
  • What Is PyXB?
  • How to use it
  • Examples of Supported Schema
  • Limitations
  • License and Disclaimers
  • PyXB Vision
  • Related Packages
• Examples
  • Dictionary (Aonaware)
  • Simple Weather (CDyne)
  • Professional Weather (National Digital Forecast Data)
  • Television Schedules (Tribune Media Services)
  • Address-To-Latitude/Longitude (http://geocoder.us)
  • OpenGIS (http://www.opengeospatial.org)
• Release History
  • 1.1.x (Beta)
  • 1.0.x (Stable)
  • 0.7.x (Beta)
  • 0.5.x (Beta)
  • 0.4.x (Stable)
  • 0.2.x (Stable)
• Architecture
  • Namespaces
  • Component Model
  • Binding Model
  • Content Model
• User Reference
  • Generating Binding Classes
  • Using Binding Classes
  • pyxbgen Command Line Options
• Maintainer Reference
  • The API
  • Coding Practices

Thirty Second Example

An example of a program using PyXB to interact with a web service using an automatically-generated module. First, retrieve the WSDL and generate the bindings:

vmserver[171]$ pyxbgen \
  --wsdl-location="http://wsf.cdyne.com/WeatherWS/Weather.asmx?wsdl" \
  --module=weather \
  --write-for-customization
urn:uuid:3a6c7be2-d9b7-11e0-ae84-001fbc013adc
Retrieving WSDL from http://wsf.cdyne.com/WeatherWS/Weather.asmx?wsdl
Importing pyxb.binding.datatypes to get binding for wildcard {http://www.w3.org/2001/XMLSchema}schema
NOTE: Created unbound wildcard element from value in schema
PS urn:uuid:3a6c7be2-d9b7-11e0-ae84-001fbc013adc
Complex type {http://ws.cdyne.com/WeatherWS/}ArrayOfWeatherDescription renamed to ArrayOfWeatherDescription_
Complex type {http://ws.cdyne.com/WeatherWS/}ForecastReturn renamed to ForecastReturn_
Complex type {http://ws.cdyne.com/WeatherWS/}WeatherReturn renamed to WeatherReturn_
Python for http://ws.cdyne.com/WeatherWS/ requires 1 modules
Saved binding source to ./raw/weather.py
vmserver[171]$

Then write a program that uses them:

import time
import urllib2
import weather   # Bindings generated by PyXB
import pyxb.utils.domutils as domutils

uri = 'http://wsf.cdyne.com/WeatherWS/Weather.asmx/GetCityForecastByZIP?ZIP=85711'
xml = urllib2.urlopen(uri).read()
doc = domutils.StringToDOM(xml)
fc_return = weather.CreateFromDOM(doc.documentElement)
if fc_return.Success:
    print 'Weather forecast for %s, %s:' % (fc_return.City, fc_return.State)
    for fc in fc_return.ForecastResult.Forecast:
        when = time.strftime('%A, %B %d %Y', fc.Date.timetuple())
        outlook = fc.Desciption # typos in WSDL left unchanged
        low = fc.Temperatures.MorningLow
        high = fc.Temperatures.DaytimeHigh
        print '  %s: %s, from %s to %s' % (when, outlook, low, high)

And run it:

vmserver[171]$ python client.py
Got response for Saint Paul, MN:
 Thursday, September 08 2011: Sunny, from 58 to 80
 Friday, September 09 2011: Partly Cloudy, from 58 to 80
 Saturday, September 10 2011: Sunny, from 58 to 80
 Sunday, September 11 2011: Sunny, from 58 to 81
 Monday, September 12 2011: Partly Cloudy, from 61 to 80
 Tuesday, September 13 2011: Sunny, from 55 to 69
 Wednesday, September 14 2011: Sunny, from 48 to 68
vmserver[172]$

That’s it.

Indices and tables

• Index
• Search Page