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 | # ------------------------------------------------------------------------------ |
---|
49 | import os |
---|
50 | import fnmatch |
---|
51 | |
---|
52 | # software specific module from flex_extract |
---|
53 | #import profiling |
---|
54 | from tools import silent_remove, get_list_as_string |
---|
55 | |
---|
56 | # ------------------------------------------------------------------------------ |
---|
57 | # CLASS |
---|
58 | # ------------------------------------------------------------------------------ |
---|
59 | |
---|
60 | class UioFiles(object): |
---|
61 | ''' |
---|
62 | Class to manipulate files. At initialisation it has the attribute |
---|
63 | pattern which stores a regular expression pattern for the files associated |
---|
64 | with the instance of the class. |
---|
65 | ''' |
---|
66 | # -------------------------------------------------------------------------- |
---|
67 | # CLASS FUNCTIONS |
---|
68 | # -------------------------------------------------------------------------- |
---|
69 | def __init__(self, path, pattern): |
---|
70 | ''' |
---|
71 | @Description: |
---|
72 | Assignes a specific pattern for these files. |
---|
73 | |
---|
74 | @Input: |
---|
75 | self: instance of UioFiles |
---|
76 | Description see class documentation. |
---|
77 | |
---|
78 | path: string |
---|
79 | Directory where to list the files. |
---|
80 | |
---|
81 | pattern: string |
---|
82 | Regular expression pattern. For example: '*.grb' |
---|
83 | |
---|
84 | @Return: |
---|
85 | <nothing> |
---|
86 | ''' |
---|
87 | |
---|
88 | self.path = path |
---|
89 | self.pattern = pattern |
---|
90 | self.files = None |
---|
91 | |
---|
92 | self.__list_files__(self.path) |
---|
93 | |
---|
94 | return |
---|
95 | |
---|
96 | #@profiling.timefn |
---|
97 | def __list_files__(self, path, callid=0): |
---|
98 | ''' |
---|
99 | @Description: |
---|
100 | Lists all files in the directory with the matching |
---|
101 | regular expression pattern. |
---|
102 | |
---|
103 | @Input: |
---|
104 | self: instance of UioFiles |
---|
105 | Description see class documentation. |
---|
106 | |
---|
107 | path: string |
---|
108 | Path to the files. |
---|
109 | |
---|
110 | callid: integer |
---|
111 | Id which tells the function if its the first call |
---|
112 | or a recursive call. Default and first call is 0. |
---|
113 | Everything different from 0 is ment to be a recursive case. |
---|
114 | |
---|
115 | @Return: |
---|
116 | <nothing> |
---|
117 | ''' |
---|
118 | |
---|
119 | # initialize variable in first function call |
---|
120 | if callid == 0: |
---|
121 | self.files = [] |
---|
122 | |
---|
123 | # Get the absolute path |
---|
124 | path = os.path.abspath(path) |
---|
125 | |
---|
126 | # get the file list of the path if its not a directory and |
---|
127 | # if it contains the pattern |
---|
128 | self.files.extend([os.path.join(path, k) for k in os.listdir(path) |
---|
129 | if fnmatch.fnmatch(k, self.pattern)]) |
---|
130 | |
---|
131 | # find possible sub-directories in the path |
---|
132 | subdirs = [s for s in os.listdir(path) |
---|
133 | if os.path.isdir(os.path.join(path, s))] |
---|
134 | |
---|
135 | # do recursive calls for sub-direcorties |
---|
136 | if subdirs: |
---|
137 | for subdir in subdirs: |
---|
138 | self.__list_files__(os.path.join(path, subdir), callid=1) |
---|
139 | |
---|
140 | return |
---|
141 | |
---|
142 | def __str__(self): |
---|
143 | ''' |
---|
144 | @Description: |
---|
145 | Converts the list of files into a single string. |
---|
146 | The entries are sepereated by "," sign. |
---|
147 | |
---|
148 | @Input: |
---|
149 | self: instance of UioFiles |
---|
150 | Description see class documentation. |
---|
151 | |
---|
152 | @Return: |
---|
153 | files_string: string |
---|
154 | The content of the list as a single string. |
---|
155 | ''' |
---|
156 | |
---|
157 | filenames = [os.path.basename(f) for f in self.files] |
---|
158 | files_string = get_list_as_string(filenames, concatenate_sign=', ') |
---|
159 | |
---|
160 | return files_string |
---|
161 | |
---|
162 | def delete_files(self): |
---|
163 | ''' |
---|
164 | @Description: |
---|
165 | Deletes the files. |
---|
166 | |
---|
167 | @Input: |
---|
168 | self: instance of UioFiles |
---|
169 | Description see class documentation. |
---|
170 | |
---|
171 | @Return: |
---|
172 | <nothing> |
---|
173 | ''' |
---|
174 | |
---|
175 | for old_file in self.files: |
---|
176 | silent_remove(old_file) |
---|
177 | |
---|
178 | return |
---|