Changeset eca358d in flex_extract.git for Documentation/html/_modules/UioFiles.html
- Timestamp:
- Feb 1, 2020, 9:32:17 PM (4 years ago)
- Branches:
- master, ctbto, dev
- Children:
- 072cbea
- Parents:
- 53d3b2a
- File:
-
- 1 edited
-
Documentation/html/_modules/UioFiles.html (modified) (10 diffs)
Legend:
- Unmodified
- Added
- Removed
-
Documentation/html/_modules/UioFiles.html
r30f7911 reca358d 204 204 205 205 <span class="c1"># software specific modules from flex_extract</span> 206 <span class="c1">#pylint: disable=wrong-import-position</span> 206 207 <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">'../'</span><span class="p">)</span> 207 208 <span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="k">import</span> <span class="n">silent_remove</span><span class="p">,</span> <span class="n">get_list_as_string</span> 209 <span class="c1">#pylint: enable=wrong-import-position</span> 208 210 209 211 <span class="c1"># ------------------------------------------------------------------------------</span> … … 212 214 213 215 <div class="viewcode-block" id="UioFiles"><a class="viewcode-back" href="../Documentation/Api/api_python.html#UioFiles.UioFiles">[docs]</a><span class="k">class</span> <span class="nc">UioFiles</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> 214 <span class="sd">& #39;''Collection of files matching a specific pattern.</span>216 <span class="sd">"""Collection of files matching a specific pattern.</span> 215 217 216 218 <span class="sd"> The pattern can contain regular expressions for the files.</span> … … 224 226 225 227 <span class="sd"> pattern : str</span> 226 <span class="sd"> Regular expression pattern. For example: ' \*.grb'</span>228 <span class="sd"> Regular expression pattern. For example: '*.grb'</span> 227 229 228 230 <span class="sd"> files : list of str</span> 229 231 <span class="sd"> List of files matching the pattern in the path.</span> 230 <span class="sd"> & #39;''</span>232 <span class="sd"> """</span> 231 233 <span class="c1"># --------------------------------------------------------------------------</span> 232 234 <span class="c1"># CLASS METHODS</span> 233 235 <span class="c1"># --------------------------------------------------------------------------</span> 234 236 <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">):</span> 235 <span class="sd">& #39;''Assignes a specific pattern for these files.</span>237 <span class="sd">"""Assignes a specific pattern for these files.</span> 236 238 237 239 <span class="sd"> Parameters</span> … … 241 243 242 244 <span class="sd"> pattern : str</span> 243 <span class="sd"> Regular expression pattern. For example: ' \*.grb'</span>245 <span class="sd"> Regular expression pattern. For example: '*.grb'</span> 244 246 245 247 <span class="sd"> Return</span> 246 248 <span class="sd"> ------</span> 247 249 248 <span class="sd"> & #39;''</span>250 <span class="sd"> """</span> 249 251 250 252 <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span> … … 258 260 259 261 <span class="k">def</span> <span class="nf">_list_files</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> 260 <span class="sd">& #39;''Lists all files in the directory with the matching</span>262 <span class="sd">"""Lists all files in the directory with the matching</span> 261 263 <span class="sd"> regular expression pattern.</span> 262 264 … … 269 271 <span class="sd"> ------</span> 270 272 271 <span class="sd"> & #39;''</span>273 <span class="sd"> """</span> 272 274 <span class="c1"># Get the absolute path</span> 273 275 <span class="n">path</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">abspath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> 274 276 275 277 <span class="c1"># get all files in the dir and subdir as absolut path</span> 278 <span class="c1"># pylint: disable=W0612</span> 276 279 <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">dirnames</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="n">path</span><span class="p">):</span> 277 280 <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">filenames</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pattern</span><span class="p">):</span> … … 282 285 283 286 <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> 284 <span class="sd">& #39;''Converts the list of files into a single string.</span>287 <span class="sd">"""Converts the list of files into a single string.</span> 285 288 <span class="sd"> The entries are sepereated by "," sign.</span> 286 289 … … 292 295 <span class="sd"> files_string : str</span> 293 296 <span class="sd"> The content of the list as a single string.</span> 294 <span class="sd"> & #39;''</span>297 <span class="sd"> """</span> 295 298 296 299 <span class="n">filenames</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">]</span> … … 301 304 302 305 <div class="viewcode-block" id="UioFiles.delete_files"><a class="viewcode-back" href="../Documentation/Api/api_python.html#UioFiles.UioFiles.delete_files">[docs]</a> <span class="k">def</span> <span class="nf">delete_files</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> 303 <span class="sd">& #39;''Deletes the files.</span>306 <span class="sd">"""Deletes the files.</span> 304 307 305 308 <span class="sd"> Parameters</span> … … 309 312 <span class="sd"> ------</span> 310 313 311 <span class="sd"> & #39;''</span>314 <span class="sd"> """</span> 312 315 313 316 <span class="k">for</span> <span class="n">old_file</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">:</span>
Note: See TracChangeset
for help on using the changeset viewer.
