Etusivu Tutki Apua
Kirjaudu sisään
jexelmans
/
drawio2py
Tarkkaile 2
Äänestä 1
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Puu: 7265d662de
Branchit Tagit
drawio2py
/
docs
/
_build
/
html
/
parser.html

parser.html 14 KB
Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9. 

  9.     <title>parser module &#8212; DrawioConvert 0.2 documentation</title>
    10. 

  10.     <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="_static/styles.css" />
    13. 

  13.     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    14. 

  14.     <script type="text/javascript" src="_static/jquery.js"></script>
    15. 

  15.     <script type="text/javascript" src="_static/underscore.js"></script>
    16. 

  16.     <script type="text/javascript" src="_static/doctools.js"></script>
    17. 

  17.     <script type="text/javascript" src="_static/language_data.js"></script>
    18. 

  18.     <link rel="index" title="Index" href="genindex.html" />
    19. 

  19.     <link rel="search" title="Search" href="search.html" /> 
    20. 

  20.   </head><body>
    21. 

  21.       <div class="header" role="banner"><h1 class="heading"><a href="index.html">
    22. 

  22.           <span>DrawioConvert 0.2 documentation</span></a></h1>
    23. 

  23.         <h2 class="heading"><span>parser module</span></h2>
    24. 

  24.       </div>
    25. 

  25.       <div class="topnav" role="navigation" aria-label="top navigation">
    26. 

  26.       
    27. 

  27.         <p>
    28. 

  28.         <a class="uplink" href="index.html">Contents</a>
    29. 

  29.         </p>
    30. 

  30. 

  31.       </div>
    32. 

  32.       <div class="content">
    33. 

  33.         
    34. 

  34.         
    35. 

  35.   <div class="section" id="module-parser">
    36. 

  36. <span id="parser-module"></span><h1>parser module<a class="headerlink" href="#module-parser" title="Permalink to this headline">¶</a></h1>
    37. 

  37. <p>Test</p>
    38. 

  38. <dl class="data">
    39. 

  39. <dt id="parser.IGNORE">
    40. 

  40. <code class="descclassname">parser.</code><code class="descname">IGNORE</code><em class="property"> = ['id', 'label', 'placeholders', 'class_name']</em><a class="headerlink" href="#parser.IGNORE" title="Permalink to this definition">¶</a></dt>
    41. 

  41. <dd><p>Properties to ignore when parsing.</p>
    42. 

  42. </dd></dl>
    43. 

  43. 

  44. <dl class="class">
    45. 

  45. <dt id="parser.Node">
    46. 

  46. <em class="property">class </em><code class="descclassname">parser.</code><code class="descname">Node</code><span class="sig-paren">(</span><em>id</em>, <em>class_name</em>, <em>properties</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node" title="Permalink to this definition">¶</a></dt>
    47. 

  47. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
    48. 

  48. <p>Identifies a node object, as found in drawio.
    49. 

  49. On one hand used for the individual components,
    50. 

  50. but on the other hand used as a “group” of multiple
    51. 

  51. nodes.</p>
    52. 

  52. <dl class="method">
    53. 

  53. <dt id="parser.Node.add_connection">
    54. 

  54. <code class="descname">add_connection</code><span class="sig-paren">(</span><em>source</em>, <em>target</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.add_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.add_connection" title="Permalink to this definition">¶</a></dt>
    55. 

  55. <dd></dd></dl>
    56. 

  56. 

  57. <dl class="method">
    58. 

  58. <dt id="parser.Node.add_input">
    59. 

  59. <code class="descname">add_input</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.add_input"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.add_input" title="Permalink to this definition">¶</a></dt>
    60. 

  60. <dd></dd></dl>
    61. 

  61. 

  62. <dl class="method">
    63. 

  63. <dt id="parser.Node.add_output">
    64. 

  64. <code class="descname">add_output</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.add_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.add_output" title="Permalink to this definition">¶</a></dt>
    65. 

  65. <dd></dd></dl>
    66. 

  66. 

  67. <dl class="method">
    68. 

  68. <dt id="parser.Node.get_connections">
    69. 

  69. <code class="descname">get_connections</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.get_connections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.get_connections" title="Permalink to this definition">¶</a></dt>
    70. 

  70. <dd></dd></dl>
    71. 

  71. 

  72. <dl class="method">
    73. 

  73. <dt id="parser.Node.get_inputs">
    74. 

  74. <code class="descname">get_inputs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.get_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.get_inputs" title="Permalink to this definition">¶</a></dt>
    75. 

  75. <dd></dd></dl>
    76. 

  76. 

  77. <dl class="method">
    78. 

  78. <dt id="parser.Node.get_outputs">
    79. 

  79. <code class="descname">get_outputs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.get_outputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.get_outputs" title="Permalink to this definition">¶</a></dt>
    80. 

  80. <dd></dd></dl>
    81. 

  81. 

  82. <dl class="method">
    83. 

  83. <dt id="parser.Node.get_properties_string">
    84. 

  84. <code class="descname">get_properties_string</code><span class="sig-paren">(</span><em>ignore=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.get_properties_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.get_properties_string" title="Permalink to this definition">¶</a></dt>
    85. 

  85. <dd></dd></dl>
    86. 

  86. 

  87. <dl class="method">
    88. 

  88. <dt id="parser.Node.is_empty">
    89. 

  89. <code class="descname">is_empty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Node.is_empty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Node.is_empty" title="Permalink to this definition">¶</a></dt>
    90. 

  90. <dd></dd></dl>
    91. 

  91. 

  92. </dd></dl>
    93. 

  93. 

  94. <dl class="class">
    95. 

  95. <dt id="parser.Page">
    96. 

  96. <em class="property">class </em><code class="descclassname">parser.</code><code class="descname">Page</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Page"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Page" title="Permalink to this definition">¶</a></dt>
    97. 

  97. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
    98. 

  98. <p>A single page in drawio. Contains multiple nodes.</p>
    99. 

  99. <dl class="method">
    100. 

  100. <dt id="parser.Page.add_import">
    101. 

  101. <code class="descname">add_import</code><span class="sig-paren">(</span><em>im</em>, <em>obj=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Page.add_import"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Page.add_import" title="Permalink to this definition">¶</a></dt>
    102. 

  102. <dd></dd></dl>
    103. 

  103. 

  104. <dl class="method">
    105. 

  105. <dt id="parser.Page.add_node">
    106. 

  106. <code class="descname">add_node</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Page.add_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Page.add_node" title="Permalink to this definition">¶</a></dt>
    107. 

  107. <dd></dd></dl>
    108. 

  108. 

  109. <dl class="method">
    110. 

  110. <dt id="parser.Page.get_imports">
    111. 

  111. <code class="descname">get_imports</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Page.get_imports"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Page.get_imports" title="Permalink to this definition">¶</a></dt>
    112. 

  112. <dd></dd></dl>
    113. 

  113. 

  114. <dl class="method">
    115. 

  115. <dt id="parser.Page.get_nodes">
    116. 

  116. <code class="descname">get_nodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Page.get_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Page.get_nodes" title="Permalink to this definition">¶</a></dt>
    117. 

  117. <dd></dd></dl>
    118. 

  118. 

  119. <dl class="method">
    120. 

  120. <dt id="parser.Page.get_sanitized_name">
    121. 

  121. <code class="descname">get_sanitized_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Page.get_sanitized_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Page.get_sanitized_name" title="Permalink to this definition">¶</a></dt>
    122. 

  122. <dd></dd></dl>
    123. 

  123. 

  124. </dd></dl>
    125. 

  125. 

  126. <dl class="exception">
    127. 

  127. <dt id="parser.ParseException">
    128. 

  128. <em class="property">exception </em><code class="descclassname">parser.</code><code class="descname">ParseException</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#ParseException"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.ParseException" title="Permalink to this definition">¶</a></dt>
    129. 

  129. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
    130. 

  130. <p>Semantic exceptions when parsing.</p>
    131. 

  131. </dd></dl>
    132. 

  132. 

  133. <dl class="class">
    134. 

  134. <dt id="parser.Parser">
    135. 

  135. <em class="property">class </em><code class="descclassname">parser.</code><code class="descname">Parser</code><span class="sig-paren">(</span><em>filename</em>, <em>setup</em>, <em>ignore_empty_nodes=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Parser" title="Permalink to this definition">¶</a></dt>
    136. 

  136. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
    137. 

  137. <p>The drawio parser.</p>
    138. 

  138. <dl class="method">
    139. 

  139. <dt id="parser.Parser.create_node">
    140. 

  140. <code class="descname">create_node</code><span class="sig-paren">(</span><em>root</em>, <em>attr</em>, <em>page</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Parser.create_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Parser.create_node" title="Permalink to this definition">¶</a></dt>
    141. 

  141. <dd></dd></dl>
    142. 

  142. 

  143. <dl class="staticmethod">
    144. 

  144. <dt id="parser.Parser.decode_and_deflate">
    145. 

  145. <em class="property">static </em><code class="descname">decode_and_deflate</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Parser.decode_and_deflate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Parser.decode_and_deflate" title="Permalink to this definition">¶</a></dt>
    146. 

  146. <dd><p>Draw.io compresses each page as follows:
    147. 

  147. First, all data is url-encoded
    148. 

  148. Next, it is compressed/deflated
    149. 

  149. Finally, it is encoded according to base64.</p>
    150. 

  150. <p>To obtain the page data, we have to do the reverse.</p>
    151. 

  151. <table class="docutils field-list" frame="void" rules="none">
    152. 

  152. <col class="field-name" />
    153. 

  153. <col class="field-body" />
    154. 

  154. <tbody valign="top">
    155. 

  155. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Uncompressed and decoded data as a string.</td>
    156. 

  156. </tr>
    157. 

  157. </tbody>
    158. 

  158. </table>
    159. 

  159. </dd></dl>
    160. 

  160. 

  161. <dl class="method">
    162. 

  162. <dt id="parser.Parser.parse">
    163. 

  163. <code class="descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Parser.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Parser.parse" title="Permalink to this definition">¶</a></dt>
    164. 

  164. <dd><p>Does the actual file parsing.</p>
    165. 

  165. <p>If the file is compressed, we uncompress and work from there.
    166. 

  166. If it wasn’t compressed, we can work with the whole tree.</p>
    167. 

  167. <table class="docutils field-list" frame="void" rules="none">
    168. 

  168. <col class="field-name" />
    169. 

  169. <col class="field-body" />
    170. 

  170. <tbody valign="top">
    171. 

  171. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A list of Node objects, representing the drawio file.</td>
    172. 

  172. </tr>
    173. 

  173. </tbody>
    174. 

  174. </table>
    175. 

  175. </dd></dl>
    176. 

  176. 

  177. <dl class="method">
    178. 

  178. <dt id="parser.Parser.parse_page">
    179. 

  179. <code class="descname">parse_page</code><span class="sig-paren">(</span><em>page</em>, <em>nroot</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#Parser.parse_page"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.Parser.parse_page" title="Permalink to this definition">¶</a></dt>
    180. 

  180. <dd><p>Parses a single page of the model.</p>
    181. 

  181. </dd></dl>
    182. 

  182. 

  183. </dd></dl>
    184. 

  184. 

  185. <dl class="function">
    186. 

  186. <dt id="parser.parse_environment">
    187. 

  187. <code class="descclassname">parser.</code><code class="descname">parse_environment</code><span class="sig-paren">(</span><em>vars</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parser.html#parse_environment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parser.parse_environment" title="Permalink to this definition">¶</a></dt>
    188. 

  188. <dd><p>Parses the set of environment variables, given with the
    189. 

  189. <code class="code docutils literal notranslate"><span class="pre">-E</span></code>/<code class="code docutils literal notranslate"><span class="pre">--environment</span></code> variable.</p>
    190. 

  190. </dd></dl>
    191. 

  191. 

  192. </div>
    193. 

  193. 

  194. 

  195.       </div>
    196. 

  196.       <div class="bottomnav" role="navigation" aria-label="bottom navigation">
    197. 

  197.       
    198. 

  198.         <p>
    199. 

  199.         <a class="uplink" href="index.html">Contents</a>
    200. 

  200.         </p>
    201. 

  201. 

  202.       </div>
    203. 

  203. 

  204.     <div class="footer" role="contentinfo">
    205. 

  205.         &#169; Copyright 2020, Randy Paredis.
    206. 

  206.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    207. 

  207.     </div>
    208. 

  208.   </body>
    209. 

  209. </html>
    210.