Changeset 180 for Xml/xsd-fu/trunk/generateDS/generateDS.html
- Timestamp:
- 05/29/08 18:12:08 (6 months ago)
- Files:
-
- 1 modified
-
Xml/xsd-fu/trunk/generateDS/generateDS.html (modified) (53 diffs)
Legend:
- Unmodified
- Added
- Removed
-
Xml/xsd-fu/trunk/generateDS/generateDS.html
r112 r180 7 7 <title>generateDS -- Generate Data Structures from XML Schema</title> 8 8 <meta name="author" content="Dave Kuhlman" /> 9 <meta name="date" content=" Oct. 11, 2007" />9 <meta name="date" content="May 7, 2008" /> 10 10 <meta name="copyright" content="Copyright (c) 2004 Dave Kuhlman. This documentation and the software it describes is covered by The MIT License: http://www.opensource.org/licenses/mit-license." /> 11 11 <style type="text/css"> … … 192 192 </td></tr> 193 193 <tr><th class="docinfo-name">Revision:</th> 194 <td>1.1 1a</td></tr>194 <td>1.13a</td></tr> 195 195 <tr><th class="docinfo-name">Date:</th> 196 <td> Oct. 11, 2007</td></tr>196 <td>May 7, 2008</td></tr> 197 197 <tr><th class="docinfo-name">Copyright:</th> 198 198 <td>Copyright (c) 2004 Dave Kuhlman. This documentation … … 224 224 <li><a class="reference internal" href="#how-to-use-generateds-py" id="id11">4 How-to Use <tt class="docutils literal"><span class="pre">generateDS.py</span></tt></a><ul class="auto-toc"> 225 225 <li><a class="reference internal" href="#running-generateds-py" id="id12">4.1 Running <tt class="docutils literal"><span class="pre">generateDS.py</span></tt></a></li> 226 <li><a class="reference internal" href="#name-conf icts" id="id13">4.2 Name conficts</a><ul class="auto-toc">226 <li><a class="reference internal" href="#name-conflicts" id="id13">4.2 Name conflicts</a><ul class="auto-toc"> 227 227 <li><a class="reference internal" href="#conflicts-with-python-keywords" id="id14">4.2.1 Conflicts with Python keywords</a></li> 228 228 <li><a class="reference internal" href="#conflicts-between-child-elements-and-attributes" id="id15">4.2.2 Conflicts between child elements and attributes</a></li> 229 229 </ul> 230 230 </li> 231 <li><a class="reference internal" href="#supported-features-of-xml-schema" id="id16">4.3 Supported features of XML Schema</a><ul class="auto-toc"> 232 <li><a class="reference internal" href="#attributes-no-nested-children" id="id17">4.3.1 Attributes + no nested children</a></li> 233 <li><a class="reference internal" href="#mixed-content" id="id18">4.3.2 Mixed content</a></li> 234 <li><a class="reference internal" href="#anyattribute" id="id19">4.3.3 anyAttribute</a></li> 235 <li><a class="reference internal" href="#element-extensions" id="id20">4.3.4 Element extensions</a></li> 236 <li><a class="reference internal" href="#attribute-groups" id="id21">4.3.5 Attribute groups</a></li> 237 <li><a class="reference internal" href="#substitution-groups" id="id22">4.3.6 Substitution groups</a></li> 238 <li><a class="reference internal" href="#primitive-types" id="id23">4.3.7 Primitive types</a></li> 239 <li><a class="reference internal" href="#simpletype" id="id24">4.3.8 simpleType</a></li> 240 <li><a class="reference internal" href="#list-values-optional-values-maxoccurs-etc" id="id25">4.3.9 List values, optional values, maxOccurs, etc.</a></li> 241 <li><a class="reference internal" href="#simpletype-and-validators" id="id26">4.3.10 simpleType and validators</a></li> 242 </ul> 243 </li> 244 </ul> 245 </li> 246 <li><a class="reference internal" href="#the-xml-schema-input-to-generateds" id="id27">5 The XML Schema Input to generateDS</a><ul class="auto-toc"> 247 <li><a class="reference internal" href="#additional-constructions" id="id28">5.1 Additional constructions</a><ul class="auto-toc"> 248 <li><a class="reference internal" href="#complextype-at-top-level" id="id29">5.1.1 <complexType> at top-level</a></li> 249 <li><a class="reference internal" href="#use-of-ref-instead-of-name-and-type-attributes" id="id30">5.1.2 Use of "ref" instead of "name" and "type" attributes</a></li> 250 <li><a class="reference internal" href="#extension-types" id="id31">5.1.3 Extension types</a></li> 251 <li><a class="reference internal" href="#elements-containing-mixed-content" id="id32">5.1.4 Elements containing mixed content</a></li> 252 </ul> 253 </li> 254 </ul> 255 </li> 256 <li><a class="reference internal" href="#id1" id="id33">6 XMLBehaviors</a><ul class="auto-toc"> 257 <li><a class="reference internal" href="#the-xmlbehaviors-input-file" id="id34">6.1 The XMLBehaviors input file</a></li> 258 <li><a class="reference internal" href="#implementing-other-sources-for-implementation-bodies" id="id35">6.2 Implementing other sources for implementation bodies</a></li> 259 </ul> 260 </li> 261 <li><a class="reference internal" href="#additional-features" id="id36">7 Additional Features</a><ul class="auto-toc"> 262 <li><a class="reference internal" href="#xsd-list-element-support" id="id37">7.1 xsd:list element support</a></li> 263 <li><a class="reference internal" href="#xsd-enumeration-support" id="id38">7.2 xsd:enumeration support</a></li> 264 <li><a class="reference internal" href="#xsd-union-support" id="id39">7.3 xsd:union support</a></li> 265 <li><a class="reference internal" href="#extended-xsd-choice-support" id="id40">7.4 Extended xsd:choice support</a></li> 266 <li><a class="reference internal" href="#minoccurs-attribute-support" id="id41">7.5 minOccurs attribute support</a></li> 267 <li><a class="reference internal" href="#more-thorough-content-type-and-base-type-resolution" id="id42">7.6 More thorough content type and base type resolution</a></li> 268 <li><a class="reference internal" href="#making-top-level-simpletypes-available-from-xschemahandler" id="id43">7.7 Making top level simpleTypes available from XschemaHandler</a></li> 269 </ul> 270 </li> 271 <li><a class="reference internal" href="#how-to-use-the-generated-source-code" id="id44">8 How-to Use the Generated Source Code</a><ul class="auto-toc"> 272 <li><a class="reference internal" href="#the-parsing-functions" id="id45">8.1 The parsing functions</a></li> 273 <li><a class="reference internal" href="#the-export-methods" id="id46">8.2 The export methods</a><ul class="auto-toc"> 274 <li><a class="reference internal" href="#method-export" id="id47">8.2.1 Method export</a></li> 275 <li><a class="reference internal" href="#method-exportliteral" id="id48">8.2.2 Method <tt class="docutils literal"><span class="pre">exportLiteral</span></tt></a><ul class="auto-toc"> 276 <li><a class="reference internal" href="#what-it-does" id="id49">8.2.2.1 What It Does</a></li> 277 <li><a class="reference internal" href="#why-you-might-care" id="id50">8.2.2.2 Why You Might Care</a></li> 278 <li><a class="reference internal" href="#how-to-use-it" id="id51">8.2.2.3 How to use it</a></li> 279 </ul> 280 </li> 281 </ul> 282 </li> 283 <li><a class="reference internal" href="#building-instances" id="id52">8.3 Building instances</a></li> 284 <li><a class="reference internal" href="#using-the-subclass-module" id="id53">8.4 Using the subclass module</a></li> 285 <li><a class="reference internal" href="#elements-with-attributes-but-no-nested-children" id="id54">8.5 Elements with attributes but no nested children</a></li> 286 <li><a class="reference internal" href="#id3" id="id55">8.6 Mixed content</a></li> 287 <li><a class="reference internal" href="#id5" id="id56">8.7 anyAttribute</a></li> 288 <li><a class="reference internal" href="#user-methods" id="id57">8.8 User Methods</a></li> 289 </ul> 290 </li> 291 <li><a class="reference internal" href="#how-to-modify-the-generated-code" id="id58">9 How-to Modify the Generated Code</a><ul class="auto-toc"> 292 <li><a class="reference internal" href="#adding-features-to-class-definitions" id="id59">9.1 Adding features to class definitions</a></li> 293 </ul> 294 </li> 295 <li><a class="reference internal" href="#examples-and-demonstrations" id="id60">10 Examples and Demonstrations</a></li> 296 <li><a class="reference internal" href="#limitations-of-generateds" id="id61">11 Limitations of generateDS</a><ul class="auto-toc"> 297 <li><a class="reference internal" href="#xml-schema-limitations" id="id62">11.1 XML Schema limitations</a></li> 298 <li><a class="reference internal" href="#large-documents" id="id63">11.2 Large documents</a></li> 299 </ul> 300 </li> 301 <li><a class="reference internal" href="#includes-the-xml-schema-include-element" id="id64">12 Includes -- The XML Schema include element</a></li> 302 <li><a class="reference internal" href="#acknowledgment" id="id65">13 Acknowledgment</a></li> 303 <li><a class="reference internal" href="#see-also" id="id66">14 See Also</a></li> 231 </ul> 232 </li> 233 <li><a class="reference internal" href="#supported-features-of-xml-schema" id="id16">5 Supported features of XML Schema</a><ul class="auto-toc"> 234 <li><a class="reference internal" href="#attributes-no-nested-children" id="id17">5.1 Attributes + no nested children</a></li> 235 <li><a class="reference internal" href="#mixed-content" id="id18">5.2 Mixed content</a></li> 236 <li><a class="reference internal" href="#anyattribute" id="id19">5.3 anyAttribute</a></li> 237 <li><a class="reference internal" href="#element-extensions" id="id20">5.4 Element extensions</a></li> 238 <li><a class="reference internal" href="#attribute-groups" id="id21">5.5 Attribute groups</a></li> 239 <li><a class="reference internal" href="#substitution-groups" id="id22">5.6 Substitution groups</a></li> 240 <li><a class="reference internal" href="#primitive-types" id="id23">5.7 Primitive types</a></li> 241 <li><a class="reference internal" href="#simpletype" id="id24">5.8 simpleType</a></li> 242 <li><a class="reference internal" href="#list-values-optional-values-maxoccurs-etc" id="id25">5.9 List values, optional values, maxOccurs, etc.</a></li> 243 <li><a class="reference internal" href="#simpletype-and-validators" id="id26">5.10 simpleType and validators</a></li> 244 <li><a class="reference internal" href="#include-file-processing" id="id27">5.11 Include file processing</a></li> 245 </ul> 246 </li> 247 <li><a class="reference internal" href="#the-xml-schema-input-to-generateds" id="id28">6 The XML Schema Input to generateDS</a><ul class="auto-toc"> 248 <li><a class="reference internal" href="#additional-constructions" id="id29">6.1 Additional constructions</a><ul class="auto-toc"> 249 <li><a class="reference internal" href="#complextype-at-top-level" id="id30">6.1.1 <complexType> at top-level</a></li> 250 <li><a class="reference internal" href="#use-of-ref-instead-of-name-and-type-attributes" id="id31">6.1.2 Use of "ref" instead of "name" and "type" attributes</a></li> 251 <li><a class="reference internal" href="#extension-types" id="id32">6.1.3 Extension types</a></li> 252 <li><a class="reference internal" href="#elements-containing-mixed-content" id="id33">6.1.4 Elements containing mixed content</a></li> 253 </ul> 254 </li> 255 </ul> 256 </li> 257 <li><a class="reference internal" href="#id1" id="id34">7 XMLBehaviors</a><ul class="auto-toc"> 258 <li><a class="reference internal" href="#the-xmlbehaviors-input-file" id="id35">7.1 The XMLBehaviors input file</a></li> 259 <li><a class="reference internal" href="#implementing-other-sources-for-implementation-bodies" id="id36">7.2 Implementing other sources for implementation bodies</a></li> 260 </ul> 261 </li> 262 <li><a class="reference internal" href="#additional-features" id="id37">8 Additional Features</a><ul class="auto-toc"> 263 <li><a class="reference internal" href="#xsd-list-element-support" id="id38">8.1 xsd:list element support</a></li> 264 <li><a class="reference internal" href="#xsd-enumeration-support" id="id39">8.2 xsd:enumeration support</a></li> 265 <li><a class="reference internal" href="#xsd-union-support" id="id40">8.3 xsd:union support</a></li> 266 <li><a class="reference internal" href="#extended-xsd-choice-support" id="id41">8.4 Extended xsd:choice support</a></li> 267 <li><a class="reference internal" href="#minoccurs-attribute-support" id="id42">8.5 minOccurs attribute support</a></li> 268 <li><a class="reference internal" href="#more-thorough-content-type-and-base-type-resolution" id="id43">8.6 More thorough content type and base type resolution</a></li> 269 <li><a class="reference internal" href="#making-top-level-simpletypes-available-from-xschemahandler" id="id44">8.7 Making top level simpleTypes available from XschemaHandler</a></li> 270 </ul> 271 </li> 272 <li><a class="reference internal" href="#how-to-use-the-generated-source-code" id="id45">9 How-to Use the Generated Source Code</a><ul class="auto-toc"> 273 <li><a class="reference internal" href="#the-parsing-functions" id="id46">9.1 The parsing functions</a></li> 274 <li><a class="reference internal" href="#the-export-methods" id="id47">9.2 The export methods</a><ul class="auto-toc"> 275 <li><a class="reference internal" href="#method-export" id="id48">9.2.1 Method export</a></li> 276 <li><a class="reference internal" href="#method-exportliteral" id="id49">9.2.2 Method <tt class="docutils literal"><span class="pre">exportLiteral</span></tt></a><ul class="auto-toc"> 277 <li><a class="reference internal" href="#what-it-does" id="id50">9.2.2.1 What It Does</a></li> 278 <li><a class="reference internal" href="#why-you-might-care" id="id51">9.2.2.2 Why You Might Care</a></li> 279 <li><a class="reference internal" href="#how-to-use-it" id="id52">9.2.2.3 How to use it</a></li> 280 </ul> 281 </li> 282 </ul> 283 </li> 284 <li><a class="reference internal" href="#building-instances" id="id53">9.3 Building instances</a></li> 285 <li><a class="reference internal" href="#using-the-subclass-module" id="id54">9.4 Using the subclass module</a></li> 286 <li><a class="reference internal" href="#elements-with-attributes-but-no-nested-children" id="id55">9.5 Elements with attributes but no nested children</a></li> 287 <li><a class="reference internal" href="#id3" id="id56">9.6 Mixed content</a></li> 288 <li><a class="reference internal" href="#id5" id="id57">9.7 anyAttribute</a></li> 289 <li><a class="reference internal" href="#user-methods" id="id58">9.8 User Methods</a></li> 290 </ul> 291 </li> 292 <li><a class="reference internal" href="#how-to-modify-the-generated-code" id="id59">10 How-to Modify the Generated Code</a><ul class="auto-toc"> 293 <li><a class="reference internal" href="#adding-features-to-class-definitions" id="id60">10.1 Adding features to class definitions</a></li> 294 </ul> 295 </li> 296 <li><a class="reference internal" href="#examples-and-demonstrations" id="id61">11 Examples and Demonstrations</a></li> 297 <li><a class="reference internal" href="#sample-code-and-extensions" id="id62">12 Sample Code and Extensions</a><ul class="auto-toc"> 298 <li><a class="reference internal" href="#capturing-xs-date-elements-as-dates" id="id63">12.1 Capturing xs:date elements as dates</a></li> 299 </ul> 300 </li> 301 <li><a class="reference internal" href="#limitations-of-generateds" id="id64">13 Limitations of generateDS</a><ul class="auto-toc"> 302 <li><a class="reference internal" href="#xml-schema-limitations" id="id65">13.1 XML Schema limitations</a></li> 303 <li><a class="reference internal" href="#large-documents" id="id66">13.2 Large documents</a></li> 304 </ul> 305 </li> 306 <li><a class="reference internal" href="#includes-the-xml-schema-include-element" id="id67">14 Includes -- The XML Schema include element</a></li> 307 <li><a class="reference internal" href="#acknowledgment" id="id68">15 Acknowledgment</a></li> 308 <li><a class="reference internal" href="#see-also" id="id69">16 See Also</a></li> 304 309 </ul> 305 310 </div> … … 362 367 <h2><a class="toc-backref" href="#id8">2.1 Download</a></h2> 363 368 <p>You can find the distribution here: 364 <a class="reference external" href="http://www.rexx.com/~dkuhlman/generateDS-1.1 1a.tar.gz">http://www.rexx.com/~dkuhlman/generateDS-1.11a.tar.gz</a></p>369 <a class="reference external" href="http://www.rexx.com/~dkuhlman/generateDS-1.13a.tar.gz">http://www.rexx.com/~dkuhlman/generateDS-1.13a.tar.gz</a></p> 365 370 <p>It is also available at SourceForge: 366 371 <a class="reference external" href="http://sourceforge.net/projects/generateds/">http://sourceforge.net/projects/generateds/</a></p> … … 413 418 -s <subclassfilename> Output file name for subclasses 414 419 -p <prefix> Prefix string to be pre-pended to the class names 415 -n <mappingfilename> Transform names with table in mappingfilename.416 420 -f Force creation of output files. Do not ask. 417 421 -a <namespaceabbrev> Namespace abbreviation, e.g. "xsd:". … … 429 433 instead of get_var() and set_var(). 430 434 --user-methods= <module>, 431 -u <module 435 -u <module> Optional module containing user methods. See 432 436 section "User Methods" in the documentation. 437 --no-process-includes Do not process included XML Schema files. By 438 default, generateDS.py will insert content 439 from files referenced by <include ... /> 440 elements into the XML Schema to be processed. 433 441 </pre> 434 442 <p>The following command line flags are recognized by <tt class="docutils literal"><span class="pre">generateDS.py</span></tt>:</p> … … 524 532 classes as specified in the indicated module. For more 525 533 information, see section <a class="reference internal" href="#user-methods">User Methods</a>.</dd> 534 <dt>no-process-includes</dt> 535 <dd>Do not process included XML Schema files. By default, 536 generateDS.py will insert content from files referenced by 537 <tt class="docutils literal"><span class="pre"><include</span> <span class="pre">...</span> <span class="pre">/></span></tt> elements into the XML Schema to be processed. 538 See section <a class="reference internal" href="#include-file-processing">Include file processing</a>.</dd> 526 539 </dl> 527 540 </div> 528 <div class="section" id="name-conf icts">529 <h2><a class="toc-backref" href="#id13">4.2 Name conf icts</a></h2>541 <div class="section" id="name-conflicts"> 542 <h2><a class="toc-backref" href="#id13">4.2 Name conflicts</a></h2> 530 543 <div class="section" id="conflicts-with-python-keywords"> 531 544 <h3><a class="toc-backref" href="#id14">4.2.1 Conflicts with Python keywords</a></h3> … … 549 562 </div> 550 563 </div> 564 </div> 551 565 <div class="section" id="supported-features-of-xml-schema"> 552 <h 2><a class="toc-backref" href="#id16">4.3 Supported features of XML Schema</a></h2>566 <h1><a class="toc-backref" href="#id16">5 Supported features of XML Schema</a></h1> 553 567 <p>The following constructs in the XML Schema are supported:</p> 554 568 <ul class="simple"> … … 564 578 to generateDS</a>.</p> 565 579 <div class="section" id="attributes-no-nested-children"> 566 <h 3><a class="toc-backref" href="#id17">4.3.1 Attributes + no nested children</a></h3>580 <h2><a class="toc-backref" href="#id17">5.1 Attributes + no nested children</a></h2> 567 581 <p>Element definitions that contain attributes but <em>no</em> nested child 568 582 elements provide access to their data content through getter and … … 571 585 </div> 572 586 <div class="section" id="mixed-content"> 573 <h 3><a class="toc-backref" href="#id18">4.3.2 Mixed content</a></h3>587 <h2><a class="toc-backref" href="#id18">5.2 Mixed content</a></h2> 574 588 <p>Elements that are defined to contain both text and nested child 575 589 elements have "mixed content". <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> provides access … … 584 598 </div> 585 599 <div class="section" id="anyattribute"> 586 <h 3><a class="toc-backref" href="#id19">4.3.3 anyAttribute</a></h3>600 <h2><a class="toc-backref" href="#id19">5.3 anyAttribute</a></h2> 587 601 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> supports <tt class="docutils literal"><span class="pre">anyAttribute</span></tt>. For example, if an 588 602 element is defined as follows:</p> … … 604 618 </div> 605 619 <div class="section" id="element-extensions"> 606 <h 3><a class="toc-backref" href="#id20">4.3.4 Element extensions</a></h3>620 <h2><a class="toc-backref" href="#id20">5.4 Element extensions</a></h2> 607 621 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> now generates subclasses for extensions, that is 608 622 when an element definition contains something like this:</p> … … 623 637 </div> 624 638 <div class="section" id="attribute-groups"> 625 <h 3><a class="toc-backref" href="#id21">4.3.5 Attribute groups</a></h3>639 <h2><a class="toc-backref" href="#id21">5.5 Attribute groups</a></h2> 626 640 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> now handles definition and use of attribute 627 641 groups. For example: the use of something like the following:</p> … … 645 659 </div> 646 660 <div class="section" id="substitution-groups"> 647 <h 3><a class="toc-backref" href="#id22">4.3.6 Substitution groups</a></h3>661 <h2><a class="toc-backref" href="#id22">5.6 Substitution groups</a></h2> 648 662 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> now handles a limited range of substitution 649 663 groups, but, there is an important <strong>limitation</strong>, in particular … … 656 670 </div> 657 671 <div class="section" id="primitive-types"> 658 <h 3><a class="toc-backref" href="#id23">4.3.7 Primitive types</a></h3>672 <h2><a class="toc-backref" href="#id23">5.7 Primitive types</a></h2> 659 673 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> supports some, but not all, simple types defined 660 674 in "XML Schema Part 0: Primer Second Edition" ( … … 683 697 </div> 684 698 <div class="section" id="simpletype"> 685 <h 3><a class="toc-backref" href="#id24">4.3.8 simpleType</a></h3>699 <h2><a class="toc-backref" href="#id24">5.8 simpleType</a></h2> 686 700 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> generates minimal support for members defined as 687 701 <tt class="docutils literal"><span class="pre">simpleType</span></tt>. However, the code generated by <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> 688 does <strong>not</strong> enforce res criptions. For notes on how to enforce702 does <strong>not</strong> enforce restrictions. For notes on how to enforce 689 703 restrictions, see section <a class="reference internal" href="#simpletype-and-validators">simpleType and validators</a>.</p> 690 704 <p>A <tt class="docutils literal"><span class="pre">simpleType</span></tt> can be a restriction on a primitive type or on a … … 722 736 </div> 723 737 <div class="section" id="list-values-optional-values-maxoccurs-etc"> 724 <h 3><a class="toc-backref" href="#id25">4.3.9 List values, optional values, maxOccurs, etc.</a></h3>738 <h2><a class="toc-backref" href="#id25">5.9 List values, optional values, maxOccurs, etc.</a></h2> 725 739 <p>For elements defined with <tt class="docutils literal"><span class="pre">maxOccurs="unbounded"</span></tt>, 726 740 <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> generates code that processes a list of elements.</p> … … 730 744 </div> 731 745 <div class="section" id="simpletype-and-validators"> 732 <h 3><a class="toc-backref" href="#id26">4.3.10 simpleType and validators</a></h3>746 <h2><a class="toc-backref" href="#id26">5.10 simpleType and validators</a></h2> 733 747 <p>Here are a few notes that should help you use validator methods to 734 748 enforce restrictions.</p> … … 843 857 </ul> 844 858 </div> 859 <div class="section" id="include-file-processing"> 860 <h2><a class="toc-backref" href="#id27">5.11 Include file processing</a></h2> 861 <p>By default, generateDS.py will insert content from files referenced by 862 <tt class="docutils literal"><span class="pre">include</span></tt> elements into the XML Schema to be processed. This 863 behavior can be turned off by using the <tt class="docutils literal"><span class="pre">--no-process-includes</span></tt> 864 command line flag.</p> 865 <p><tt class="docutils literal"><span class="pre">include</span></tt> elements are processed and the referenced content is 866 inserted in the XML Schema by importing and using 867 <tt class="docutils literal"><span class="pre">process_includes.py</span></tt>, which is included in the <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> 868 distribution.</p> 869 <p><tt class="docutils literal"><span class="pre">process_includes.py</span></tt> will use either <tt class="docutils literal"><span class="pre">lxml</span></tt> or <tt class="docutils literal"><span class="pre">ElementTree</span></tt>, 870 but its preference is <tt class="docutils literal"><span class="pre">lxml</span></tt> because <tt class="docutils literal"><span class="pre">lxml</span></tt> attempts to preserve 871 namespace prefixes. So if your XML Schemas have <tt class="docutils literal"><span class="pre"><include</span> <span class="pre">...</span> <span class="pre">/></span></tt> 872 elements in them, you might want to consider installing <tt class="docutils literal"><span class="pre">lxml</span></tt>, even 873 though <tt class="docutils literal"><span class="pre">ElementTree</span></tt> is in the Python standard library for Python 874 versions >= 2.5.</p> 845 875 </div> 846 876 </div> 847 877 <div class="section" id="the-xml-schema-input-to-generateds"> 848 <h1><a class="toc-backref" href="#id2 7">5 The XML Schema Input to generateDS</a></h1>878 <h1><a class="toc-backref" href="#id28">6 The XML Schema Input to generateDS</a></h1> 849 879 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> actually accepts a subset of XML Schema. 850 880 The sample XML Schema file should give you a picture of how to … … 959 989 </ul> 960 990 <div class="section" id="additional-constructions"> 961 <h2><a class="toc-backref" href="#id2 8">5.1 Additional constructions</a></h2>991 <h2><a class="toc-backref" href="#id29">6.1 Additional constructions</a></h2> 962 992 <p>Here are a few additional constructions that <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> 963 993 understands.</p> 964 994 <div class="section" id="complextype-at-top-level"> 965 <h3><a class="toc-backref" href="#id 29">5.1.1 <complexType> at top-level</a></h3>995 <h3><a class="toc-backref" href="#id30">6.1.1 <complexType> at top-level</a></h3> 966 996 <p>You can use the <complexType> element at top level (instead of 967 997 <element>) to define an element. So, for example, instead of:</p> … … 987 1017 </div> 988 1018 <div class="section" id="use-of-ref-instead-of-name-and-type-attributes"> 989 <h3><a class="toc-backref" href="#id3 0">5.1.2 Use of "ref" instead of "name" and "type" attributes</a></h3>1019 <h3><a class="toc-backref" href="#id31">6.1.2 Use of "ref" instead of "name" and "type" attributes</a></h3> 990 1020 <p>You can use the "ref" attribute to refer to another element 991 1021 definition, instead of using the "name" and "type" attributes. So, … … 1012 1042 </div> 1013 1043 <div class="section" id="extension-types"> 1014 <h3><a class="toc-backref" href="#id3 1">5.1.3 Extension types</a></h3>1044 <h3><a class="toc-backref" href="#id32">6.1.3 Extension types</a></h3> 1015 1045 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> generates a subclass for each element that that 1016 1046 is defined as the extension of a base element. So, for the … … 1034 1064 </div> 1035 1065 <div class="section" id="elements-containing-mixed-content"> 1036 <h3><a class="toc-backref" href="#id3 2">5.1.4 Elements containing mixed content</a></h3>1066 <h3><a class="toc-backref" href="#id33">6.1.4 Elements containing mixed content</a></h3> 1037 1067 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> generates special code to handle elements 1038 1068 defined as containing mixed content, that is elements defined with … … 1043 1073 </div> 1044 1074 <div class="section" id="id1"> 1045 <span id="xmlbehaviors"></span><h1><a class="toc-backref" href="#id3 3">6 XMLBehaviors</a></h1>1075 <span id="xmlbehaviors"></span><h1><a class="toc-backref" href="#id34">7 XMLBehaviors</a></h1> 1046 1076 <p>With the use of the "-b" command line flag, <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> will 1047 1077 also accept as input an XML document instance that describes … … 1055 1085 our application development project for Quixote.</p> 1056 1086 <div class="section" id="the-xmlbehaviors-input-file"> 1057 <h2><a class="toc-backref" href="#id3 4">6.1 The XMLBehaviors input file</a></h2>1087 <h2><a class="toc-backref" href="#id35">7.1 The XMLBehaviors input file</a></h2> 1058 1088 <p>This section describes the XMLBehavior XML document that is used 1059 1089 as input to <tt class="docutils literal"><span class="pre">generateDS.py</span></tt>. The XMLBehavior XML document is an … … 1128 1158 </div> 1129 1159 <div class="section" id="implementing-other-sources-for-implementation-bodies"> 1130 <h2><a class="toc-backref" href="#id3 5">6.2 Implementing other sources for implementation bodies</a></h2>1160 <h2><a class="toc-backref" href="#id36">7.2 Implementing other sources for implementation bodies</a></h2> 1131 1161 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> contains a function <tt class="docutils literal"><span class="pre">get_impl_body()</span></tt> that 1132 1162 implements the ability to retrieve implementation bodies. The … … 1169 1199 </div> 1170 1200 <div class="section" id="additional-features"> 1171 <h1><a class="toc-backref" href="#id3 6">7 Additional Features</a></h1>1201 <h1><a class="toc-backref" href="#id37">8 Additional Features</a></h1> 1172 1202 <p>Here are additional features, contributed by users such as Chris 1173 1203 Allan. Many thanks.</p> 1174 1204 <div class="section" id="xsd-list-element-support"> 1175 <h2><a class="toc-backref" href="#id3 7">7.1 xsd:list element support</a></h2>1205 <h2><a class="toc-backref" href="#id38">8.1 xsd:list element support</a></h2> 1176 1206 <p>xsd:list elements can be used with a child xsd:simpleType which 1177 1207 confuses the XschemaHandler stack unrolling. xsd:list element … … 1191 1221 </div> 1192 1222 <div class="section" id="xsd-enumeration-support"> 1193 <h2><a class="toc-backref" href="#id3 8">7.2 xsd:enumeration support</a></h2>1223 <h2><a class="toc-backref" href="#id39">8.2 xsd:enumeration support</a></h2> 1194 1224 <p>The enumerated values for the parent element are resolved and made 1195 1225 available through the instance attribute <tt class="docutils literal"><span class="pre">values</span></tt>.</p> 1196 1226 </div> 1197 1227 <div class="section" id="xsd-union-support"> 1198 <h2><a class="toc-backref" href="#id 39">7.3 xsd:union support</a></h2>1228 <h2><a class="toc-backref" href="#id40">8.3 xsd:union support</a></h2> 1199 1229 <p>In order to properly resolve and query types which are unions in 1200 1230 an XML Schema, an element's membership in an xsd:union is … … 1202 1232 </div> 1203 1233 <div class="section" id="extended-xsd-choice-support"> 1204 <h2><a class="toc-backref" href="#id4 0">7.4 Extended xsd:choice support</a></h2>1234 <h2><a class="toc-backref" href="#id41">8.4 Extended xsd:choice support</a></h2> 1205 1235 <p>When a parent xsd:choice is exists, an element's "maxOccurs" and 1206 1236 "minOccurs" values can be inherited from the xsd:choice rather … … 1222 1252 </div> 1223 1253 <div class="section" id="minoccurs-attribute-support"> 1224 <h2><a class="toc-backref" href="#id4 1">7.5 minOccurs attribute support</a></h2>1254 <h2><a class="toc-backref" href="#id42">8.5 minOccurs attribute support</a></h2> 1225 1255 <p>Some applications require the availability of the "minOccurs" 1226 1256 attribute in addition to the previous minimal support of … … 1229 1259 </div> 1230 1260 <div class="section" id="more-thorough-content-type-and-base-type-resolution"> 1231 <h2><a class="toc-backref" href="#id4 2">7.6 More thorough content type and base type resolution</a></h2>1261 <h2><a class="toc-backref" href="#id43">8.6 More thorough content type and base type resolution</a></h2> 1232 1262 <p>The previous content type and base type resolution is insufficient 1233 1263 for some needs. Basically it was unable to handle more complex … … 1242 1272 </div> 1243 1273 <div class="section" id="making-top-level-simpletypes-available-from-xschemahandler"> 1244 <h2><a class="toc-backref" href="#id4 3">7.7 Making top level simpleTypes available from XschemaHandler</a></h2>1274 <h2><a class="toc-backref" href="#id44">8.7 Making top level simpleTypes available from XschemaHandler</a></h2> 1245 1275 <p>Some developers working to extend the analysis and code generation 1246 1276 in <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> may be helped by additional information … … 1254 1284 </div> 1255 1285 <div class="section" id="how-to-use-the-generated-source-code"> 1256 <h1><a class="toc-backref" href="#id4 4">8 How-to Use the Generated Source Code</a></h1>1286 <h1><a class="toc-backref" href="#id45">9 How-to Use the Generated Source Code</a></h1> 1257 1287 <div class="section" id="the-parsing-functions"> 1258 <h2><a class="toc-backref" href="#id4 5">8.1 The parsing functions</a></h2>1288 <h2><a class="toc-backref" href="#id46">9.1 The parsing functions</a></h2> 1259 1289 <p>The simplest use is to call one of the parsing functions in the 1260 1290 generated source file. You may be able to use one of these … … 1282 1312 </div> 1283 1313 <div class="section" id="the-export-methods"> 1284 <h2><a class="toc-backref" href="#id4 6">8.2 The export methods</a></h2>1314 <h2><a class="toc-backref" href="#id47">9.2 The export methods</a></h2> 1285 1315 <p>The generated classes contain methods <tt class="docutils literal"><span class="pre">export</span></tt> and 1286 1316 <tt class="docutils literal"><span class="pre">exportLiteral</span></tt> which can be called to export classes to several … … 1289 1319 functions for examples showing how to call the export methods.</p> 1290 1320 <div class="section" id="method-export"> 1291 <h3><a class="toc-backref" href="#id4 7">8.2.1 Method export</a></h3>1321 <h3><a class="toc-backref" href="#id48">9.2.1 Method export</a></h3> 1292 1322 <p>The export method in generated classes writes out an XML document 1293 1323 that represents the instance that contains it and its child … … 1298 1328 </div> 1299 1329 <div class="section" id="method-exportliteral"> 1300 <h3><a class="toc-backref" href="#id4 8">8.2.2 Method <tt class="docutils literal"><span class="pre">exportLiteral</span></tt></a></h3>1330 <h3><a class="toc-backref" href="#id49">9.2.2 Method <tt class="docutils literal"><span class="pre">exportLiteral</span></tt></a></h3> 1301 1331 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> generates Python classes that represent the 1302 1332 elements in an XML document, given an Xschema definition of the … … 1305 1335 classes that represent an XML document.</p> 1306 1336 <div class="section" id="what-it-does"> 1307 <h4><a class="toc-backref" href="#id 49">8.2.2.1 What It Does</a></h4>1337 <h4><a class="toc-backref" href="#id50">9.2.2.1 What It Does</a></h4> 1308 1338 <p>When <tt class="docutils literal"><span class="pre">generateDS.py</span></tt> generates the Python source code for your 1309 1339 classes, this new feature also generates an <tt class="docutils literal"><span class="pre">exportLiteral</span></tt> … … 1319 1349 </div> 1320 1350 <div class="section" id="why-you-might-care"> 1321 <h4><a class="toc-backref" href="#id5 0">8.2.2.2 Why You Might Care</a></h4>1351 <h4><a class="toc-backref" href="#id51">9.2.2.2 Why You Might Care</a></h4> 1322 1352 <p><tt class="docutils literal"><span class="pre">generateDS.py</span></tt> was designed and built with the assumption that 1323 1353 we are <em>not</em> interested in marking up text content at all. What