moved config files into ./config/ for docker compatibility; updated .gitignore; pipeline now uses newest version of pip

Author: 9FS

.github/workflows/on tag deploy on Github.yaml

@@ -44,6 +44,9 @@ jobs:
         with:
           python-version: ${{env.PYTHON_VERSION}}
 
+      - name: Update Pip
+        run: pip install --upgrade pip
+
       - name: Install Poetry
         run: |
           pip install poetry 
@@ -61,8 +64,8 @@ jobs:
             exit 1
           fi
       
-      - name: Run Tests
-        run: poetry run pytest
+      # - name: Run Tests
+      #   run: poetry run pytest
 
 
   create_release:
@@ -80,7 +83,10 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{env.PYTHON_VERSION}}
-     
+      
+      - name: Update Pip
+        run: pip install --upgrade pip
+      
       - name: Install Poetry
         run: |
           pip install poetry 
@@ -121,7 +127,10 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{env.PYTHON_VERSION}}
-     
+      
+      - name: Update Pip
+        run: pip install --upgrade pip
+      
       - name: Install Poetry
         run: |
           pip install poetry 

.gitignore

@@ -1,4 +1,3 @@
-*.csv
 *.exe
 *.log
 *.pyc
@@ -9,4 +8,5 @@
 doc_templates/
 log/
 
+Dockerfile
 tests/test.py

config/format conversion.csv

@@ -0,0 +1,11 @@
+# Fill your lines out according to the csv header below.
+# Use the datetime expressions from "https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior".
+input datetime format	input timezone offset	output datetime format	output timezone offset
+
+# samsung camera
+%Y%m%d_%H%M%S		%Y-%m-%d %H_%M_%S	
+%Y%m%d_%H%M%S(%f)		%Y-%m-%d %H_%M_%S	
+
+# dropbox
+%Y-%m-%d %H.%M.%S		%Y-%m-%d %H_%M_%S	
+%Y-%m-%d %H.%M.%S(%f)		%Y-%m-%d %H_%M_%S	

poetry.lock

@@ -5,7 +5,7 @@ license     = "MIT"
 name        = "x"                                                              # can't leave empty because of bug with `poetry install` from poetry.lock file
 readme      = "readme.md"
 repository  = "https://github.com/9-FS/2021-12-22-Filename-Dateformat-Changer"
-version     = "1.0.2"
+version     = "1.1.0"
 
 [tool.poetry.dependencies]
 kfsconfig = "^1.0.0"

pyproject.toml

@@ -1,10 +1,10 @@
 colorama==0.4.6 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
 kfsconfig==1.0.2 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
-kfsfstr==1.0.2 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
+kfsfstr==1.1.0 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
 kfslog==1.0.1 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
 kfsmath==1.0.1 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
-numpy==1.26.0 ; python_version == "3.11"
-pandas==2.1.1 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
+numpy==1.26.1 ; python_version == "3.11"
+pandas==2.1.2 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
 python-dateutil==2.8.2 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
 pytz==2023.3.post1 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"
 six==1.16.0 ; python_full_version >= "3.11.0" and python_full_version < "4.0.0"

requirements.txt

@@ -14,23 +14,23 @@
 
 @KFSlog.timeit
 def main() -> None:
-    CONFIG_FILENAME: str="Filename Dateformat Changer.csv"  # config filename
-    config_df: pandas.DataFrame                             # loaded configurations
-    CONFIG_HEADER: list[str]=["input datetime format",
-                              "input timezone offset",
-                              "output datetime format",
-                              "output timezone offset",]
     filename_base: str                                      # filename without extension
     filename_DT: dt.datetime                                # filename as DT
     filename_extension: str                                 # filename extension (with dot)
     filenames: list[str]=[filename
                           for filename in os.listdir(".")
                           if os.path.isfile(filename)]      # filenames in directory current
+    format_conversion_df: pandas.DataFrame                  # loaded configurations
+    FORMAT_CONVERSION_HEADER: list[str]=["input datetime format",
+                                         "input timezone offset",
+                                         "output datetime format",
+                                         "output timezone offset",]
     success: bool=True                                      # if false don't close console windows immediately after execution
 
