Release History

Historically, the release number of PyXB indicated stability in a way similar to that of Linux several years ago, with even/odd of the middle digit indicating stability/development. That policy ended as of 1.1.3, and the relaxed policy is:

• All releases consist of three non-negative integers
• A release series refers to all releases with the same first two integers. The third integer indicates an incremental update to the system.
• Should it be necessary to make wholesale changes that affect either stability or interface, the second or even first integer will be incremented
• Critical bug fixes may result in new releases in older series, but this is expected to be extremely unusual. Such fixes will be made on a branch of the git repository.
• All packaged releases are intended to be of comparable stability, with bug fixes and most enhancements causing an increment in the third integer

As examples, correcting the content model for weak determinism resulted in PyXB 1.2.0, and support of Python 3 will result in PyXB 1.3.0.

1.2.x

The 1.2.x release series introduces a new content model which provides much more help in resolving validation errors. Concurrent with this support was dropped for Python 2.4 and 2.5. The 1.2.x release will work with Python 2.6 and 2.7; some unit tests are skipped under Python 2.6 due to insufficient support for validating exception attributes.

1.2.2 (17 Apr 2013)

Almost all changes are bug fixes, including issues with element order when extending types, name conflicts between XML and Python entities in the binding, and unicode problems in diagnostics.

PyXB has never intentionally supported using bindings generated by different versions of PyXB. This will be enforced from version 1.2.2 onwards.

The following reported defects/enhancements have been addressed:

• Correct management of changes to default namespace within documents. #183
• Do not interleave base and extension type elements. #184
• Incorrect character range management resulted in regex failure. #186
• Wide unicode mis-defines XML1p0e2 Char class. #187
• Improve contents of StructuralBadDocumentError. #189
• Generate exception details correctly with unicode content. #190
• Namespace must be a reserved symbol within CTD instances.
• PyXB rejects restriction that changes element type. #193
• Multiple cases where names (from imported bindings, namespaces, and top-level classes and elements) resulted in conflicts with other top-level and class-level names. #191, #194, #197
• Avoid validating content of simple types marked with xsi:nil. #195
• Validate handling of attribute and element form attributes. #196
• Ensure all referenced namespaces are imported into a binding. #198
• Detect import of bindings generated by a different version of PyXB. #199

1.2.1 (17 Dec 2012)

Warning

This release has an interface change: the content method on complex types is now deprecated in favor of the orderedContent method. The members in the new list have wrapper classes to correctly associate instance bindings with the element declaration and to distinguish instances with string values from non-element character data. The old method is supported for this release, but will produce a warning when used, and is likely to be removed in the next release.

Key features of the release:

• Full support for mixed content schema through a new method orderedContent on complex binding instances and flags that control when that list affects document generation. See Influencing Element and Mixed Content Order. This is particularly relevant to XHTML.
• Immediate validation of values assigned to plural elements.
• A first step to providing finer control of validation, using ValidationConfig

The following reported defects/enhancements have been addressed:

• Validate pyxb.BIND at point of use. #69
• Issues with renamed element (most of which were mis-use of pyxb.BIND). #71
• Support for default and fixed values in elements. #99
• Support for mixed content. #153, #154
• Provide an example based on a help-forum thread to show how to take advantage of PyXB 1.2.x improved diagnostics. #158
• Improve interpretation of Python native type values when used in element constructors. #175
• Add ECMA-376 (Office Open XML) as an optional bundle. #178
• Fix invalid error when an all model group had minOccurs=0. #179
• Add Dublin Core to the standard bundles. #180
• Allow control of element order in generated documents. #181
• Include wildcard elements in content. #182

1.2.0 (07 Nov 2012)

This is a beta release intended to allow independent verification that the new content model works. It is released on SourceForge, but will not be made available through PyPI until such verification is satisfactory.

Key feature of the release:

• Use of an advanced content model which provides more accurate validation and much better diagnostics when validation fails.
• Elimination of support for Python 2.4 and 2.5 (necessary to ease the path to a future Python3 implementation of PyXB).
• Complete rework of the exceptions that normally arise when using binding instances. These exceptions now provide information through attributes rather than a text message.

The following reported defects/enhancements have been addressed:

• Improved diagnostics. #26, #75
• Correct handling of schema where greedy processing fails. #112, #133
• Elements and attributes in generated bindings are emitted in a deterministic order sorted by schema and location within schema, to ensure deterministic processing and reduce variation between bindings when generation is repeated. #164
• Make documentation annotations from schema available as documentation strings for the generated complex type bindings. #79
• Update OpenGIS bindings to use W3C XLink schema. #165

1.1.x

The 1.1.x release series entered maintenance mode with release 1.1.5. It is unlikely that further releases will occur, though critical bugs fixes may be made available in the release branch. Bugs reported against 1.1.5 will generally be fixed in the 1.2.x series.

