pylib
/
fstools
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Python Library FS-Tools
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
9 Commits
1 Branch
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
fstools/_docs_/index.html

index.html 28KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583 
  1. 

  2. 

  3. <!DOCTYPE html>

  4. <html class="writer-html4" lang="en" >

  5. <head>

  6.   <meta charset="utf-8">

  7.   

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">

  9.   

  10.   <title>Welcome to fstools’s documentation! &mdash; fstools  documentation</title>

  11.   

  12. 

  13.   

  14.   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />

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

  16. 

  17.   

  18.   

  19.   

  20.   

  21. 

  22.   

  23.   <!--[if lt IE 9]>

  24.     <script src="_static/js/html5shiv.min.js"></script>

  25.   <![endif]-->

  26.   

  27.     

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

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

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

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

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

  33.     

  34.     <script type="text/javascript" src="_static/js/theme.js"></script>

  35. 

  36.     

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

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

  39. </head>

  40. 

  41. <body class="wy-body-for-nav">

  42. 

  43.    

  44.   <div class="wy-grid-for-nav">

  45.     

  46.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">

  47.       <div class="wy-side-scroll">

  48.         <div class="wy-side-nav-search" >

  49.           

  50. 

  51.           

  52.             <a href="#" class="icon icon-home" alt="Documentation Home"> fstools

  53.           

  54. 

  55.           

  56.           </a>

  57. 

  58.           

  59.             

  60.             

  61.           

  62. 

  63.           

  64. <div role="search">

  65.   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

  66.     <input type="text" name="q" placeholder="Search docs" />

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

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

  69.   </form>

  70. </div>

  71. 

  72.           

  73.         </div>

  74. 

  75.         

  76.         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">

  77.           

  78.             

  79.             

  80.               

  81.             

  82.             

  83.               <!-- Local TOC -->

  84.               <div class="local-toc"><ul>

  85. <li><a class="reference internal" href="#">Welcome to fstools’s documentation!</a><ul>

  86. <li><a class="reference internal" href="#fstools-filesystem-tools">fstools (Filesystem Tools)</a></li>

  87. </ul>

  88. </li>

  89. <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>

  90. </ul>

  91. </div>

  92.             

  93.           

  94.         </div>

  95.         

  96.       </div>

  97.     </nav>

  98. 

  99.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

  100. 

  101.       

  102.       <nav class="wy-nav-top" aria-label="top navigation">

  103.         

  104.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>

  105.           <a href="#">fstools</a>

  106.         

  107.       </nav>

  108. 

  109. 

  110.       <div class="wy-nav-content">

  111.         

  112.         <div class="rst-content">

  113.         

  114.           

  115. 

  116. 

  117. 

  118. 

  119. 

  120. 

  121. 

  122. 

  123. 

  124. 

  125. 

  126. 

  127. 

  128. 

  129. 

  130. <div role="navigation" aria-label="breadcrumbs navigation">

  131. 

  132.   <ul class="wy-breadcrumbs">

  133.     

  134.       <li><a href="#" class="icon icon-home"></a> &raquo;</li>

  135.         

  136.       <li>Welcome to fstools’s documentation!</li>

  137.     

  138.     

  139.       <li class="wy-breadcrumbs-aside">

  140.         

  141.             

  142.             <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>

  143.           

  144.         

  145.       </li>

  146.     

  147.   </ul>

  148. 

  149.   

  150.   <hr/>

  151. </div>

  152.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">

  153.            <div itemprop="articleBody">

  154.             

  155.   <div class="section" id="module-fstools">

  156. <span id="welcome-to-fstools-s-documentation"></span><h1>Welcome to fstools’s documentation!<a class="headerlink" href="#module-fstools" title="Permalink to this headline">¶</a></h1>

  157. <div class="section" id="fstools-filesystem-tools">

  158. <h2>fstools (Filesystem Tools)<a class="headerlink" href="#fstools-filesystem-tools" title="Permalink to this headline">¶</a></h2>

  159. <p><strong>Author:</strong></p>

  160. <ul class="simple">

  161. <li>Dirk Alders &lt;<a class="reference external" href="mailto:sudo-dirk&#37;&#52;&#48;mount-mockery&#46;de">sudo-dirk<span>&#64;</span>mount-mockery<span>&#46;</span>de</a>&gt;</li>

  162. </ul>

  163. <p><strong>Description:</strong></p>

  164. <blockquote>

  165. <div>This module supports functions and classes to handle files and paths</div></blockquote>

  166. <p><strong>Submodules:</strong></p>

  167. <ul class="simple">

  168. <li><a class="reference internal" href="#fstools.dirlist" title="fstools.dirlist"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.dirlist()</span></code></a></li>

  169. <li><a class="reference internal" href="#fstools.filelist" title="fstools.filelist"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.filelist()</span></code></a></li>

  170. <li><a class="reference internal" href="#fstools.is_writeable" title="fstools.is_writeable"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.is_writeable()</span></code></a></li>

  171. <li><a class="reference internal" href="#fstools.mkdir" title="fstools.mkdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.mkdir()</span></code></a></li>

  172. <li><a class="reference internal" href="#fstools.open_locked_blocking" title="fstools.open_locked_blocking"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.open_locked_blocking()</span></code></a></li>

  173. <li><a class="reference internal" href="#fstools.open_locked_non_blocking" title="fstools.open_locked_non_blocking"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.open_locked_non_blocking()</span></code></a></li>

  174. <li><a class="reference internal" href="#fstools.uid" title="fstools.uid"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.uid()</span></code></a></li>

  175. </ul>

  176. <p><strong>Unittest:</strong></p>

  177. <blockquote>

  178. <div>See also the <a class="reference download internal" download="" href="_downloads/7bf10188aa659556c284b4a8298dba8d/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</div></blockquote>

  179. <p><strong>Module Documentation:</strong></p>

  180. <dl class="function">

  181. <dt id="fstools.dirlist">

  182. <code class="descclassname">fstools.</code><code class="descname">dirlist</code><span class="sig-paren">(</span><em>path='.'</em>, <em>rekursive=True</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.dirlist" title="Permalink to this definition">¶</a></dt>

  183. <dd><p>Function returning a list of directories below a given path.</p>

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

  185. <col class="field-name" />

  186. <col class="field-body" />

  187. <tbody valign="top">

  188. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  189. <li><strong>path</strong> (<em>str</em>) – folder which is the basepath for searching files.</li>

  190. <li><strong>rekursive</strong> (<em>bool</em>) – search all subfolders if True.</li>

  191. </ul>

  192. </td>

  193. </tr>

  194. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">list of filenames including the pathe</p>

  195. </td>

  196. </tr>

  197. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>

  198. </td>

  199. </tr>

  200. </tbody>

  201. </table>

  202. <div class="admonition note">

  203. <p class="first admonition-title">Note</p>

  204. <p class="last">The returned filenames could be relative pathes depending on argument path.</p>

  205. </div>

  206. <p><strong>Example:</strong></p>

  207. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>

  208. <span class="c1"># -*- coding: UTF-8 -*-</span>

  209. 

  210. <span class="kn">import</span> <span class="nn">sys</span>

  211. <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../..&#39;</span><span class="p">)</span>

  212. 

  213. <span class="kn">import</span> <span class="nn">fstools</span>

  214. 

  215. 

  216. <span class="k">for</span> <span class="n">dirname</span> <span class="ow">in</span> <span class="n">fstools</span><span class="o">.</span><span class="n">dirlist</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="n">rekursive</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>

  217.     <span class="nb">print</span><span class="p">(</span><span class="n">dirname</span><span class="p">)</span>

  218. </pre></div>

  219. </div>

  220. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">../</span><span class="n">_examples_</span>

  221. <span class="o">../</span><span class="n">__pycache__</span>

  222. <span class="o">../</span><span class="n">_testresults_</span>

  223. <span class="o">../</span><span class="n">_docs_</span>

  224. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span>

  225. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">fonts</span>

  226. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">fonts</span><span class="o">/</span><span class="n">Lato</span>

  227. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">fonts</span><span class="o">/</span><span class="n">RobotoSlab</span>

  228. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">js</span>

  229. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">css</span>

  230. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">css</span><span class="o">/</span><span class="n">fonts</span>

  231. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_sources</span>

  232. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_downloads</span>

  233. <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_downloads</span><span class="o">/</span><span class="mi">7</span><span class="n">bf10188aa659556c284b4a8298dba8d</span>

  234. </pre></div>

  235. </div>

  236. </dd></dl>

  237. 

  238. <dl class="function">

  239. <dt id="fstools.filelist">

  240. <code class="descclassname">fstools.</code><code class="descname">filelist</code><span class="sig-paren">(</span><em>path='.'</em>, <em>expression='*'</em>, <em>rekursive=True</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.filelist" title="Permalink to this definition">¶</a></dt>

  241. <dd><p>Function returning a list of files below a given path.</p>

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

  243. <col class="field-name" />

  244. <col class="field-body" />

  245. <tbody valign="top">

  246. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  247. <li><strong>path</strong> (<em>str</em>) – folder which is the basepath for searching files.</li>

  248. <li><strong>expression</strong> (<em>str</em>) – expression to fit including shell-style wildcards.</li>

  249. <li><strong>rekursive</strong> (<em>bool</em>) – search all subfolders if True.</li>

  250. </ul>

  251. </td>

  252. </tr>

  253. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">list of filenames including the pathe</p>

  254. </td>

  255. </tr>

  256. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>

  257. </td>

  258. </tr>

  259. </tbody>

  260. </table>

  261. <div class="admonition note">

  262. <p class="first admonition-title">Note</p>

  263. <p class="last">The returned filenames could be relative pathes depending on argument path.</p>

  264. </div>

  265. <p><strong>Example:</strong></p>

  266. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>

  267. <span class="c1"># -*- coding: UTF-8 -*-</span>

  268. 

  269. <span class="kn">import</span> <span class="nn">sys</span>

  270. <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../..&#39;</span><span class="p">)</span>

  271. 

  272. <span class="kn">import</span> <span class="nn">fstools</span>

  273. 

  274. 

  275. <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">fstools</span><span class="o">.</span><span class="n">filelist</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="n">expression</span><span class="o">=</span><span class="s1">&#39;*.py&#39;</span><span class="p">,</span> <span class="n">rekursive</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>

  276.     <span class="nb">print</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>

  277. </pre></div>

  278. </div>

  279. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">../</span><span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>

  280. <span class="o">../</span><span class="n">_examples_</span><span class="o">/</span><span class="n">uid</span><span class="o">.</span><span class="n">py</span>

  281. <span class="o">../</span><span class="n">_examples_</span><span class="o">/</span><span class="n">is_writeable</span><span class="o">.</span><span class="n">py</span>

  282. <span class="o">../</span><span class="n">_examples_</span><span class="o">/</span><span class="n">uid_filelist</span><span class="o">.</span><span class="n">py</span>

  283. <span class="o">../</span><span class="n">_examples_</span><span class="o">/</span><span class="n">dirlist</span><span class="o">.</span><span class="n">py</span>

  284. <span class="o">../</span><span class="n">_examples_</span><span class="o">/</span><span class="n">filelist</span><span class="o">.</span><span class="n">py</span>

  285. </pre></div>

  286. </div>

  287. </dd></dl>

  288. 

  289. <dl class="function">

  290. <dt id="fstools.is_writeable">

  291. <code class="descclassname">fstools.</code><code class="descname">is_writeable</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.is_writeable" title="Permalink to this definition">¶</a></dt>

  292. <dd><p>Method to get the Information, if a file or folder is writable.</p>

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

  294. <col class="field-name" />

  295. <col class="field-body" />

  296. <tbody valign="top">

  297. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<em>str</em>) – file or folder to check.</td>

  298. </tr>

  299. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Whether path is writable or not.</td>

  300. </tr>

  301. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  302. </tr>

  303. </tbody>

  304. </table>

  305. <div class="admonition note">

  306. <p class="first admonition-title">Note</p>

  307. <p class="last">If path does not exist, the return Value is <code class="xref py py-const docutils literal notranslate"><span class="pre">False</span></code>.</p>

  308. </div>

  309. <p><strong>Example:</strong></p>

  310. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>

  311. <span class="c1"># -*- coding: UTF-8 -*-</span>

  312. 

  313. <span class="kn">import</span> <span class="nn">sys</span>

  314. <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../..&#39;</span><span class="p">)</span>

  315. 

  316. <span class="kn">import</span> <span class="nn">fstools</span>

  317. 

  318. 

  319. <span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">is_writeable</span><span class="p">(</span><span class="s1">&#39;..&#39;</span><span class="p">))</span>

  320. <span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">is_writeable</span><span class="p">(</span><span class="s1">&#39;../__init__.py&#39;</span><span class="p">))</span>

  321. </pre></div>

  322. </div>

  323. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kc">True</span>

  324. <span class="kc">True</span>

  325. </pre></div>

  326. </div>

  327. </dd></dl>

  328. 

  329. <dl class="function">

  330. <dt id="fstools.mkdir">

  331. <code class="descclassname">fstools.</code><code class="descname">mkdir</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.mkdir" title="Permalink to this definition">¶</a></dt>

  332. <dd><p>Method to create a folder.</p>

  333. <div class="admonition note">

  334. <p class="first admonition-title">Note</p>

  335. <p class="last">All needed subfoilders will also be created (rekursive mkdir).</p>

  336. </div>

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

  338. <col class="field-name" />

  339. <col class="field-body" />

  340. <tbody valign="top">

  341. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<em>str</em>) – folder to be created.</td>

  342. </tr>

  343. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True, if folder exists after creation commands, otherwise False.</td>

  344. </tr>

  345. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  346. </tr>

  347. </tbody>

  348. </table>

  349. </dd></dl>

  350. 

  351. <dl class="function">

  352. <dt id="fstools.open_locked_blocking">

  353. <code class="descclassname">fstools.</code><code class="descname">open_locked_blocking</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.open_locked_blocking" title="Permalink to this definition">¶</a></dt>

  354. <dd><p>Method to get exclusive access to a file.</p>

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

  356. <col class="field-name" />

  357. <col class="field-body" />

  358. <tbody valign="top">

  359. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  360. <li><strong>args</strong> – Arguments for a standard file open call.</li>

  361. <li><strong>kwargs</strong> – Keyword arguments for a standard file open call.</li>

  362. </ul>

  363. </td>

  364. </tr>

  365. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A file descriptor.</p>

  366. </td>

  367. </tr>

  368. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">file handle</p>

  369. </td>

  370. </tr>

  371. </tbody>

  372. </table>

  373. <div class="admonition note">

  374. <p class="first admonition-title">Note</p>

  375. <p class="last">The call blocks until file is able to be used. This can cause a deadlock, if the file release es done after trying to open the file!</p>

  376. </div>

  377. </dd></dl>

  378. 

  379. <dl class="function">

  380. <dt id="fstools.open_locked_non_blocking">

  381. <code class="descclassname">fstools.</code><code class="descname">open_locked_non_blocking</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.open_locked_non_blocking" title="Permalink to this definition">¶</a></dt>

  382. <dd><p>Method to get exclusive access to a file.</p>

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

  384. <col class="field-name" />

  385. <col class="field-body" />

  386. <tbody valign="top">

  387. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  388. <li><strong>args</strong> – Arguments for a standard file open call.</li>

  389. <li><strong>kwargs</strong> – Keyword arguments for a standard file open call.</li>

  390. </ul>

  391. </td>

  392. </tr>

  393. <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first">OSError, if the file is already blocked.</p>

  394. </td>

  395. </tr>

  396. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A file descriptor.</p>

  397. </td>

  398. </tr>

  399. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">file handle</p>

  400. </td>

  401. </tr>

  402. </tbody>

  403. </table>

  404. <div class="admonition note">

  405. <p class="first admonition-title">Note</p>

  406. <p class="last">The call blocks until file is able to be used. This can cause a deadlock, if the file release es done after trying to open the file!</p>

  407. </div>

  408. </dd></dl>

  409. 

  410. <dl class="function">

  411. <dt id="fstools.uid">

  412. <code class="descclassname">fstools.</code><code class="descname">uid</code><span class="sig-paren">(</span><em>path</em>, <em>max_staleness=3600</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.uid" title="Permalink to this definition">¶</a></dt>

  413. <dd><p>Function returning a “unique” id for a given file or path.</p>

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

  415. <col class="field-name" />

  416. <col class="field-body" />

  417. <tbody valign="top">

  418. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  419. <li><strong>path</strong> (<em>str</em>) – File or folder to generate a uid for.</li>

  420. <li><strong>max_staleness</strong> (<em>int</em>) – If a file or folder is older than that, we may consider

  421. it stale and return a different uid - this is a

  422. dirty trick to work around changes never being

  423. detected. Default is 3600 seconds, use None to

  424. disable this trickery. See below for more details.</li>

  425. </ul>

  426. </td>

  427. </tr>

  428. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An object that changes value if the file changed,

  429. None is returned if there were problems accessing the file

  430. or folder.</p>

  431. </td>

  432. </tr>

  433. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>

  434. </td>

  435. </tr>

  436. </tbody>

  437. </table>

  438. <div class="admonition warning">

  439. <p class="first admonition-title">Warning</p>

  440. <p class="last">Depending on the operating system capabilities and the way the

  441. file update is done, this function might return the same value

  442. even if the file has changed. It should be better than just

  443. using file’s mtime though.

  444. max_staleness tries to avoid the worst for these cases.</p>

  445. </div>

  446. <div class="admonition note">

  447. <p class="first admonition-title">Note</p>

  448. <p class="last">If this function is used for a path, it will stat all pathes and files rekursively.</p>

  449. </div>

  450. <p><strong>Example:</strong></p>

  451. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>

  452. <span class="c1"># -*- coding: UTF-8 -*-</span>

  453. 

  454. <span class="kn">import</span> <span class="nn">sys</span>

  455. <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../..&#39;</span><span class="p">)</span>

  456. 

  457. <span class="kn">import</span> <span class="nn">fstools</span>

  458. 

  459. 

  460. <span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">uid</span><span class="p">(</span><span class="s1">&#39;../__init__.py&#39;</span><span class="p">))</span>

  461. </pre></div>

  462. </div>

  463. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">950</span><span class="n">bd674ce9e6ccc93a3f450964b524412961e0d</span>

  464. </pre></div>

  465. </div>

  466. <p>Using just the file’s mtime to determine if the file has changed is

  467. not reliable - if file updates happen faster than the file system’s

  468. mtime granularity, then the modification is not detectable because

  469. the mtime is still the same.</p>

  470. <p>This function tries to improve by using not only the mtime, but also

  471. other metadata values like file size and inode to improve reliability.</p>

  472. <p>For the calculation of this value, we of course only want to use data

  473. that we can get rather fast, thus we use file metadata, not file data

  474. (file content).</p>

  475. </dd></dl>

  476. 

  477. <dl class="function">

  478. <dt id="fstools.uid_filelist">

  479. <code class="descclassname">fstools.</code><code class="descname">uid_filelist</code><span class="sig-paren">(</span><em>path='.'</em>, <em>expression='*'</em>, <em>rekursive=True</em><span class="sig-paren">)</span><a class="headerlink" href="#fstools.uid_filelist" title="Permalink to this definition">¶</a></dt>

  480. <dd><p>Function returning a unique id for a given file or path.</p>

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

  482. <col class="field-name" />

  483. <col class="field-body" />

  484. <tbody valign="top">

  485. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  486. <li><strong>path</strong> (<em>str</em>) – folder which is the basepath for searching files.</li>

  487. <li><strong>expression</strong> (<em>str</em>) – expression to fit including shell-style wildcards.</li>

  488. <li><strong>rekursive</strong> (<em>bool</em>) – search all subfolders if True.</li>

  489. </ul>

  490. </td>

  491. </tr>

  492. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An object that changes value if one of the files change.</p>

  493. </td>

  494. </tr>

  495. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>

  496. </td>

  497. </tr>

  498. </tbody>

  499. </table>

  500. <div class="admonition note">

  501. <p class="first admonition-title">Note</p>

  502. <p class="last">This UID is created out of the file content. Therefore it is more

  503. reliable then <a class="reference internal" href="#fstools.uid" title="fstools.uid"><code class="xref py py-func docutils literal notranslate"><span class="pre">fstools.uid()</span></code></a>, but also much slower.</p>

  504. </div>

  505. <p><strong>Example:</strong></p>

  506. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>

  507. <span class="c1"># -*- coding: UTF-8 -*-</span>

  508. 

  509. <span class="kn">import</span> <span class="nn">sys</span>

  510. <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../..&#39;</span><span class="p">)</span>

  511. 

  512. <span class="kn">import</span> <span class="nn">fstools</span>

  513. 

  514. 

  515. <span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">uid_filelist</span><span class="p">(</span><span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="s1">&#39;*.py&#39;</span><span class="p">,</span> <span class="n">rekursive</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>

  516. </pre></div>

  517. </div>

  518. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">32</span><span class="n">ca1c130dfa068b79f4e96071c46448</span>

  519. </pre></div>

  520. </div>

  521. </dd></dl>

  522. 

  523. </div>

  524. <div class="toctree-wrapper compound">

  525. </div>

  526. </div>

  527. <div class="section" id="indices-and-tables">

  528. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>

  529. <ul class="simple">

  530. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>

  531. <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>

  532. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>

  533. </ul>

  534. </div>

  535. 

  536. 

  537.            </div>

  538.            

  539.           </div>

  540.           <footer>

  541.   

  542. 

  543.   <hr/>

  544. 

  545.   <div role="contentinfo">

  546.     <p>

  547.         

  548.         &copy; Copyright 2021, Dirk Alders

  549. 

  550.     </p>

  551.   </div>

  552.     

  553.     

  554.     

  555.     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a

  556.     

  557.     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>

  558.     

  559.     provided by <a href="https://readthedocs.org">Read the Docs</a>. 

  560. 

  561. </footer>

  562. 

  563.         </div>

  564.       </div>

  565. 

  566.     </section>

  567. 

  568.   </div>

  569.   

  570. 

  571.   <script type="text/javascript">

  572.       jQuery(function () {

  573.           SphinxRtdTheme.Navigation.enable(true);

  574.       });

  575.   </script>

  576. 

  577.   

  578.   

  579.     

  580.    

  581. 

  582. </body>

  583. </html>