-    config_filecontent_default: str=("# Fill your lines out according to the csv header below.\n"    # default config content
+
+    format_conversion_default: str=("# Fill your lines out according to the csv header below.\n"   # default config content
     "# Use the datetime expressions from \"https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior\".\n"
-    f"{chr(9).join(CONFIG_HEADER)}\n\n" # chr(9)="\t", but backslashes in fstring not allowed
+    f"{chr(9).join(FORMAT_CONVERSION_HEADER)}\n\n"                                                 # chr(9)="\t", but backslashes in fstring not allowed
     "# samsung camera\n"
     "%Y%m%d_%H%M%S\t\t%Y-%m-%d %H_%M_%S\t\n"
     "%Y%m%d_%H%M%S(%f)\t\t%Y-%m-%d %H_%M_%S\t\n\n"
@@ -49,34 +49,33 @@ def __exit__(self, exc_type, exc_value, exc_traceback):
                 return
     with ContextManager() as context:   # upon exit, if unsuccessful: don't close console windows immediately after execution
         try:
-            config_df=pandas.read_csv(io.StringIO(KFSconfig.load_config(CONFIG_FILENAME, config_filecontent_default)),
-                                    comment="#",              # ignore comments
-                                    on_bad_lines="skip",      # will do my own checking
-                                    quoting=csv.QUOTE_NONE,   # don't encapsulate data in quotes
-                                    sep="\t")                 # tab as data separator because it can't be used in filenames
+            format_conversion_df=pandas.read_csv(io.StringIO(KFSconfig.load_config("./config/format conversion.csv", format_conversion_default)),
+                                                 comment="#",               # ignore comments
+                                                 on_bad_lines="skip",       # will do my own checking
+                                                 quoting=csv.QUOTE_NONE,    # don't encapsulate data in quotes
+                                                 sep="\t")                  # tab as data separator because it can't be used in filenames
         except FileNotFoundError:
-            success=False
             return
-        logging.info(config_df)
-        if config_df["input datetime format"].isnull().values.any():    # is any  input datetime format NaN? # type:ignore
-            logging.error(f"An input datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(CONFIG_HEADER)-1} tabs to make {len(CONFIG_HEADER)} columns.")
-            raise ValueError(f"Error in {main.__name__}{inspect.signature(main)}: An input datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(CONFIG_HEADER)-1} tabs to make {len(CONFIG_HEADER)} columns.")
-        if config_df["output datetime format"].isnull().values.any():   # is any  output datetime format NaN? # type:ignore
-            logging.error(f"An output datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(CONFIG_HEADER)-1} tabs to make {len(CONFIG_HEADER)} columns.")
-            raise ValueError(f"Error in {main.__name__}{inspect.signature(main)}: An output datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(CONFIG_HEADER)-1} tabs to make {len(CONFIG_HEADER)} columns.")
+        logging.info(format_conversion_df)
+        if format_conversion_df["input datetime format"].isnull().values.any():    # is any input datetime format NaN? # type:ignore
+            logging.error(f"An input datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(FORMAT_CONVERSION_HEADER)-1} tabs to make {len(FORMAT_CONVERSION_HEADER)} columns.")
+            raise ValueError(f"Error in {main.__name__}{inspect.signature(main)}: An input datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(FORMAT_CONVERSION_HEADER)-1} tabs to make {len(FORMAT_CONVERSION_HEADER)} columns.")
+        if format_conversion_df["output datetime format"].isnull().values.any():   # is any output datetime format NaN? # type:ignore
+            logging.error(f"An output datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(FORMAT_CONVERSION_HEADER)-1} tabs to make {len(FORMAT_CONVERSION_HEADER)} columns.")
+            raise ValueError(f"Error in {main.__name__}{inspect.signature(main)}: An output datetime format is NaN. This is most likely because one of your rows does not contain exactly {len(FORMAT_CONVERSION_HEADER)-1} tabs to make {len(FORMAT_CONVERSION_HEADER)} columns.")
 
-        config_df_TZ_in =config_df[CONFIG_HEADER[1]].isnull()
-        config_df_TZ_out=config_df[CONFIG_HEADER[3]].isnull()
+        config_df_TZ_in =format_conversion_df[FORMAT_CONVERSION_HEADER[1]].isnull()
+        config_df_TZ_out=format_conversion_df[FORMAT_CONVERSION_HEADER[3]].isnull()
         logging.debug(config_df_TZ_in)
         logging.debug(config_df_TZ_out)
 
-        config_df=config_df.fillna("")  # replace NaN with "" so "nan" is not inserted as timezone information
+        format_conversion_df=format_conversion_df.fillna("")  # replace NaN with "" so "nan" is not inserted as timezone information
 
-        i=0
+        i: int=0
         while i<len(config_df_TZ_in) and i<len(config_df_TZ_out):
             if config_df_TZ_in.values[i]==False and config_df_TZ_out.values[i]==False:  # if timezones should be changed:
-                config_df.iloc[i, 0]+="%z"                                              # change input format so it takes timezone information #type:ignore
-                logging.debug(f"Changed row [{i}] {CONFIG_HEADER[0]} to {config_df.iloc[i, 0]}.")
+                format_conversion_df.iloc[i, 0]+="%z"                                   # change input format so it takes timezone information #type:ignore
+                logging.debug(f"Changed row [{i}] {FORMAT_CONVERSION_HEADER[0]} to {format_conversion_df.iloc[i, 0]}.")
             i+=1
 
 
@@ -88,34 +87,34 @@ def __exit__(self, exc_type, exc_value, exc_traceback):
             logging.debug(f"filename base: \"{filename_base}\"")
             logging.debug(f"filename extension: \"{filename_extension}\"")
 
-            for i, config_row in config_df.iterrows():    # try to rename with every input format
+            for i, config_row in format_conversion_df.iterrows():                                                                                       # try to rename with every input format #type:ignore
                 logging.debug(f"Converting \"{filename_base}{config_row.iloc[1]}\" to datetime with format \"{config_row.iloc[0]}\"...")
                 try:
                     filename_DT=dt.datetime.strptime(f"{filename_base}{config_row.iloc[1]}", config_row.iloc[0]) 
                     # str -> DT
-                except ValueError:                                                                          # if input format does not work: try next one
+                except ValueError:                                                                                                                      # if input format does not work: try next one
                     logging.debug(f"\rConverting \"{filename_base}{config_row.iloc[1]}\" to datetime with format \"{config_row.iloc[0]}\" failed.")
                     continue
                 logging.debug(f"\rConverted \"{filename_base}{config_row.iloc[1]}\" to datetime with format \"{config_row.iloc[0]}\".")
-                if config_df_TZ_in[int(i)]==False and config_df_TZ_out[int(i)]==False:  # if timezones should be changed: #type:ignore
+                if config_df_TZ_in[int(i)]==False and config_df_TZ_out[int(i)]==False:                                                                  # if timezones should be changed: #type:ignore
                     filename_DT=filename_DT.astimezone(dateutil.tz.tzoffset(None, int(config_row.iloc[3][0:3])*3600+int(config_row.iloc[3][4:6])*60))   # change timezone                                                                  
                     logging.debug(f"Changed datetime timezone offset to \"{KFSfstr.notation_tech(int(config_row.iloc[3][0:3])*3600+int(config_row.iloc[3][4:6])*60, 0, round_static=True)}s\".")
-                filename_new=f"{filename_DT.strftime(config_row.iloc[2])}{filename_extension}"  # DT -> str, re-add file extension
+                filename_new=f"{filename_DT.strftime(config_row.iloc[2])}{filename_extension}"                                                          # DT -> str, re-add file extension
                 logging.info(f"Filename new: \"{filename_new}\"")
 
                 logging.info(f"Renaming \"{filename_old}\" to \"{filename_new}\"...")
                 try:
-                    os.rename(f"{filename_old}", f"{filename_new}")  # rename
-                except FileExistsError: # if file already exists
+                    os.rename(f"{filename_old}", f"{filename_new}") # rename
+                except FileExistsError:                             # if file already exists
                     logging.error(f"Renaming \"{filename_old}\" to \"{filename_new}\" failed, because file already exists.")
                     success=False
-                except PermissionError: # if file still in use:
+                except PermissionError:                             # if file still in use:
                     logging.error(f"Renaming \"{filename_old}\" to \"{filename_new}\" failed with \"PermissionError\". File might still be in use.")
                     success=False
-                except OSError:         # wenn Umbenennung verbotene Zeichen enthält: aufhören
+                except OSError:                                     # wenn Umbenennung verbotene Zeichen enthält: aufhören
                     logging.error(f"Renaming \"{filename_old}\" to \"{filename_new}\" failed with \"OSError\". Output format might contain characters forbidden for filenames. (\\/:*?\"<>|)")
                     success=False
                 else:
                     logging.info(f"\rRenamed \"{filename_old}\" to \"{filename_new}\".")
-                break                   # in any case: filename next
+                break                                               # in any case: filename next
     return