PageRenderTime 267ms CodeModel.GetById 33ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/html/_modules/replacekey.html

https://gitlab.com/montanari/replacekey
HTML | 391 lines | 314 code | 77 blank | 0 comment | 0 complexity | 343e08eb7078d15a4696a322090230dd MD5 | raw file
    

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

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

  3. 

  4. 

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

  6.   <head>
    7. 

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

  8.     
    9. 

  9.     <title>replacekey &mdash; replacekey 0.3 documentation</title>
    10. 

  10.     
    11. 

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

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

  13.     
    14. 

  14.     <script type="text/javascript">
    15. 

  15.       var DOCUMENTATION_OPTIONS = {
    16. 

  16.         URL_ROOT:    '../',
    17. 

  17.         VERSION:     '0.3',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

  23.     <script type="text/javascript" src="../_static/jquery.js"></script>
    24. 

  24.     <script type="text/javascript" src="../_static/underscore.js"></script>
    25. 

  25.     <script type="text/javascript" src="../_static/doctools.js"></script>
    26. 

  26.     <link rel="top" title="replacekey 0.3 documentation" href="../index.html" />
    27. 

  27.     <link rel="up" title="Module code" href="index.html" />
    28. 

  28.    
    29. 

  29.   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
    30. 

  30.   
    31. 

  31.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    32. 

  32. 

  33.   </head>
    34. 

  34.   <body role="document">
    35. 

  35.   
    36. 

  36. 

  37.     <div class="document">
    38. 

  38.       <div class="documentwrapper">
    39. 

  39.         <div class="bodywrapper">
    40. 

  40.           <div class="body" role="main">
    41. 

  41.             
    42. 

  42.   <h1>Source code for replacekey</h1><div class="highlight"><pre>
    43. 

  43. <span></span><span class="sd">&quot;&quot;&quot;Replace key expressions by templates.</span>
    44. 

  44. 

  45. <span class="sd">   Copyright (C) 2016-2017 Francesco Montanari.</span>
    46. 

  46. 

  47. <span class="sd">   This file is part of replacekey.</span>
    48. 

  48. 

  49. <span class="sd">   This program is free software: you can redistribute it and/or modify</span>
    50. 

  50. <span class="sd">   it under the terms of the GNU General Public License as published by</span>
    51. 

  51. <span class="sd">   the Free Software Foundation, either version 3 of the License, or</span>
    52. 

  52. <span class="sd">   (at your option) any later version.</span>
    53. 

  53. 

  54. <span class="sd">   This program is distributed in the hope that it will be useful,</span>
    55. 

  55. <span class="sd">   but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
    56. 

  56. <span class="sd">   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
    57. 

  57. <span class="sd">   GNU General Public License for more details.</span>
    58. 

  58. 

  59. <span class="sd">   You should have received a copy of the GNU General Public License</span>
    60. 

  60. <span class="sd">   along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
    61. 

  61. <span class="sd">&quot;&quot;&quot;</span>
    62. 

  62. 

  63. 

  64. <span class="kn">import</span> <span class="nn">os</span>
    65. 

  65. <span class="kn">import</span> <span class="nn">re</span>
    66. 

  66. <span class="kn">import</span> <span class="nn">argparse</span>
    67. 

  67. <span class="kn">import</span> <span class="nn">warnings</span>
    68. 

  68. 

  69. 

  70. <div class="viewcode-block" id="ReplaceKey"><a class="viewcode-back" href="../replacekey.html#replacekey.ReplaceKey">[docs]</a><span class="k">class</span> <span class="nc">ReplaceKey</span><span class="p">:</span>
    71. 

  71.     <span class="sd">&quot;&quot;&quot;</span>
    72. 

  72. <span class="sd">    Parse recursively files under a directory, or a single file.  Scan</span>
    73. 

  73. <span class="sd">    files of a given extension and containing specific key expressions</span>
    74. 

  74. <span class="sd">    in the form `{{key_label}}`.  Replace these keys by the content</span>
    75. 

  75. <span class="sd">    set in respective files under a `keys/` directory.  Templates</span>
    76. 

  76. <span class="sd">    under this directory must be in the form `key_label.extension`.</span>
    77. 

  77. <span class="sd">    The default keys and extension can be changed in the `__init__`</span>
    78. 

  78. <span class="sd">    below.</span>
    79. 

  79. 

  80. <span class="sd">    Parameters</span>
    81. 

  81. <span class="sd">    ----------</span>
    82. 

  82. <span class="sd">    recursive : bool</span>
    83. 

  83. <span class="sd">        If True parse and replace the files recursively. Set to</span>
    84. 

  84. <span class="sd">        False otherwise.</span>
    85. 

  85. <span class="sd">    pathin : str</span>
    86. 

  86. <span class="sd">        Existing directory of files, or file containing the keys</span>
    87. 

  87. <span class="sd">        to be replaced.</span>
    88. 

  88. <span class="sd">    pathout : str</span>
    89. 

  89. <span class="sd">        Output directory, or file. The keys are replaced by the</span>
    90. 

  90. <span class="sd">        content set in the corresponding files under the `keys/`</span>
    91. 

  91. <span class="sd">        directory.  If the output (sub)directory does not exists,</span>
    92. 

  92. <span class="sd">        it will be created.</span>
    93. 

  93. <span class="sd">    dir_keys : list or None</span>
    94. 

  94. <span class="sd">        Optional. Path to directory containing key files. If `None`,</span>
    95. 

  95. <span class="sd">        use default directory.</span>
    96. 

  96. <span class="sd">    extension : str or None</span>
    97. 

  97. <span class="sd">        Optional. Extension of the files to parse. Assume that the</span>
    98. 

  98. <span class="sd">        keys files have the same extension. If `None`, use default</span>
    99. 

  99. <span class="sd">        extension `html`.</span>
    100. 

  100. 

  101. <span class="sd">    Returns</span>
    102. 

  102. <span class="sd">    -------</span>
    103. 

  103. <span class="sd">     :</span>
    104. 

  104. <span class="sd">        Each file with the given extension under the `pathin` directory is</span>
    105. 

  105. <span class="sd">        saved under the `pathout`. The keys are replaced by the respective</span>
    106. 

  106. <span class="sd">        content.</span>
    107. 

  107. <span class="sd">    &quot;&quot;&quot;</span>
    108. 

  108. 

  109. 

  110.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    111. 

  111.                  <span class="n">recursive</span><span class="p">,</span>
    112. 

  112.                  <span class="n">pathin</span><span class="p">,</span>
    113. 

  113.                  <span class="n">pathout</span><span class="p">,</span>
    114. 

  114.                  <span class="n">dir_keys</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
    115. 

  115.                  <span class="n">extension</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
    116. 

  116.                  <span class="n">verbose</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
    117. 

  117.         <span class="sd">&quot;&quot;&quot;Initialize and coordinate the execution of the class methods.&quot;&quot;&quot;</span>
    118. 

  118.         <span class="bp">self</span><span class="o">.</span><span class="n">recursive</span> <span class="o">=</span> <span class="n">recursive</span>
    119. 

  119.         <span class="bp">self</span><span class="o">.</span><span class="n">pathin</span> <span class="o">=</span> <span class="n">pathin</span>
    120. 

  120.         <span class="bp">self</span><span class="o">.</span><span class="n">pathout</span> <span class="o">=</span> <span class="n">pathout</span>
    121. 

  121.         <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span> <span class="o">=</span> <span class="n">verbose</span>
    122. 

  122. 

  123.         <span class="k">if</span> <span class="n">extension</span><span class="p">:</span>
    124. 

  124.             <span class="bp">self</span><span class="o">.</span><span class="n">extension</span> <span class="o">=</span> <span class="n">extension</span>
    125. 

  125.         <span class="k">else</span><span class="p">:</span>
    126. 

  126.             <span class="bp">self</span><span class="o">.</span><span class="n">extension</span> <span class="o">=</span> <span class="s1">&#39;html&#39;</span>
    127. 

  127. 

  128.         <span class="k">if</span> <span class="n">dir_keys</span><span class="p">:</span>
    129. 

  129.             <span class="bp">self</span><span class="o">.</span><span class="n">pathkey</span> <span class="o">=</span> <span class="n">dir_keys</span>
    130. 

  130.         <span class="k">else</span><span class="p">:</span>
    131. 

  131.             <span class="bp">self</span><span class="o">.</span><span class="n">_setPathkey</span><span class="p">(</span><span class="s1">&#39;keys/&#39;</span><span class="p">)</span>
    132. 

  132. 

  133.         <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pathkey</span><span class="p">):</span>
    134. 

  134.             <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> directory not found&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">pathkey</span><span class="p">)</span>
    135. 

  135.             <span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    136. 

  136. 

  137.         <span class="bp">self</span><span class="o">.</span><span class="n">_setKeys</span><span class="p">()</span> <span class="c1"># Define self.keys</span>
    138. 

  138. 

  139.         <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pathin</span><span class="p">):</span>
    140. 

  140.             <span class="bp">self</span><span class="o">.</span><span class="n">saveKeyDir</span><span class="p">()</span>
    141. 

  141.         <span class="k">else</span><span class="p">:</span>
    142. 

  142.             <span class="bp">self</span><span class="o">.</span><span class="n">saveKeyFile</span><span class="p">()</span>
    143. 

  143. 

  144. 

  145.     <span class="k">def</span> <span class="nf">_setPathkey</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dir_keys</span><span class="p">):</span>
    146. 

  146.         <span class="sd">&quot;&quot;&quot;Set the keys directory path to the one provided under the</span>
    147. 

  147. <span class="sd">        installed module</span>
    148. 

  148. <span class="sd">        &quot;&quot;&quot;</span>
    149. 

  149.         <span class="k">try</span><span class="p">:</span>
    150. 

  150.             <span class="kn">import</span> <span class="nn">replacekey</span>
    151. 

  151.             <span class="n">module_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">replacekey</span><span class="o">.</span><span class="vm">__file__</span><span class="p">)</span>
    152. 

  152.             <span class="bp">self</span><span class="o">.</span><span class="n">pathkey</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">module_dir</span><span class="p">,</span> <span class="n">dir_keys</span><span class="p">)</span>
    153. 

  153. 

  154.         <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    155. 

  155.             <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;replacekey module not installed. Assuming that &quot;</span>
    156. 

  156.                    <span class="s2">&quot;replacekey.py is executed as __main__.&quot;</span><span class="p">)</span>
    157. 

  157.             <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="ne">ImportWarning</span><span class="p">)</span>
    158. 

  158. 

  159.             <span class="n">this_dir</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span>
    160. 

  160.             <span class="bp">self</span><span class="o">.</span><span class="n">pathkey</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">this_dir</span><span class="p">,</span> <span class="n">dir_keys</span><span class="p">)</span>
    161. 

  161. 

  162. 

  163.     <span class="k">def</span> <span class="nf">_setKeys</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    164. 

  164.         <span class="sd">&quot;&quot;&quot;Keys labels are automatically set according to the file</span>
    165. 

  165. <span class="sd">        names under the keys directory.</span>
    166. 

  166. <span class="sd">        &quot;&quot;&quot;</span>
    167. 

  167.         <span class="bp">self</span><span class="o">.</span><span class="n">keys</span> <span class="o">=</span> <span class="p">[]</span>
    168. 

  168.         <span class="k">for</span> <span class="n">_root</span><span class="p">,</span> <span class="n">_dirs</span><span class="p">,</span> <span class="n">filenames</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pathkey</span><span class="p">,</span> <span class="n">topdown</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
    169. 

  169.             <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">filenames</span><span class="p">:</span>
    170. 

  170.                 <span class="k">if</span> <span class="n">filename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extension</span><span class="p">):</span>
    171. 

  171.                     <span class="n">key</span><span class="p">,</span> <span class="n">_ext</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
    172. 

  172.                     <span class="bp">self</span><span class="o">.</span><span class="n">keys</span> <span class="o">+=</span> <span class="p">[</span><span class="s1">&#39;{{&#39;</span><span class="o">+</span><span class="n">key</span><span class="o">+</span><span class="s1">&#39;}}&#39;</span><span class="p">]</span>
    173. 

  173.             <span class="k">break</span> <span class="c1"># Do not want recursive search here</span>
    174. 

  174.         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
    175. 

  175.             <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">&quot;No key file found&quot;</span><span class="p">,</span> <span class="ne">RuntimeWarning</span><span class="p">)</span>
    176. 

  176. 

  177. 

  178. <div class="viewcode-block" id="ReplaceKey.saveKeyFile"><a class="viewcode-back" href="../replacekey.html#replacekey.ReplaceKey.saveKeyFile">[docs]</a>    <span class="k">def</span> <span class="nf">saveKeyFile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    179. 

  179.         <span class="sd">&quot;&quot;&quot;Initialize routine to replace keys in file pathin and save</span>
    180. 

  180. <span class="sd">        the output to file pathout.</span>
    181. 

  181. <span class="sd">        &quot;&quot;&quot;</span>
    182. 

  182.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">:</span>
    183. 

  183.             <span class="k">print</span><span class="p">(</span><span class="s2">&quot;The keys:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">have been replaced and saved in the &quot;</span>
    184. 

  184.                   <span class="s2">&quot;following file:&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">))</span>
    185. 

  185.         <span class="bp">self</span><span class="o">.</span><span class="n">replaceKey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pathin</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pathout</span><span class="p">)</span>
    186. 

  186.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">:</span>
    187. 

  187.             <span class="k">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">%</span><span class="bp">self</span><span class="o">.</span><span class="n">pathout</span><span class="p">)</span></div>
    188. 

  188. 

  189. 

  190. <div class="viewcode-block" id="ReplaceKey.saveKeyDir"><a class="viewcode-back" href="../replacekey.html#replacekey.ReplaceKey.saveKeyDir">[docs]</a>    <span class="k">def</span> <span class="nf">saveKeyDir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    191. 

  191.         <span class="sd">&quot;&quot;&quot;Initialize routine to replace keys in files under the</span>
    192. 

  192. <span class="sd">        pathin directory, and save them under the pathout directory.</span>
    193. 

  193. <span class="sd">        &quot;&quot;&quot;</span>
    194. 

  194.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">:</span>
    195. 

  195.             <span class="k">print</span><span class="p">(</span><span class="s2">&quot;The keys:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">have been replaced and saved in the &quot;</span>
    196. 

  196.                   <span class="s2">&quot;following files:&quot;</span><span class="o">%</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">))</span>
    197. 

  197. 

  198.         <span class="c1"># Here the paths must be directories.  Windows may be probably</span>
    199. 

  199.         <span class="c1"># dealt with &#39;\&#39;. However, this should be</span>
    200. 

  200.         <span class="c1"># experimented. Instead of guessing, just do nothing and</span>
    201. 

  201.         <span class="c1"># assume that the npn-posix users will pass the correct path</span>
    202. 

  202.         <span class="c1"># name.</span>
    203. 

  203.         <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;posix&#39;</span><span class="p">:</span>
    204. 

  204.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pathin</span> <span class="o">!=</span> <span class="s1">&#39;/&#39;</span><span class="p">:</span>
    205. 

  205.                 <span class="bp">self</span><span class="o">.</span><span class="n">pathin</span> <span class="o">+=</span> <span class="s1">&#39;/&#39;</span>
    206. 

  206.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pathout</span> <span class="o">!=</span> <span class="s1">&#39;/&#39;</span><span class="p">:</span>
    207. 

  207.                 <span class="bp">self</span><span class="o">.</span><span class="n">pathout</span> <span class="o">+=</span> <span class="s1">&#39;/&#39;</span>
    208. 

  208. 

  209.         <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">_dirs</span><span class="p">,</span> <span class="n">filenames</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pathin</span><span class="p">,</span> <span class="n">topdown</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
    210. 

  210.             <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">filenames</span><span class="p">:</span>
    211. 

  211.                 <span class="k">if</span> <span class="n">filename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extension</span><span class="p">):</span>
    212. 

  212.                     <span class="n">fin</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
    213. 

  213.                     <span class="n">rootout</span> <span class="o">=</span> <span class="n">root</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pathin</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pathout</span><span class="p">)</span>
    214. 

  214.                     <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">rootout</span><span class="p">):</span>
    215. 

  215.                         <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">rootout</span><span class="p">)</span>
    216. 

  216.                     <span class="n">fout</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rootout</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
    217. 

  217.                     <span class="bp">self</span><span class="o">.</span><span class="n">replaceKey</span><span class="p">(</span><span class="n">fin</span><span class="p">,</span> <span class="n">fout</span><span class="p">)</span>
    218. 

  218.                     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">:</span>
    219. 

  219.                         <span class="k">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">%</span><span class="n">fout</span><span class="p">)</span>
    220. 

  220.             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">recursive</span><span class="p">:</span>
    221. 

  221.                 <span class="k">break</span></div>
    222. 

  222. 

  223. 

  224. <div class="viewcode-block" id="ReplaceKey.replaceKey"><a class="viewcode-back" href="../replacekey.html#replacekey.ReplaceKey.replaceKey">[docs]</a>    <span class="k">def</span> <span class="nf">replaceKey</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fin</span><span class="p">,</span> <span class="n">fout</span><span class="p">):</span>
    225. 

  225.         <span class="sd">&quot;&quot;&quot;Replace keys in file fin and save the output to file fout.&quot;&quot;&quot;</span>
    226. 

  226. 

  227.         <span class="n">extension</span> <span class="o">=</span> <span class="s1">&#39;.&#39;</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">extension</span>
    228. 

  228. 

  229.         <span class="n">f_in</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fin</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span>
    230. 

  230.         <span class="n">str_in</span> <span class="o">=</span> <span class="n">f_in</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
    231. 

  231. 

  232.         <span class="k">try</span><span class="p">:</span>
    233. 

  233.             <span class="n">f_out</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fout</span><span class="p">,</span> <span class="s1">&#39;w+&#39;</span><span class="p">)</span>
    234. 

  234.         <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
    235. 

  235.             <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;Please check that path_in and path_out are both &#39;</span>
    236. 

  236.                    <span class="s1">&#39;files or directories. If path_out is a file, make &#39;</span>
    237. 

  237.                    <span class="s1">&#39;sure that its directory exists.&#39;</span><span class="p">)</span>
    238. 

  238.             <span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    239. 

  239. 

  240.         <span class="n">rep</span> <span class="o">=</span> <span class="p">{}</span>
    241. 

  241.         <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">:</span>
    242. 

  242.             <span class="n">fkey</span> <span class="o">=</span> <span class="n">key</span>
    243. 

  243.             <span class="k">for</span> <span class="n">cht</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;{&#39;</span><span class="p">,</span> <span class="s1">&#39;}&#39;</span><span class="p">]:</span>
    244. 

  244.                 <span class="n">fkey</span> <span class="o">=</span> <span class="n">fkey</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">cht</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
    245. 

  245.             <span class="n">fkey</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pathkey</span><span class="p">,</span> <span class="n">fkey</span><span class="o">+</span><span class="n">extension</span><span class="p">)</span>
    246. 

  246.             <span class="k">try</span><span class="p">:</span>
    247. 

  247.                 <span class="n">f_key</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fkey</span><span class="p">,</span> <span class="s2">&quot;r&quot;</span><span class="p">)</span>
    248. 

  248.                 <span class="n">str_key</span> <span class="o">=</span> <span class="n">f_key</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
    249. 

  249.                 <span class="n">rep</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">str_key</span>
    250. 

  250.                 <span class="n">f_key</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    251. 

  251.             <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
    252. 

  252.                 <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;Could not open a &#39;keys/&#39; template corresponding &quot;</span>
    253. 

  253.                        <span class="s2">&quot;to the key </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">))</span>
    254. 

  254.                 <span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    255. 

  255. 

  256.         <span class="c1"># Perform the replacement</span>
    257. 

  257.         <span class="n">rep</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">k</span><span class="p">),</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">rep</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
    258. 

  258.         <span class="n">pattern</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s2">&quot;|&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rep</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
    259. 

  259.         <span class="n">text</span> <span class="o">=</span> <span class="n">pattern</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="k">lambda</span> <span class="n">m</span><span class="p">:</span> <span class="n">rep</span><span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">))],</span> <span class="n">str_in</span><span class="p">)</span>
    260. 

  260. 

  261.         <span class="n">f_out</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
    262. 

  262.         <span class="n">f_out</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    263. 

  263.         <span class="n">f_in</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div></div>
    264. 

  264. 

  265. 

  266. <div class="viewcode-block" id="getParser"><a class="viewcode-back" href="../replacekey.html#replacekey.getParser">[docs]</a><span class="k">def</span> <span class="nf">getParser</span><span class="p">():</span>
    267. 

  267.     <span class="sd">&quot;&quot;&quot;Set up and return the parser.&quot;&quot;&quot;</span>
    268. 

  268.     <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span>
    269. 

  269.         <span class="n">description</span><span class="o">=</span><span class="p">(</span><span class="s2">&quot;Replace key expressions in a file by templates &quot;</span>
    270. 

  270.                      <span class="s2">&quot;defined under a &#39;keys/&#39; directory.&quot;</span><span class="p">),</span>
    271. 

  271.         <span class="n">epilog</span><span class="o">=</span><span class="p">(</span><span class="s2">&quot;For more information about the keys template format, &quot;</span>
    272. 

  272.                 <span class="s2">&quot;see the documentation of the ReplaceKey() class.&quot;</span><span class="p">)</span>
    273. 

  273.     <span class="p">)</span>
    274. 

  274. 

  275. 

  276.     <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">__version__</span>
    277. 

  277.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--version&#39;</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s1">&#39;version&#39;</span><span class="p">,</span>
    278. 

  278.                         <span class="n">version</span><span class="o">=</span><span class="s1">&#39;</span><span class="si">%(prog)s</span><span class="s1"> &#39;</span><span class="o">+</span><span class="n">__version__</span><span class="p">)</span>
    279. 

  279. 

  280.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-v&#39;</span><span class="p">,</span> <span class="s1">&#39;--verbose&#39;</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">&quot;store_true&quot;</span><span class="p">,</span>
    281. 

  281.                         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;increase output verbosity&quot;</span><span class="p">)</span>
    282. 

  282. 

  283.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;path_in&#39;</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;path_in&#39;</span><span class="p">),</span>
    284. 

  284.                         <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
    285. 

  285.                         <span class="n">help</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;existing file (or folder, if the -r flag &#39;</span>
    286. 

  286.                               <span class="s1">&#39;is set) containing keys expressions to &#39;</span>
    287. 

  287.                               <span class="s1">&#39;be replaced&#39;</span><span class="p">))</span>
    288. 

  288. 

  289.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;path_out&#39;</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;path_out&#39;</span><span class="p">),</span>
    290. 

  290.                         <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
    291. 

  291.                         <span class="n">help</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;file (or folder, if the -r flag is set) &#39;</span>
    292. 

  292.                               <span class="s1">&#39;where to save the output of the &#39;</span>
    293. 

  293.                               <span class="s1">&#39;replacements&#39;</span><span class="p">))</span>
    294. 

  294. 

  295.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-r&#39;</span><span class="p">,</span> <span class="s1">&#39;--recursive&#39;</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s1">&#39;store_true&#39;</span><span class="p">,</span>
    296. 

  296.                         <span class="n">help</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;parse and replace keys recursively&#39;</span><span class="p">))</span>
    297. 

  297. 

  298.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-k&#39;</span><span class="p">,</span> <span class="s1">&#39;--keys-dir&#39;</span><span class="p">,</span>
    299. 

  299.                         <span class="n">metavar</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;dir&#39;</span><span class="p">),</span>
    300. 

  300.                         <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span>
    301. 

  301.                         <span class="n">nargs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
    302. 

  302.                         <span class="n">help</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;path to directory containing keys files &#39;</span>
    303. 

  303.                               <span class="s1">&#39;(default: installation_dir/keys/); &#39;</span>
    304. 

  304.                               <span class="s1">&#39;key files must have the same extension &#39;</span>
    305. 

  305.                               <span class="s1">&#39;as the files&#39;</span><span class="p">))</span>
    306. 

  306. 

  307.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-e&#39;</span><span class="p">,</span> <span class="s1">&#39;--extension&#39;</span><span class="p">,</span>
    308. 

  308.                         <span class="n">metavar</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;extension&#39;</span><span class="p">),</span>
    309. 

  309.                         <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span>
    310. 

  310.                         <span class="n">nargs</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
    311. 

  311.                         <span class="n">help</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;files extension (default: html)&#39;</span><span class="p">))</span>
    312. 

  312. 

  313.     <span class="k">return</span> <span class="n">parser</span></div>
    314. 

  314. 

  315. 

  316. <div class="viewcode-block" id="callReplaceKey"><a class="viewcode-back" href="../replacekey.html#replacekey.callReplaceKey">[docs]</a><span class="k">def</span> <span class="nf">callReplaceKey</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
    317. 

  317.     <span class="sd">&quot;&quot;&quot;Interpret args and call :class:`ReplaceKey`.&quot;&quot;&quot;</span>
    318. 

  318. 

  319.     <span class="n">pathin</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">path_in</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    320. 

  320.     <span class="n">pathout</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">path_out</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    321. 

  321. 

  322.     <span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">keys_dir</span><span class="p">:</span>
    323. 

  323.         <span class="n">keys_dir</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">keys_dir</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    324. 

  324.     <span class="k">else</span><span class="p">:</span>
    325. 

  325.         <span class="n">keys_dir</span> <span class="o">=</span> <span class="bp">None</span>
    326. 

  326. 

  327.     <span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">extension</span><span class="p">:</span>
    328. 

  328.         <span class="n">extension</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">extension</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    329. 

  329.     <span class="k">else</span><span class="p">:</span>
    330. 

  330.         <span class="n">extension</span> <span class="o">=</span> <span class="bp">None</span>
    331. 

  331. 

  332.     <span class="n">ReplaceKey</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">recursive</span><span class="p">,</span>
    333. 

  333.                <span class="n">pathin</span><span class="p">,</span>
    334. 

  334.                <span class="n">pathout</span><span class="p">,</span>
    335. 

  335.                <span class="n">keys_dir</span><span class="p">,</span>
    336. 

  336.                <span class="n">extension</span><span class="p">,</span>
    337. 

  337.                <span class="n">args</span><span class="o">.</span><span class="n">verbose</span><span class="p">)</span></div>
    338. 

  338. 

  339. 

  340. <div class="viewcode-block" id="getCli"><a class="viewcode-back" href="../replacekey.html#replacekey.getCli">[docs]</a><span class="k">def</span> <span class="nf">getCli</span><span class="p">():</span>
    341. 

  341.     <span class="sd">&quot;&quot;&quot;Command line interface.&quot;&quot;&quot;</span>
    342. 

  342.     <span class="n">parser</span> <span class="o">=</span> <span class="n">getParser</span><span class="p">()</span>
    343. 

  343.     <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
    344. 

  344.     <span class="n">callReplaceKey</span><span class="p">(</span><span class="n">args</span><span class="p">)</span></div>
    345. 

  345. 

  346. 

  347. <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
    348. 

  348.     <span class="n">getCli</span><span class="p">()</span>
    349. 

  349. </pre></div>
    350. 

  350. 

  351.           </div>
    352. 

  352.         </div>
    353. 

  353.       </div>
    354. 

  354.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    355. 

  355.         <div class="sphinxsidebarwrapper"><div class="relations">
    356. 

  356. <h3>Related Topics</h3>
    357. 

  357. <ul>
    358. 

  358.   <li><a href="../index.html">Documentation overview</a><ul>
    359. 

  359.   <li><a href="index.html">Module code</a><ul>
    360. 

  360.   </ul></li>
    361. 

  361.   </ul></li>
    362. 

  362. </ul>
    363. 

  363. </div>
    364. 

  364. <div id="searchbox" style="display: none" role="search">
    365. 

  365.   <h3>Quick search</h3>
    366. 

  366.     <form class="search" action="../search.html" method="get">
    367. 

  367.       <div><input type="text" name="q" /></div>
    368. 

  368.       <div><input type="submit" value="Go" /></div>
    369. 

  369.       <input type="hidden" name="check_keywords" value="yes" />
    370. 

  370.       <input type="hidden" name="area" value="default" />
    371. 

  371.     </form>
    372. 

  372. </div>
    373. 

  373. <script type="text/javascript">$('#searchbox').show(0);</script>
    374. 

  374.         </div>
    375. 

  375.       </div>
    376. 

  376.       <div class="clearer"></div>
    377. 

  377.     </div>
    378. 

  378.     <div class="footer">
    379. 

  379.       &copy;2016, Francesco Montanari.
    380. 

  380.       
    381. 

  381.       |
    382. 

  382.       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.4</a>
    383. 

  383.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
    384. 

  384.       
    385. 

  385.     </div>
    386. 

  386. 

  387.     
    388. 

  388. 

  389.     
    390. 

  390.   </body>
    391. 

  391. </html>
    392.