1.1.5 (01 Nov 2012)

Documentation: http://pyxb.sourceforge.net/PyXB-1.1.5

This is a maintenance release to finalize the 1.1.x series before starting the 1.2.x series.

The following reported defects/enhancements have been addressed:

• The standard Python logging module is now used. #17, #159, #157
• The potential for changing binding style support has been removed. #82
• PyPI/setuptools support has been fixed (again). #130
• Unit test setup/teardown has been reviewed. #149
• utf-8 is now used in all PyXB source files. #151
• Preserve namespace mappings in deep-cloned instances. #155
• Fix problems revealed by cython and pyflakes. #156, #167
• User contributions from Jon Foster, with the exception of windows test scripts, have been incorporated. #157
• Correct issues in generator function to retrieve command line. #161
• Restore content of ExtraContentError exception. #163
• Warn rather than abort when apparently redundant schema are included. #169

1.1.4 (15 Jun 2012)

Documentation: http://pyxb.sourceforge.net/PyXB-1.1.4

Key features of the release:

• A large number of bug fixes, especially in the area of internationalization. Naive uses of unicode have mostly been eliminated.
• Corrections and improvements to date and time-related types, especially with respect to timezones.
• More namespaces have been added in the common, WS-*, and OpenGIS bundles.
• This release eliminates the separate packages for different bundles; all bundles and documentation except for OpenGIS are incorporated into the release file. OpenGIS is present but must be built manually; see OpenGIS

Examples have been added:

• examples/customization shows advanced customization, including injecting behavior into binding classes corresponding to types from which other XML types are extended or restricted. It also demonstrates how to introspect the bindings within a module, automating much of the process of extending multiple bindings with the same functionality.
• examples/unicode_jp demonstrates internationalization features including the ability to intercept PyXB’s construction of Python identifiers from XML identifiers to produce meaningful identifiers when the schema language is not compatible with the Python 2 requirement that identifiers be ASCII.

The following reported defects/enhancements have been addressed:

• Timezone support for xsd:date types. #102
• Pattern restriction does not work correctly with Unicode. #108
• bad unvalidated generation with simple list. #110
• Make simpleType CF_Enumeration iterable. #111
• toxml fails when wildcard is in unrecognized namespace. #114
• Problem with timedelta to duration conversion. #115
• Simple-typed elements accept any attributes. #116
• attributes are validated regardless of pyxb.RequireValidWhenParsing. #117
• unable to resolve with absent namespace. #119
• module CreateFromDocument ignores default_namespace. #120
• PyXB elementary data types do not play well with copy/pickling/.... #121
• PxXB should allow to assign None to optional elements and attributes. #122
• unbound wildcard element toxml() fails. #123
• misapplied allow_builtin_generation keyword in Generator. #124
• attributes are not validated regardless of pyxb.RequireValidWhenGenerating. #126
• dateTime objects must be timezone-aware. #127
• most lexical representations for reduced dates wrong. #128
• incorrect timezone adjustment from python values. #129
• validate processing of unicode in assignments and documents. #131
• Crash in PyXB when attempting to retrieve Unicode value from exception. #132
• Name, NMTOKEN, NCName wrong validation regexes. #134
• opengis/scripts/genbind removes all user files. #135
• preserve timezone in processing. #136
• wildcards rejected when validation disabled during parsing. #137
• xsd.dateTime loses microsecond precision. #138
• support alternative XML parsers. #139
• need regular way to replace MakeIdentifier. #141
• Document advanced customization. #142
• cleanup OpenGIS schema bundle. #143
• toxml needs encoding support. #144
• mark encoding in generated output. #146
• domutils references unqualified PyXB exceptions. #148

1.1.3 (09 Sep 2011)

Documentation: http://pyxb.sourceforge.net/PyXB-1.1.3

General cleanup, finish up a few previously unsupported datatypes.

• Correct extension of a simple type with enumeration restrictions. #89
• Use the Python string type as the basis for xs:hexBinary. #90
• Support + in PYXB_ARCHIVE_PATH like the documentation says. #92
• Correct exception reference. #93
• Correct handling of the ur-type. #94
• Automatically provide an xsi:type attribute when the schema uses the ur-type. #95
• Implement xs:base64binary. #83, #96
• Fix pickling and URI path issues on Windows. #97, #98
• Correct extensions that involve wildcards. #100
• Do a better job resolving circular dependencies, and don’t try to write two namespace groups to the same binding file. #104, #105
• Add a bundle for Security Assertion Markup Language. Thanks to Michael van der Westhuizen for providing this (sixteen months ago). #106
• Avoid overwrite of Python built-in constants, including None, True, and False. #107

