source: flex_extract.git/source/python/classes/UioFiles.py @ 5cb0eaa

dev
Last change on this file since 5cb0eaa was 5cb0eaa, checked in by Anne Philipp <anne.philipp@…>, 9 months ago

renamed list_files function

  • Property mode set to 100644
File size: 4.1 KB
Line 
1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3#*******************************************************************************
4# @Author: Anne Fouilloux (University of Oslo)
5#
6# @Date: October 2014
7#
8# @Change History:
9#
10#    November 2015 - Leopold Haimberger (University of Vienna):
11#        - modified method list_files to work with glob instead of listdir
12#        - added pattern search in method list_files
13#
14#    February 2018 - Anne Philipp (University of Vienna):
15#        - applied PEP8 style guide
16#        - added documentation
17#        - optimisation of method list_files since it didn't work correctly
18#          for sub directories
19#        - additional speed up of method list_files
20#        - modified the class so that it is initiated with a pattern instead
21#          of suffixes. Gives more precision in selection of files.
22#
23# @License:
24#    (C) Copyright 2014-2018.
25#
26#    This software is licensed under the terms of the Apache Licence Version 2.0
27#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
28#
29# @Class Decription:
30#    The class is for file manipulation. It is initiated with a regular
31#    expression pattern for this instance and can produce a list of Files
32#    from the given file pattern. These files can be deleted.
33#
34# @Class Content:
35#    - __init__
36#    - __str__
37#    - __list_files__
38#    - delete_files
39#
40# @Class Attributes:
41#    - pattern
42#    - files
43#
44#*******************************************************************************
45
46# ------------------------------------------------------------------------------
47# MODULES
48# ------------------------------------------------------------------------------
49import os
50import sys
51import fnmatch
52
53# software specific module from flex_extract
54sys.path.append('../')
55#import profiling
56from mods.tools import silent_remove, get_list_as_string
57
58# ------------------------------------------------------------------------------
59# CLASS
60# ------------------------------------------------------------------------------
61
62class UioFiles(object):
63    '''Class to manipulate files. At initialisation it has the pattern
64    which stores a regular expression pattern for the files, the path
65    to the files and the files already.
66    '''
67    # --------------------------------------------------------------------------
68    # CLASS FUNCTIONS
69    # --------------------------------------------------------------------------
70    def __init__(self, path, pattern):
71        '''Assignes a specific pattern for these files.
72
73        Parameters
74        ----------
75        path : :obj:`string`
76            Directory where to list the files.
77
78        pattern : :obj:`string`
79            Regular expression pattern. For example: '\*.grb'
80
81        Return
82        ------
83
84        '''
85
86        self.path = path
87        self.pattern = pattern
88        self.files = []
89
90        self._list_files(self.path)
91
92        return
93
94    #@profiling.timefn
95    def _list_files(self, path):
96        '''Lists all files in the directory with the matching
97        regular expression pattern.
98
99        Parameters
100        ----------
101        path : :obj:`string`
102            Path to the files.
103
104        Return
105        ------
106
107        '''
108        # Get the absolute path
109        path = os.path.abspath(path)
110
111        # get all files in the dir and subdir as absolut path
112        for root, dirnames, filenames in os.walk(path):
113            for filename in fnmatch.filter(filenames, self.pattern):
114                self.files.append(os.path.join(root, filename))
115
116        return
117
118    def __str__(self):
119        '''Converts the list of files into a single string.
120        The entries are sepereated by "," sign.
121
122        Parameters
123        ----------
124
125        Return
126        ------
127        files_string : :obj:`string`
128            The content of the list as a single string.
129        '''
130
131        filenames = [os.path.basename(f) for f in self.files]
132        files_string = get_list_as_string(filenames, concatenate_sign=', ')
133
134        return files_string
135
136    def delete_files(self):
137        '''Deletes the files.
138
139        Parameters
140        ----------
141
142        Return
143        ------
144
145        '''
146
147        for old_file in self.files:
148            silent_remove(old_file)
149
150        return
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG