Cdir: Refactor Python version

Author: TristanBandat

TODO.md

@@ -16,11 +16,9 @@ The TODOs of the released versions will be moved to the
 - [X] Manual argument handling (C)<br>
     Therefore string args will be possible.
 
-- [ ] Code Cleanup (Python)<br>
+- [X] Code Cleanup (Python)<br>
     Implement data structure as used in the C version.
 
-
-
 - [X] Convert TODO to Markdown file
 
 - [X] Move the old version TODOs into the separate [OLD_VERSIONS.md][old_versions-url] file.

cdir.py

@@ -6,30 +6,30 @@
 VERSION = '1.0.5'
 
 
-def get_foldername(folder_names):
+def get_dir_name(dir_names):
     """
-    This function searches for the foldername which appears the most
+    This function searches for the directory name which appears the most
     in a given folder.
-    :param folder_names: string list
-    :return: foldername
+    :param dir_names: string list
+    :return: dir_name: string
     """
     match_list_len = []
-    # check if there are existing folders
-    if len(folder_names) == 0:
+    # check if there are existing directories
+    if len(dir_names) == 0:
         print("No folder(s) found.")
         exit()
-    # go through all the folder names
-    for pattern in folder_names:
-        # finding all redundant folder names
-        match_list = re.findall(pattern, str(folder_names))
+    # go through all the directory names
+    for pattern in dir_names:
+        # finding all redundant directory names
+        match_list = re.findall(pattern, str(dir_names))
         # appending there frequency to a list
         match_list_len.append(len(match_list))
     # get the folder with the highest occurrence
     max_occurrence = [i for i, j in enumerate(match_list_len) if j == max(match_list_len)][0]
     # look up how the folder name is called
-    foldername = folder_names[max_occurrence]
+    dir_name = dir_names[max_occurrence]
     # return the folder name
-    return foldername
+    return dir_name
 
 
 def help_text():
@@ -84,25 +84,25 @@ def main():
             try:
                 # get the folder name and the number separate
                 numbers.append(int(element_list[-1]))
-                # putting the foldername back together
+                # putting the directory name back together
                 folder_name_str = ''
                 for x in element_list[:-1]:
                     folder_name_str += '_' + x
                 # remove additional underscores if they occur
                 if folder_name_str[0] == '_':
                     folder_name_str = folder_name_str[1:]
-                # append foldername to list
+                # append directory name to list
                 folder_names.append(folder_name_str)
                 # get the digit count of the number -> this part fails pretty easily
                 numbers_num_digits.append(int(len(element_list[-1])))
             except ValueError:
                 print(f"Was not able to convert string to int of folder '{element}'")
                 continue
     # name of the new folder
-    foldername = ""
+    directory_name = ""
     # if no additional argument was given
     if command_line_args.__len__() == 1 or command_line_args[1] == '':
-        foldername = get_foldername(folder_names)
+        directory_name = get_dir_name(folder_names)
     # if a additional command line argument is given
     elif command_line_args.__len__() == 2 and command_line_args[1] != '':
         # help flag is set
@@ -119,28 +119,28 @@ def main():
             print('CDIR Version {}\n'.format(VERSION))
             exit(0)
         elif command_line_args[1].isdigit():
-            foldername = get_foldername(folder_names)
+            directory_name = get_dir_name(folder_names)
             num_new_dirs = int(command_line_args[1])
         else:
-            # given argument is a foldername
-            foldername = command_line_args[1]
+            # given argument is a directory name
+            directory_name = command_line_args[1]
     # if a directory name and number of directories is given
     elif command_line_args.__len__() == 3:
         if command_line_args[1][0] == '-' or not command_line_args[2].isdigit():
             raise SyntaxError("Command not properly used!")
-        # given argument is a foldername
-        foldername = command_line_args[1]
+        # given argument is a directory name
+        directory_name = command_line_args[1]
         num_new_dirs = int(command_line_args[2])
     else:
         # something went wrong
         raise SyntaxError("Command not properly used!")
-    # highest number of chosen foldername
+    # highest number of chosen directory name
     highest_number = -1
     # length of the number (needed for given 0s before the number)
     number_length = -1
-    # get the highest number of the folder names
+    # get the highest number of the directory numbering
     for i, element in enumerate(folder_names):
-        if element == foldername and highest_number < numbers[i]:
+        if element == directory_name and highest_number < numbers[i]:
             highest_number = numbers[i]
             number_length = numbers_num_digits[i]
     # set the new number
@@ -157,11 +157,11 @@ def main():
         # update the placeholder counter
         if new_number_digit_count > highest_number_digit_count and placeholder_count > 0:
             placeholder_count -= 1
-        # create the new folder name
-        new_foldername = foldername + '_' + ('0' * placeholder_count) + str(new_number)
-        print(f"Creating directory {new_foldername}")
-        # create the new folder
-        os.makedirs(new_foldername)
+        # put the directory name together
+        new_dir_name = directory_name + '_' + ('0' * placeholder_count) + str(new_number)
+        print(f"Creating directory {new_dir_name}")
+        # create the new directory
+        os.makedirs(new_dir_name)
     # everything went fine -> print and terminate
     print("done.")