pythondoc-elementtree.SimpleXMLWriter.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  2. <html>
  3. <head>
  4. <meta http-equiv='Content-Type' content='text/html; charset=us-ascii' />
  5. <title>The elementtree.SimpleXMLWriter Module</title>
  6. <link rel='stylesheet' href='effbot.css' type='text/css' />
  7. </head>
  8. <body>
  9. <h1>The elementtree.SimpleXMLWriter Module</h1>
  10. <p>Tools to write XML files, without having to deal with encoding
  11. issues, well-formedness, etc.
  12. </p><p>
  13. The current version does not provide built-in support for
  14. namespaces. To create files using namespaces, you have to provide
  15. "xmlns" attributes and explicitly add prefixes to tags and
  16. attributes.
  17. <h3>Patterns</h3>
  18. The following example generates a small XHTML document.
  19. <pre>
  20. from elementtree.SimpleXMLWriter import XMLWriter
  21. import sys
  22. w = XMLWriter(sys.stdout)
  23. html = w.start("html")
  24. w.start("head")
  25. w.element("title", "my document")
  26. w.element("meta", name="generator", value="my application 1.0")
  27. w.end()
  28. w.start("body")
  29. w.element("h1", "this is a heading")
  30. w.element("p", "this is a paragraph")
  31. w.start("p")
  32. w.data("this is ")
  33. w.element("b", "bold")
  34. w.data(" and ")
  35. w.element("i", "italic")
  36. w.data(".")
  37. w.end("p")
  38. w.close(html)
  39. </pre>
  40. </p><h2>Module Contents</h2>
  41. <dl>
  42. <dt><b>XMLWriter(file, encoding=&quot;us-ascii&quot;)</b> (class) [<a href='#elementtree.SimpleXMLWriter.XMLWriter-class'>#</a>]</dt>
  43. <dd>
  44. <p>XML writer class.</p>
  45. <dl>
  46. <dt><i>file</i></dt>
  47. <dd>
  48. A file or file-like object. This object must implement
  49. a <b>write</b> method that takes an 8-bit string.
  50. </dd>
  51. <dt><i>encoding</i></dt>
  52. <dd>
  53. Optional encoding.</dd>
  54. </dl><br />
  55. <p>For more information about this class, see <a href='#elementtree.SimpleXMLWriter.XMLWriter-class'><i>The XMLWriter Class</i></a>.</p>
  56. </dd>
  57. </dl>
  58. <h2><a id='elementtree.SimpleXMLWriter.XMLWriter-class' name='elementtree.SimpleXMLWriter.XMLWriter-class'>The XMLWriter Class</a></h2>
  59. <dl>
  60. <dt><b>XMLWriter(file, encoding=&quot;us-ascii&quot;)</b> (class) [<a href='#elementtree.SimpleXMLWriter.XMLWriter-class'>#</a>]</dt>
  61. <dd>
  62. <p>XML writer class.</p>
  63. <dl>
  64. <dt><i>file</i></dt>
  65. <dd>
  66. A file or file-like object. This object must implement
  67. a <b>write</b> method that takes an 8-bit string.
  68. </dd>
  69. <dt><i>encoding</i></dt>
  70. <dd>
  71. Optional encoding.</dd>
  72. </dl><br />
  73. </dd>
  74. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.close-method' name='elementtree.SimpleXMLWriter.XMLWriter.close-method'><b>close(id)</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.close-method'>#</a>]</dt>
  75. <dd>
  76. <p>Closes open elements, up to (and including) the element identified
  77. by the given identifier.</p>
  78. <dl>
  79. <dt><i>id</i></dt>
  80. <dd>
  81. Element identifier, as returned by the <b>start</b> method.
  82. </dd>
  83. </dl><br />
  84. </dd>
  85. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.comment-method' name='elementtree.SimpleXMLWriter.XMLWriter.comment-method'><b>comment(comment)</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.comment-method'>#</a>]</dt>
  86. <dd>
  87. <p>Adds a comment to the output stream.</p>
  88. <dl>
  89. <dt><i>comment</i></dt>
  90. <dd>
  91. Comment text, as an 8-bit string or Unicode string.</dd>
  92. </dl><br />
  93. </dd>
  94. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.data-method' name='elementtree.SimpleXMLWriter.XMLWriter.data-method'><b>data(text)</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.data-method'>#</a>]</dt>
  95. <dd>
  96. <p>Adds character data to the output stream.</p>
  97. <dl>
  98. <dt><i>text</i></dt>
  99. <dd>
  100. Character data, as an 8-bit string or Unicode string.</dd>
  101. </dl><br />
  102. </dd>
  103. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.declaration-method' name='elementtree.SimpleXMLWriter.XMLWriter.declaration-method'><b>declaration()</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.declaration-method'>#</a>]</dt>
  104. <dd>
  105. <p>Writes an XML declaration.</p>
  106. </dd>
  107. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.element-method' name='elementtree.SimpleXMLWriter.XMLWriter.element-method'><b>element(tag, text=None, attrib={}, **extra)</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.element-method'>#</a>]</dt>
  108. <dd>
  109. <p>Adds an entire element. This is the same as calling <b>start</b>,
  110. <b>data</b>, and <b>end</b> in sequence. The <b>text</b> argument
  111. can be omitted.
  112. </p></dd>
  113. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.end-method' name='elementtree.SimpleXMLWriter.XMLWriter.end-method'><b>end(tag=None)</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.end-method'>#</a>]</dt>
  114. <dd>
  115. <p>Closes the current element (opened by the most recent call to
  116. <b>start</b>).
  117. </p><dl>
  118. <dt><i>tag</i></dt>
  119. <dd>
  120. Element tag. If given, the tag must match the start
  121. tag. If omitted, the current element is closed.</dd>
  122. </dl><br />
  123. </dd>
  124. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.flush-method' name='elementtree.SimpleXMLWriter.XMLWriter.flush-method'><b>flush()</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.flush-method'>#</a>]</dt>
  125. <dd>
  126. <p>Flushes the output stream.</p>
  127. </dd>
  128. <dt><a id='elementtree.SimpleXMLWriter.XMLWriter.start-method' name='elementtree.SimpleXMLWriter.XMLWriter.start-method'><b>start(tag, attrib={}, **extra)</b></a> [<a href='#elementtree.SimpleXMLWriter.XMLWriter.start-method'>#</a>]</dt>
  129. <dd>
  130. <p>Opens a new element. Attributes can be given as keyword
  131. arguments, or as a string/string dictionary. You can pass in
  132. 8-bit strings or Unicode strings; the former are assumed to use
  133. the encoding passed to the constructor. The method returns an
  134. opaque identifier that can be passed to the <b>close</b> method,
  135. to close all open elements up to and including this one.
  136. </p><dl>
  137. <dt><i>tag</i></dt>
  138. <dd>
  139. Element tag.</dd>
  140. <dt><i>attrib</i></dt>
  141. <dd>
  142. Attribute dictionary. Alternatively, attributes
  143. can be given as keyword arguments.</dd>
  144. <dt>Returns:</dt>
  145. <dd>
  146. An element identifier.</dd>
  147. </dl><br />
  148. </dd>
  149. </dl>
  150. </body></html>