1.1.2 (30 May 2010)

Documentation: http://pyxb.sourceforge.net/PyXB-1.1.2

Complete replacement of the model group portion of the content model. The NFA-to-DFA approach is gone. The resulting system does a better job in less space and significantly faster: 30% faster on the standard tmsxtvd test, orders of magnitude on documents with large sequences of optional elements.

Note: A couple unit tests fail due to incidental reasons that will be addressed when fixing #75. Also, the architecture documentation for the validation portion of the content model is completely out of date.

• Handle sequences of optional elements more effectively. #33
• Correct multi-step attribute restriction/extension. #80
• Support prefix rewrite for schema location URIs. #81
• Fix syntax error generating wildcard namespace constraints. #84
• Support whitespace validation bypass in simple type definitions. #85

1.1.1 (28 Jan 2010, rev 2135)

Documentation: http://pyxb.sourceforge.net/PyXB-1.1.1

Major feature is significantly improved ability to determine what content is not acceptable to the validating parser, and where it can be found in the document. See Locating Invalid Content.

Also, using keyword parameters in binding instance constructors will now raise an ExtraContentError in the case where the keyword does not correspond to the PyXB-generated identifier associated with an attribute or element of the class being instantiated.

• Eliminate complaints about reference to deprecated sha module in Python 2.6.
• Fix assorted problems with mixtures of –binding-root, –module-prefix, and –write-for-customization. #64, #65
• Eliminate unnecessary attempts to download schema for builtin namespaces. #63
• Avoid assertion failure when provided schema location’s content looks a little, but not enough, like a schema document. #72
• References to declarations in other namespaces are now calculated locally to the module, rather than cached under the expectation the name is valid everywhere. #73
• Imposed consistency on behavior when document root element is not recognized. #74
• Partial implementation of improved error data stored in exceptions. #75
• Detect invalid keywords in instance constructor calls. #76

1.1.0 (30 Nov 2009, rev 2092)

Mostly nit-picky things, but some changed interface, so we’re starting a new beta series.

• Make handling of invalid xsi:type attributes more robust. #56
• Use validation flags to control validation (what a novel concept). #57
• Fix improper generation of content within elements marked as xsi:nil. #58
• Provide mechanism to control default handling of xsi:type attributes in instance documents. #60
• Fix bug where constraining facets were not inherited when deriving simple types by restriction. #61

1.0.x (Stable)

1.0.0 (18 Oct 2009, rev 2068)

Nobody seems to have found anything critical for a while, and it does what I want it to, so we’ll let this thing run free.

• Replace a reference to a non-existent variable with something that works. #52
• Consistently validate instances created from documents no matter which parser is used. #53
• Support caching message references in WSDL SOAP faults. #54

0.7.x (Beta)

0.7.3 (15 Sep 2009, rev 2050)

A few bug fixes (one major), a couple new features, and separation of the various components to allow a smaller distribution.

• Fixed a circular reference in the DFA state classes that caused memory bloat in long-running processes. #49

• When PyXB renames an XML element or attribute due to a collision with a reserved word, it will write a warning, and at runtime will raise an exception if an attempt is made to assign to the original name. #50, #51

• Support for pattern restrictions for string-based simple types. #47

• Split distribution into multiple files to reduce download size:

  • PyXB-base-@VERSION@.tar.gz – Complete release, nothing pre-built
  • PyXB-doc-@VERSION@.tar.gz – Overlay with pre-built documentation
  • PyXB-common-@VERSION@.tar.gz – Overlay with XHTML bindings
  • PyXB-opengis-@VERSION@.tar.gz – Overlay with OpenGIS bindings
  • PyXB-wsspat-@VERSION@.tar.gz – Overlay with WS-* bindings
  • PyXB-full-@VERSION@.tar.gz – Complete release with all overlays

0.7.2 (25 Aug 2009, rev 1981)

Primarily to fix a problem with chameleon schemas, but also a couple other minor issues.

• References to QNames with absent namespaces in chameleon schema included into schema with a target namespace could not be resolved. #46
• Documentation content was not correctly sanitized for use within a Python docstring. #45.
• Elements with complex types with simple content that derived from string could not be marked as nil. #48

0.7.1 (23 Aug 2009, rev 1968)

None of the enhancements really got in, but lots of minor bug fixes.

