refactor get_standard_folder_name() and added proper docstring

refit/src/modules/librefit.py

@@ -15,43 +15,34 @@ def get_standard_name_number(current_number, number_str_length):
 
 
 def get_standard_folder_name(name) -> str:
-    """Takes the --name argument as input and returns an default value if no name is provided
+    """Returnes a standard name either from a list or the default value.
-    or takes the first element of the list, passed to the argument.
     
+    This function sanitizes the input, which gets passed as a list or None from
+    argparse. The function either chooses the first entry of the list, given to 
+    the --name argument or returns the default value 'directory'
     
-    Example:
+    Args:
-    None -> .
+        name (list[str] | None):    A list of names if passed to the --name argument
-    ["directory"] -> dirctory
+                                    or None if no name is passed.
-    ["folder", "directory"] -> folder
+                                    
-    
+    Returns:
-    Returns str
+        str:    The file name. Returns 'file' as default value if name argument is 'None'
+                otherwise the first element of the list.
+                                    
+    Examples:
+        >>> get_standard_file_name(None)
+        'file'
+        >>> get_standard_file_name(["example"])
+        'example'
+        >>> get_standard_file_name(["directory_name", "example"])
+        'directory_name'
     """
-    logger.debug("get_standard_folder_name() call")
-    if name is None:
-        standard_folder_name = "directory"
-        logger.info(
-            f"No name for folder assigned, continue with default value '{standard_folder_name}'."
-        )
-    else:
-        logger.debug(
-            f"FUNC: get_standard_folder_name() Properties of name='{name}': Type: {type(name)}, Length: {len(name)}"
-        )
 
-        # Checks if multiple names are passed to the --name argument
+    logger.debug(f"FUNC: get_standard_folder_name() MSG: entered function with value: '{name}'")
-        # if so, only the first one gets used.
+    standard_folder_name = name[0] if name is not None else "directory"
-        if len(name) > 1:
+
-            _NAMES_WARNING = f"{len(name)} names given, only one required.\nContinuing with '{name[0]}' as name."
+    logger.debug(f"FUNC: get_standard_folder_name() MSG: exiting function with folder name: '{standard_folder_name}'")
-            logger.warning("FUNC: get_standard_folder_name()" + _NAMES_WARNING)
-            print(_NAMES_WARNING)
-            standard_folder_name = name[0]
 
-            logger.debug(
-                f"FUNC: get_standard_folder_name() Properties of folder name '{standard_folder_name}': Type: {type(standard_folder_name)}"
-            )
-        else:
-            standard_folder_name = name[0]
-            logger.debug("Continuing with expected input")
-    logger.debug("FUNC: get_standard_folder_name() exit.")
     return standard_folder_name
 
 
@@ -87,4 +78,3 @@ def get_standard_file_name(name) -> str:
     return standard_file_name
 
 
-#test