PageRenderTime 21ms CodeModel.GetById 18ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/2.0/generated/cf.TEMPDIR.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 202 lines | 158 code | 14 blank | 30 comment | 0 complexity | 952e8f8a511cad249c71ec776d02b939 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>cf.TEMPDIR &#8212; Documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="../_static/classic.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:     '2.0',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true,
    21. 

  21.         SOURCELINK_SUFFIX: '.txt'
    22. 

  22.       };
    23. 

  23.     </script>
    24. 

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

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

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

  27.     <script type="text/javascript" src="../_static/copybutton.js"></script>
    28. 

  28.     <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    29. 

  29.     <link rel="index" title="Index" href="../genindex.html" />
    30. 

  30.     <link rel="search" title="Search" href="../search.html" />
    31. 

  31.     <link rel="next" title="cf.abspath" href="cf.abspath.html" />
    32. 

  32.     <link rel="prev" title="cf.RTOL" href="cf.RTOL.html" /> 
    33. 

  33.   </head>
    34. 

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

  35.     <div class="related" role="navigation" aria-label="related navigation">
    36. 

  36.       <h3>Navigation</h3>
    37. 

  37.       <ul>
    38. 

  38.         <li class="right" style="margin-right: 10px">
    39. 

  39.           <a href="../genindex.html" title="General Index"
    40. 

  40.              accesskey="I">index</a></li>
    41. 

  41.         <li class="right" >
    42. 

  42.           <a href="cf.abspath.html" title="cf.abspath"
    43. 

  43.              accesskey="N">next</a> |</li>
    44. 

  44.         <li class="right" >
    45. 

  45.           <a href="cf.RTOL.html" title="cf.RTOL"
    46. 

  46.              accesskey="P">previous</a> |</li>
    47. 

  47.   <li><a target="_blank" href="../../archive.html">Archive</a> &laquo;</li>
    48. 

  48.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python 2.0</a> &raquo;</li>
    49. 

  49. <!--
    50. 

  50.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python</a> &raquo;</li>
    51. 

  51.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    52. 

  52. 

  53.       <option value="../../1.0/index.html">1.0
    54. 

  54. 

  55.       <option value="../../0.9.9/index.html">0.9.9
    56. 

  56. 

  57.       <option value="../../0.9.8.3/index.html">0.9.8.3
    58. 

  58. 

  59.       <option value="../../archive.html">Archive
    60. 

  60. 

  61.       </select>
    62. 

  62.   </li>
    63. 

  63. -->
    64. 

  64.   
    65. 

  65.         <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> &#187;</li>
    66. 

  66. 

  67.           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> &#187;</li>
    68. 

  68.           <li class="nav-item nav-item-2"><a href="../function.html" accesskey="U">Functions of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> &#187;</li> 
    69. 

  69.       </ul>
    70. 

  70.     </div>  
    71. 

  71. 

  72.     <div class="document">
    73. 

  73.       <div class="documentwrapper">
    74. 

  74.         <div class="bodywrapper">
    75. 

  75.           <div class="body" role="main">
    76. 

  76.             
    77. 

  77.   <div class="section" id="cf-tempdir">
    78. 

  78. <h1>cf.TEMPDIR<a class="headerlink" href="#cf-tempdir" title="Permalink to this headline">Âś</a></h1>
    79. 

  79. <dl class="function">
    80. 

  80. <dt id="cf.TEMPDIR">
    81. 

  81. <code class="descclassname">cf.</code><code class="descname">TEMPDIR</code><span class="sig-paren">(</span><em>*arg</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v2.0/cf/functions.py#functions.py-310"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.TEMPDIR" title="Permalink to this definition">Âś</a></dt>
    82. 

  82. <dd><p>The directory for internally generated temporary files.</p>
    83. 

  83. <p>When setting the directory, it is created if the specified path does
    84. 

  84. not exist.</p>
    85. 

  85. <table class="docutils field-list" frame="void" rules="none">
    86. 

  86. <col class="field-name" />
    87. 

  87. <col class="field-body" />
    88. 

  88. <tbody valign="top">
    89. 

  89. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
    90. 

  90. <dt>arg</dt>
    91. 

  91.  <span class="classifier-delimiter">:</span> <span class="classifier">str, optional</span><dd><p class="first">The new directory for temporary files. Tilde expansion (an
    92. 

  92. initial component of <code class="docutils literal"><span class="pre">~</span></code> or <code class="docutils literal"><span class="pre">~user</span></code> is replaced by that
    93. 

  93. <em>user</em>&#8216;s home directory) and environment variable expansion
    94. 

  94. (substrings of the form <code class="docutils literal"><span class="pre">$name</span></code> or <code class="docutils literal"><span class="pre">${name}</span></code> are replaced
    95. 

  95. by the value of environment variable <em>name</em>) are applied to
    96. 

  96. the new directory name.</p>
    97. 

  97. <p class="last">The default is to not change the directory.</p>
    98. 

  98. </dd>
    99. 

  99. </dl>
    100. 

  100. </td>
    101. 

  101. </tr>
    102. 

  102. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first docutils">
    103. 

  103. <dt>out</dt>
    104. 

  104.  <span class="classifier-delimiter">:</span> <span class="classifier">str</span><dd><p class="first last">The directory prior to the change, or the current directory if
    105. 

  105. no new value was specified.</p>
    106. 

  106. </dd>
    107. 

  107. </dl>
    108. 

  108. </td>
    109. 

  109. </tr>
    110. 

  110. <tr class="field-odd field"><th class="field-name">Examples:</th><td class="field-body"></td>
    111. 

  111. </tr>
    112. 

  112. </tbody>
    113. 

  113. </table>
    114. 

  114. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">cf</span><span class="o">.</span><span class="n">TEMPDIR</span><span class="p">()</span>
    115. 

  115. <span class="go">&#39;/tmp&#39;</span>
    116. 

  116. <span class="gp">&gt;&gt;&gt; </span><span class="n">old</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">TEMPDIR</span><span class="p">(</span><span class="s1">&#39;/home/me/tmp&#39;</span><span class="p">)</span>
    117. 

  117. <span class="gp">&gt;&gt;&gt; </span><span class="n">cf</span><span class="o">.</span><span class="n">TEMPDIR</span><span class="p">(</span><span class="n">old</span><span class="p">)</span>
    118. 

  118. <span class="go">&#39;/home/me/tmp&#39;</span>
    119. 

  119. <span class="gp">&gt;&gt;&gt; </span><span class="n">cf</span><span class="o">.</span><span class="n">TEMPDIR</span><span class="p">()</span>
    120. 

  120. <span class="go">&#39;/tmp&#39;</span>
    121. 

  121. </pre></div>
    122. 

  122. </div>
    123. 

  123. </dd></dl>
    124. 

  124. 

  125. </div>
    126. 

  126. 

  127. 

  128.           </div>
    129. 

  129.         </div>
    130. 

  130.       </div>
    131. 

  131.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    132. 

  132.         <div class="sphinxsidebarwrapper">
    133. 

  133.   <h4>Previous topic</h4>
    134. 

  134.   <p class="topless"><a href="cf.RTOL.html"
    135. 

  135.                         title="previous chapter">cf.RTOL</a></p>
    136. 

  136.   <h4>Next topic</h4>
    137. 

  137.   <p class="topless"><a href="cf.abspath.html"
    138. 

  138.                         title="next chapter">cf.abspath</a></p>
    139. 

  139.   <div role="note" aria-label="source link">
    140. 

  140.     <h3>This Page</h3>
    141. 

  141.     <ul class="this-page-menu">
    142. 

  142.       <li><a href="../_sources/generated/cf.TEMPDIR.rst.txt"
    143. 

  143.             rel="nofollow">Show Source</a></li>
    144. 

  144.     </ul>
    145. 

  145.    </div>
    146. 

  146. <div id="searchbox" style="display: none" role="search">
    147. 

  147.   <h3>Quick search</h3>
    148. 

  148.     <form class="search" action="../search.html" method="get">
    149. 

  149.       <div><input type="text" name="q" /></div>
    150. 

  150.       <div><input type="submit" value="Go" /></div>
    151. 

  151.       <input type="hidden" name="check_keywords" value="yes" />
    152. 

  152.       <input type="hidden" name="area" value="default" />
    153. 

  153.     </form>
    154. 

  154. </div>
    155. 

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

  156.         </div>
    157. 

  157.       </div>
    158. 

  158.       <div class="clearer"></div>
    159. 

  159.     </div>
    160. 

  160.     <div class="related" role="navigation" aria-label="related navigation">
    161. 

  161.       <h3>Navigation</h3>
    162. 

  162.       <ul>
    163. 

  163.         <li class="right" style="margin-right: 10px">
    164. 

  164.           <a href="../genindex.html" title="General Index"
    165. 

  165.              >index</a></li>
    166. 

  166.         <li class="right" >
    167. 

  167.           <a href="cf.abspath.html" title="cf.abspath"
    168. 

  168.              >next</a> |</li>
    169. 

  169.         <li class="right" >
    170. 

  170.           <a href="cf.RTOL.html" title="cf.RTOL"
    171. 

  171.              >previous</a> |</li>
    172. 

  172.   <li><a target="_blank" href="../../archive.html">Archive</a> &laquo;</li>
    173. 

  173.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python 2.0</a> &raquo;</li>
    174. 

  174. <!--
    175. 

  175.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python</a> &raquo;</li>
    176. 

  176.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    177. 

  177. 

  178.       <option value="../../1.0/index.html">1.0
    179. 

  179. 

  180.       <option value="../../0.9.9/index.html">0.9.9
    181. 

  181. 

  182.       <option value="../../0.9.8.3/index.html">0.9.8.3
    183. 

  183. 

  184.       <option value="../../archive.html">Archive
    185. 

  185. 

  186.       </select>
    187. 

  187.   </li>
    188. 

  188. -->
    189. 

  189.   
    190. 

  190.         <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> &#187;</li>
    191. 

  191. 

  192.           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> &#187;</li>
    193. 

  193.           <li class="nav-item nav-item-2"><a href="../function.html" >Functions of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> &#187;</li> 
    194. 

  194.       </ul>
    195. 

  195.     </div>
    196. 

  196.     <div class="footer" role="contentinfo">
    197. 

  197.         &#169; Copyright 2016, David Hassell.
    198. 

  198.       Last updated on Jul 07, 2017.
    199. 

  199.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.
    200. 

  200.     </div>
    201. 

  201.   </body>
    202. 

  202. </html>
    203.