Ameliorations method join of FileNames.

Alain Klotz
1 parent cb1da290
Showing 1 changed file with 85 additions and 16 deletions Show diff stats
src/guitastro/filenames.py
@@ -1966,9 +1966,11 @@ class FileNames(FileNamesException, GuitastroTools):
         """
         subdir = os.path.dirname(filename)
         fname = filename
-        if self.fcontext_value('naming') != self.NAMING_NONE:
-            nkw = self.naming_get(filename)
-            if outfname:
+        nkw = self.naming_get(filename)
+        if outfname:
+            if self.fcontext_value('naming') == self.NAMING_NONE:
+                fname = nkw['fname']
+            else:
                 fname = self.naming_set(nkw)
         if self.fcontext_value('pathnaming') == self.NAMING_PYROS_IMG1:
             d = nkw['date']
@@ -1988,7 +1990,6 @@ class FileNames(FileNamesException, GuitastroTools):
             fullname = self.pathnaming_set(pparam, nkw)
             #print(f"fullname={fullname}")
             subdir = os.path.dirname(fullname)
-        #print(f"path={path}")
         if outfname:
             return subdir, fname
         return subdir
@@ -2265,9 +2266,63 @@ class FileNames(FileNamesException, GuitastroTools):
         dico['absolute'] = str(absolute)
         return dico
  
-    def join(self):
+    def join(self, filename:str = "") -> str:
+        """Join the four parts of a context to get a full file name.
+
+        Args:
+
+            filename: A file name from which the fname will be extracted and subdir calculated. Initial path and extensions are lost. If filename is "" the current contents of the context is used to generate the output full file name.
+
+        Returns:
+
+            The full file name in a string (rootdir, subdir, fname, extension)
+
+        First consider the following file context:
+
+        ::
+
+            fn = FileNames()
+            fn.longitude(165.85944)
+            fn.fcontext_create("my_context", "Test")
+            fn.fcontext = "my_context"
+            fn.rootdir = "/tmp"
+            fn.extension = ".fit"
+
+        Use the method update_subdir_fname_from_filename to update 'subdir' and 'fname' in the context from the filename. Then use join whith no parameter:
+
+        ::
+
+            in_fullname = "/home/myuser/messier63.fits.gz"
+            fn.update_subdir_fname_from_filename(in_fullname)
+            out_fullname = fn.join()
+
+        out_fullname should be '/tmp/messier63.fit'.
+
+        The following example do the same thing but with no use of the method update_subdir_fname_from_filename:
+
+        ::
+
+            in_fullname = "/home/myuser/messier63.fits.gz"
+            out_fullname = fn.join(in_fullname)
+
+        """
+        if filename != "":
+            self.update_subdir_fname_from_filename(filename)
         return os.path.join(self.rootdir, self.subdir, self.fname + self.extension)
  
+    def joinabs(self, filename:str = ""):
+        """Join the four parts of a context to get a full file name with absolute path.
+
+        Args:
+
+            filename: A file name from which the fname will be extracted and subdir calculated. Initial path and extensions are lost. If filename is "" the current contents of the context is used to generate the output full file name.
+
+        Returns:
+
+            The full file name in a string with absolute path (rootdir, subdir, fname, extension)
+        """
+        return os.path.abspath(self.join(filename))
+
     def glob(self, wildcard:str, *args) -> list:
         """Glob from a wildcard. Add -R to be recursive.
         """
@@ -2941,8 +2996,8 @@ class FileNames(FileNamesException, GuitastroTools):
  
 if __name__ == "__main__":
  
-    default = 14
-    example = input(f"Select the example (0 to 14) ({default}) ")
+    default = 15
+    example = input(f"Select the example (0 to 15) ({default}) ")
     try:
         example = int(example)
     except:
@@ -3201,9 +3256,8 @@ if __name__ == &quot;__main__&quot;:
         # --- Place an image at the good place
         fn.fcontext = "pyros_img_L0"
         in_fullname = r"/srv/work/L0A_20211026_194522999983_1_TNC_CH1_0123456789_001_001.fits.gz"
-        param = fn.naming_get(in_fullname)
-        fn.fname = fn.naming_set(param)
-        out_fullname = fn.join()
+        #fn.update_subdir_fname_from_filename(in_fullname)
+        out_fullname = fn.join(in_fullname)
         print(f"==== Copy an image in the good path (context {fn.fcontext_value('description')}) ====")
         print(f"{in_fullname=:}")
         print(f"{out_fullname=:}")
@@ -3211,8 +3265,8 @@ if __name__ == &quot;__main__&quot;:
         # --- Place a sequence at the good place
         fn.fcontext = "pyros_seq"
         in_fullname = r"/srv/work/P001_20211026_1_TNC_0123456789.p"
-        fn.update_subdir_fname_from_filename(in_fullname)
-        out_fullname = fn.join()
+        #fn.update_subdir_fname_from_filename(in_fullname)
+        out_fullname = fn.join(in_fullname)
         print(f"\n==== Copy sequence in the good path (context {fn.fcontext_value('description')}) ====")
         print(f"{in_fullname=:}")
         print(f"{out_fullname=:}")
@@ -3229,8 +3283,8 @@ if __name__ == &quot;__main__&quot;:
         param['plane'] = 1
         param['frame'] = 1
         fname = fn.naming_set(param)
-        fn.update_subdir_fname_from_filename(fname)
-        out_fullname = fn.join()
+        #fn.update_subdir_fname_from_filename(fname)
+        out_fullname = fn.join(fname)
         print(f"\n==== Create an image in the good path (context {fn.fcontext_value('description')}) ====")
         print(f"{out_fullname=:}")
  
@@ -3242,7 +3296,22 @@ if __name__ == &quot;__main__&quot;:
         fn.fcontext = "pyros_img_L1"
         param['ftype'] = "L1A"
         fname = fn.naming_set(param)
-        fn.update_subdir_fname_from_filename(fname)
-        out_fullname = fn.join()
+        #fn.update_subdir_fname_from_filename(fname)
+        out_fullname = fn.joinabs(fname)
         print(f"\n==== Process an image L0 and save in the good path (context {fn.fcontext_value('description')}) ====")
         print(f"{out_fullname=:}")
+
+    if example == 15:
+        """
+        Manage default context
+        """
+        fn = FileNames()
+
+        fn.fcontext_create("my_context", "Test")
+        fn.fcontext = "my_context"
+        fn.rootdir = "/tmp"
+        fn.extension = ".fit"
+
+        in_fullname = "/home/myuser/messier63.fits.gz"
+        out_fullname = fn.join(in_fullname)
+        print(out_fullname)