summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpab <bigot@acm.org>2009-10-17 16:01:59 -0500
committerpab <bigot@acm.org>2009-10-17 16:01:59 -0500
commitf67610875780cc444c96a25bf490fa3128b29d31 (patch)
treea33a26f49354d8d4f690794b25377ffed1ab2f58
parentfc49e57ae1d45da21b8056b08ac0542564232d79 (diff)
Pre-release cleanup
-rw-r--r--doc/arch_namespaces.txt8
-rw-r--r--doc/examples.txt10
-rw-r--r--doc/index.txt27
-rw-r--r--doc/legal.txt6
-rw-r--r--doc/limitations.txt3
-rw-r--r--doc/overview.txt28
-rw-r--r--doc/overview_how.txt8
-rw-r--r--doc/overview_what.txt2
-rw-r--r--doc/related.txt27
-rw-r--r--doc/releases.txt34
-rw-r--r--doc/userref_usebind.txt3
11 files changed, 92 insertions, 64 deletions
diff --git a/doc/arch_namespaces.txt b/doc/arch_namespaces.txt
index 04b3766..a35a843 100644
--- a/doc/arch_namespaces.txt
+++ b/doc/arch_namespaces.txt
@@ -100,7 +100,7 @@ categories supported by a namespace and to add named objects to those
categories. A name is **resolved** when the object with which it is
associated has been identified. Objects are **resolved** when any names on
which they depend have been resolved.
-:api:`pyxb.namespace._NamespaceResolution_mixin` provides a mechanism to
+:api:`pyxb.namespace.resolution._NamespaceResolution_mixin` provides a mechanism to
hold on to names that have been encountered but whose associated objects
have not yet been resolved (perhaps because the named object on which they
depend has not been defined).
@@ -108,10 +108,10 @@ depend has not been defined).
Because one named object (e.g., a model group definition) might require
resolution of another (e.g., an element reference), resolution is an
iterative process, implemented by
-:api:`pyxb.namespace._NamespaceResolution_mixin.resolveDefinitions`, and
+:api:`pyxb.namespace.resolution._NamespaceResolution_mixin.resolveDefinitions`, and
executed when all named objects have been added to the namespace. It
-depends on :api:`pyxb.namespace.NamespaceContext` to identify named objects
-using the :api:`pyxb.namespace.NamespaceContext.interpretQName` method.
+depends on :api:`pyxb.namespace.resolution.NamespaceContext` to identify named objects
+using the :api:`pyxb.namespace.resolution.NamespaceContext.interpretQName` method.
Expanded Names
--------------
diff --git a/doc/examples.txt b/doc/examples.txt
index 422677b..54d7736 100644
--- a/doc/examples.txt
+++ b/doc/examples.txt
@@ -114,18 +114,18 @@ work with:
- Set ``nillable`` on all elements that are observed to use ``xsi:nil="true"`` in
response documents
- Provide types and elements corresponding to the request and response
- messages, since PyXB's WSDL support does not generate them from the
- operation messages.
+ messages, since PyXB's WSDL support does not currently generate them from
+ the operation messages.
-These changes are applied to the WSDL by :file:`genbindings.sh` after
-retrieving it and prior to generating the bindings.
+ :file:`genbindings.sh` applies changes to the WSDL after retrieving it and
+prior to generating the bindings.
A second complication is the need to burrow down through wildcard elements
in the binding instance generated from the SOAP response. This is the
consequence of an `error in the WSDL specification
<http://tech.groups.yahoo.com/group/soapbuilders/message/5879>`_, which was
discovered after too many tools had already worked around it. Currently,
-PyXB requires that you also work around it manually, although a
+PyXB also requires that you work around it manually, although a
customization of the relevant SOAP encoding class could make it unnecessary.
.. literalinclude:: ../examples/geocoder/client.py
diff --git a/doc/index.txt b/doc/index.txt
index 991888a..41ae69d 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -31,7 +31,7 @@ Getting Help
PyXB is distributed on `SourceForge <http://sourceforge.net/projects/pyxb>`_.
For support, consult the `Help Forum
-<https://sourceforge.net/forum/forum.php?forum_id=956708>`_, or subscribe to
+<https://sourceforge.net/projects/pyxb/forums/forum/956708>`_, or subscribe to
and email the `mailing list
<https://sourceforge.net/mailarchive/forum.php?forum_name=pyxb-users>`_.
@@ -64,16 +64,17 @@ An example of a program using PyXB to interact with a `web service
automatically-generated module. First, retrieve the WSDL and generate the
bindings::
- vmfed9[23]$ pyxbgen \
+ mnservices[4]$ pyxbgen \
--wsdl-location="http://ws.cdyne.com/WeatherWS/Weather.asmx?wsdl" --module=weather \
--write-for-customization
- urn:uuid:769983dc-8ecb-11de-b7e5-000c292f797c
+ urn:uuid:57d386ce-bb48-11de-a28f-001cc05930fc
Retrieving WSDL from http://ws.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 DOM node {http://www.w3.org/2001/XMLSchema}schema
- PS urn:uuid:769983dc-8ecb-11de-b7e5-000c292f797c
+ PS urn:uuid:57d386ce-bb48-11de-a28f-001cc05930fc
Python for http://ws.cdyne.com/WeatherWS/ requires 1 modules
Saved binding source to ./raw/weather.py
+ mnservices[5]$
Then write a program that uses them:
@@ -81,16 +82,16 @@ Then write a program that uses them:
And run it::
- vmfed9[64]$ python client_get.py
+ mnservices[5]$ python client_get.py
Weather forecast for Tucson, AZ:
- Saturday, August 22 2009: Thunder Storms, from 80 to 90
- Sunday, August 23 2009: Partly Cloudy, from 78 to 92
- Monday, August 24 2009: Partly Cloudy, from 75 to 95
- Tuesday, August 25 2009: Partly Cloudy, from 75 to 96
- Wednesday, August 26 2009: Partly Cloudy, from 76 to 99
- Thursday, August 27 2009: Sunny, from 77 to 99
- Friday, August 28 2009: Sunny, from 77 to 100
- vmfed9[65]$
+ Saturday, October 17 2009: Sunny, from to 98
+ Sunday, October 18 2009: Partly Cloudy, from 68 to 96
+ Monday, October 19 2009: Partly Cloudy, from 67 to 91
+ Tuesday, October 20 2009: Sunny, from 65 to 88
+ Wednesday, October 21 2009: Sunny, from 59 to 86
+ Thursday, October 22 2009: Sunny, from 58 to 87
+ Friday, October 23 2009: Sunny, from 60 to 8
+ mnservices[6]$
That's it.
diff --git a/doc/legal.txt b/doc/legal.txt
index 5835fb1..8406038 100644
--- a/doc/legal.txt
+++ b/doc/legal.txt
@@ -22,6 +22,6 @@ anonymous download but use of the service would require a paid subscription.
These web services are used for demonstration purposes only. If you
represent a company providing one of these services and object to its use in
this way, email the developer to have the service references removed. If
-you provide web services and would like to contribute to open source
-development and the promotion of web services by explicitly permitting this
-use, email the developer.
+you provide interesting web services and would like to contribute to open
+source development and the promotion of web services by explicitly
+permitting this use, email the developer.
diff --git a/doc/limitations.txt b/doc/limitations.txt
index de794d4..14efd97 100644
--- a/doc/limitations.txt
+++ b/doc/limitations.txt
@@ -69,7 +69,8 @@ Things That Don't Work
:api:`pyxb.binding.basis.complexTypeDefinition._validatedChildren` for a
work-around.
-* The redefine directive is not supported.
+* The `redefine directive <http://www.w3.org/TR/xmlschema-1/#modify-schema>`_
+ is not supported.
Things That Mostly Work, But They're Ugly
-----------------------------------------
diff --git a/doc/overview.txt b/doc/overview.txt
index b44928d..95a8b30 100644
--- a/doc/overview.txt
+++ b/doc/overview.txt
@@ -11,30 +11,4 @@ Overview
limitations
legal
vision
-
-================
-Related Packages
-================
-
-The following packages may be useful as an alternative to or used in
-conjunction with PyXB:
-
-- The `Zolera SOAP Infrastructure
- <http://pywebsvcs.sourceforge.net/zsi.html>`_ is the backbone of the
- `Python Web Services <http://pywebsvcs.sourceforge.net/>`_ project. It is
- specifically intended to support web service interaction with SOAP and
- WSDL. The primary purpose of ZSI is SOAP, but it generates bindings for
- some XML Schema constructs.
-
-- `generateDS <http://www.rexx.com/~dkuhlman/generateDS.html>`_ is an
- alternative package that is intended to do the same general thing as PyXB,
- though it uses a very different approach for extending bindings.
-
-- The `Amara XML Toolkit <http://xml3k.org/Amara>`_ appears to be a fairly
- complete set of XML tools for Python evolved from the `4Suite
- <http://4suite.org/>`_ infrastructure. Amara supports `binding an object
- to an existing XML document
- <http://xml3k.org/Amara2/Whatsnew#Creatingabinderydocumentfromscratch>`_
- and has references to `RELAX NG <http://relaxng.org/>`_ and `Schematron
- <http://www.schematron.com/>`_, but does not address `XML Schema
- <http://www.w3.org/XML/Schema>`_.
+ related
diff --git a/doc/overview_how.txt b/doc/overview_how.txt
index 2f979df..989007b 100644
--- a/doc/overview_how.txt
+++ b/doc/overview_how.txt
@@ -10,9 +10,11 @@ things the implementation relies on decorators (:PEP:`318`) like
regularly tested with the latest release in each of the 2.4, 2.5, and 2.6
series.
-If all you want is the ability to generate bindings for XML schemas, use the
-``PyXB-base`` release file. If you also want pre-built documentation, unpack
-the ``PyXB-doc`` release as well. For pre-built bundles, use the following:
+PyXB is distributed in several forms through `SourceForge
+<https://sourceforge.net/projects/pyxb/files/>`_. If all you want is the
+ability to generate bindings for XML schemas, use the ``PyXB-base`` release
+file. If you also want pre-built documentation, unpack the ``PyXB-doc``
+release as well. For pre-built bundles, use the following:
.. table:: Pre-built Bundle Distribution Files
diff --git a/doc/overview_what.txt b/doc/overview_what.txt
index 8fda3d3..2e69e6f 100644
--- a/doc/overview_what.txt
+++ b/doc/overview_what.txt
@@ -30,5 +30,7 @@ The major goals of PyXB are:
+ include and import directives
+ constraints on simple types
+* Validate the documents against their schema
+
Secondary goals, some of which have been achieved in the current release, are
listed in :ref:`pyxb_vision`.
diff --git a/doc/related.txt b/doc/related.txt
new file mode 100644
index 0000000..664b2d8
--- /dev/null
+++ b/doc/related.txt
@@ -0,0 +1,27 @@
+.. _pyxb_related:
+
+Related Packages
+================
+
+The following packages may be useful as an alternative to or used in
+conjunction with PyXB:
+
+- The `Zolera SOAP Infrastructure
+ <http://pywebsvcs.sourceforge.net/zsi.html>`_ is the backbone of the
+ `Python Web Services <http://pywebsvcs.sourceforge.net/>`_ project. It is
+ specifically intended to support web service interaction with SOAP and
+ WSDL. The primary purpose of ZSI is SOAP, but it generates bindings for
+ some XML Schema constructs.
+
+- `generateDS <http://www.rexx.com/~dkuhlman/generateDS.html>`_ is an
+ alternative package that is intended to do the same general thing as PyXB,
+ though it uses a very different approach for extending bindings.
+
+- The `Amara XML Toolkit <http://xml3k.org/Amara>`_ appears to be a fairly
+ complete set of XML tools for Python evolved from the `4Suite
+ <http://4suite.org/>`_ infrastructure. Amara supports `binding an object
+ to an existing XML document
+ <http://xml3k.org/Amara2/Whatsnew#Creatingabinderydocumentfromscratch>`_
+ and has references to `RELAX NG <http://relaxng.org/>`_ and `Schematron
+ <http://www.schematron.com/>`_, but does not address `XML Schema
+ <http://www.w3.org/XML/Schema>`_.
diff --git a/doc/releases.txt b/doc/releases.txt
index dfd371a..9acc330 100644
--- a/doc/releases.txt
+++ b/doc/releases.txt
@@ -34,12 +34,30 @@ Linux several years ago:
Releases in a beta series are intended for development of new applications
with functionality requirements that cannot be satisfied by the current
stable series. Users of beta series get increased functionality, but more
- pain.
+ pain. Evolution of a beta series stops upon release of the subsequent
+ stable series.
+
+1.0.x (Stable)
+==============
+
+1.0.0 (18 Oct 2009, rev 2060)
+-----------------------------
+
+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.
+ :ticket:`52`
+
+- Consistently validate instances created from documents no matter which
+ parser is used. :ticket:`53`
+
+- Support caching message references in WSDL SOAP faults. :ticket:`54`
0.7.x (Beta)
============
-0.7.3 (15 Sep 2009, rev 2008)
+0.7.3 (15 Sep 2009, rev 2050)
-----------------------------
A few bug fixes (one major), a couple new features, and separation of the
@@ -72,14 +90,14 @@ various components to allow a smaller distribution.
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. :ticket:`46`
+- References to QNames with absent namespaces in chameleon schema included
+ into schema with a target namespace could not be resolved. :ticket:`46`
- - Documentation content was not correctly sanitized for use within a Python
- docstring. :ticket:`45`.
+- Documentation content was not correctly sanitized for use within a Python
+ docstring. :ticket:`45`.
- - Elements with complex types with simple content that derived from string
- could not be marked as nil. :ticket:`48`
+- Elements with complex types with simple content that derived from string
+ could not be marked as nil. :ticket:`48`
0.7.1 (23 Aug 2009, rev 1968)
-----------------------------
diff --git a/doc/userref_usebind.txt b/doc/userref_usebind.txt
index fd3992b..0b0d466 100644
--- a/doc/userref_usebind.txt
+++ b/doc/userref_usebind.txt
@@ -101,6 +101,9 @@ the deeper elements of the purchase order:
.. literalinclude:: ../examples/manual/po4.xsd
+.. index::
+ single: BIND
+
In particular, there is no global ``item`` element that can be used to
create the individual items. For situations like this, we use
:api:`pyxb.BIND`: