Changeset 54a8a01 in flex_extract.git for python/UioFiles.py

Timestamp:

Aug 31, 2018, 7:50:37 AM (6 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

597d4d1

Parents:

e1228f3

Message:

restructuring, documentations and bug fixes

File:

• python/UioFiles.py (modified) (7 diffs)

python/UioFiles.py

@@ -34 +34 @@
 # @Class Content:
 #    - __init__
-#    - list_files
+#    - __str__
+#    - __list_files__
 #    - delete_files
 #
@@ -51 +52 @@
 # software specific module from flex_extract
 #import profiling
-from tools import silent_remove
+from tools import silent_remove, get_list_as_string
 
 # ------------------------------------------------------------------------------
@@ -66 +67 @@
     # CLASS FUNCTIONS
     # --------------------------------------------------------------------------
-    def __init__(self, pattern):
+    def __init__(self, path, pattern):
         '''
         @Description:
@@ -75 +76 @@
                 Description see class documentation.
 
+            path: string
+                Directory where to list the files.
+
             pattern: string
                 Regular expression pattern. For example: '*.grb'
@@ -82 +86 @@
         '''
 
+        self.path = path
         self.pattern = pattern
         self.files = None
+
+        self.__list_files__(self.path)
 
         return
 
     #@profiling.timefn
-    def list_files(self, path, callid=0):
+    def __list_files__(self, path, callid=0):
         '''
         @Description:
@@ -99 +106 @@
 
             path: string
-                Directory where to list the files.
+                Path to the files.
 
             callid: integer
@@ -129 +136 @@
         if subdirs:
             for subdir in subdirs:
-                self.list_files(os.path.join(path, subdir), callid=1)
+                self.__list_files__(os.path.join(path, subdir), callid=1)
 
         return
+
+    def __str__(self):
+        '''
+        @Description:
+            Converts the list of files into a single string.
+            The entries are sepereated by "," sign.
+
+        @Input:
+            self: instance of UioFiles
+                Description see class documentation.
+
+        @Return:
+            files_string: string
+                The content of the list as a single string.
+        '''
+
+        filenames = [os.path.basename(f) for f in self.files]
+        files_string = get_list_as_string(filenames, concatenate_sign=', ')
+
+        return files_string
 
     def delete_files(self):