• Restored the ability to dump copies of all schemas retrieved from a remote location, so you can review them. #28
• Fixed assorted problems with simple types constructed by list and union. #35, #40
• Provide link from content values to the element binding that was used to store them. Useful for quickly identifying the owner element when generating a valid child sequence for conversion to DOM. #36
• Fix validation of attributes with union types. #37
• Enumeration fixes: Only generate class-level constants for enumerations that restrict a string representation (not double, float, etc). Verify enumerations work correctly on list and union constructions. Duplicate the class-level constants for enumerations that are defined in union member types. #38
• Provide a facility to simplify the automatic creation of an instance of the appropriate type when storing values into an element. Makes life with anonymous local elements a lot easier. #39
• Enhance management of namespace prefixes by allowing a system-wide default in BindingDOMSupport and by inferring the base name of the module as the default prefix for namespaces defined in imported bindings. #41
• Provided crude facility to bypass validation when generating and parsing documents. #44
• Re-arrange the help for pyxbgen’s arguments, and add a script to automatically generate the Sphinx tables for it.
• Support bundles of related schemas/namespaces, currently wssplat (for WS-*) and opengis (Geographic Information Systems).
• Got the user-level documentation back up to where it might actually help somebody.

0.7.0 (03 Aug 2009, rev 1715)

This release is identical to 0.5.2 except that the binding interface has completely changed. All examples have been updated; the documentation will be updated later.

Note that the code in PyXB itself has not changed, and is not going to change. However, properties produce an interface more natural to most Python programs, so that has become the default style. See the –binding-style parameter to pyxbgen if you want to change this.

• Change the method of accessing elements and attributes in bindings from accessor methods (e.g., elt.attr(), elt.setAttr()) to properties (e.g., elt.attr). #18

0.5.x (Beta)

0.5.2 (03 Aug 2009, rev 1706)

Mostly changes to namespaces in support of profiles and application schemas which extend other namespaces with special components, or have their own copies of somebody else’s schemas, etc. See the pyxbgen private/public namespace switches.

• Presence of nested choice model groups caused the plurality calculations to be wrong: some elements were dropped from the model, others were treated as lists when only one instance would be permitted. #34
• Content accessor would return wrong value for elements with simple type of list variety. #32
• Corrected handling of attributes when deriving complex types by restriction. #27
• Added a source module for XML namespace (http://www.w3.org/XML/1998/namespace) with bindings linked to the built-in component model. #23
• Fix inadequacies in namespace archive management. #22

This is expected to be the last release in 0.5.x. 0.7.0 should follow soon thereafter, and only contain the change of default binding style from accessor to property. #18

0.5.1 (16 Jul 2009, rev 1502)

Fixed various problems with OpenGIS schemas, specifically dependency loops induced by attempting to keep binding components within modules identified by the schema they came from, and loss of bindings for one namespace due to its being overwritten by those for another.

• The presence of a wildcard in a sequence or choice model group caused other elements to be lost in the binding. #29
• Rework content verification to operate on binding instances rather than DOM nodes. #24
• Use value() to extract the value of a complex type with simple content; the content() method works only with element and mixed content. #21
• Add support to specify prefix to be used in QNames when generating DOM documents from binding instances. Provide facility to re-use the BindingDOMSupport instance for multiple conversions. #15
• Tightened requirements on content type matching: no more will strings and numbers automatically be converted to match the content model (probably for a branch you didn’t intend). #14
• Fix problems overwriting binding modules with data from a different set of namespaces. #31.
• Eliminated the schema group modules: too hard to avoid dependency loops. Now all components are written into a single module, which is a namespace group module if the components cross namespaces. A namespace-specific module still exists, and imports only the relevant components from the group module.

0.5.0 (07 Jul 2009, rev 1446)

Ability to parse many of the OpenGIS schemas (gml, iso19139, citygml, ogc, ogckml22, om, ows, sensorML, sos, swe, tml, ...).

• Completely rework include and import directives to correctly handle relative paths in schemaLocation attributes and to only import from a given location once per namespace. #9, #8, #5
• Parse final attribute on type definitions (though this has no effect on the bindings). #10
• Complete missing implementations in complex types with simple content. #6
• Create new code generation model which supports inter-namespace and inter-schema dependency cycles. Namespace archives can now holds all namespaces that depend on each other.
• Other miscellaneous. #11
• Did I mention the ability to handle OpenGIS? #16

Beware:

• Most of the classes in the new code generation model are undocumented.
• The interface to pyxbgen has changed completely. Look at examples/OpenGIS/makebind.sh or other scripts in the examples directory.

0.4.x (Stable)

0.4.0 (20 Jun 2009, rev 1204)

First usable public release.

• Use expanded names for all declarations and definitions. #1
• Use the finite automaton content model for generation as well as parsing. #2
• Support xsi:type and xsi:nil. #3
• Support substitution groups. #4
• Fix many problems in QName resolution
• Implement the remaining date/time types
• Rework content model so binding instances are always instances of the binding for the corresponding XML type, with no intervening element instance
• Add support for SAX parser

0.2.x (Stable)

0.2.0 (30 May 2009, rev 818)

• Initial public release