Major refactoring for readability

Author: Schallbert

AutoStructureFilesForDFplayer.py

@@ -19,31 +19,22 @@
 MP3FILEMARKER = ".mp3"
 
 
-def playerFSnumbers(indx, maxCnt):
-    """Returns a DFplayerMini-compatible way of numbering
-    files which is 001, 002, ... 255"""
-    if indx > maxCnt:
-        quitWithMessage("Error: player cannot process more than 100 folders")
-    return str(indx).zfill(len(str(maxCnt)))
-
-
 def replace_special_chars_in_path(line_of_playlist):
     """Make sure .m3u file's special characters are converted
     Replace most common UTF8 special characters"""
     return unquote(line_of_playlist)
 
 
-def quitWithMessage(messageString):
+def quit_with_message(message):
     """Quits script gracefully with message"""
-    print(messageString)
-    input("Press Enter to quit...")
+    print(message)
+    input("Press Enter to quit...\n")
     sys.exit()
 
 
 def find_m3u_filemarker(playlist_line):
     """relevant lines do not begin with # (sharp)
        relevant lines may begin with file:/// which has to be stripped"""
-
     if playlist_line.find(M3UINFOMARKER) == 0:
         return None
 
@@ -56,84 +47,89 @@ def find_m3u_filemarker(playlist_line):
     return playlist_line
 
 
+def get_name_from_id(indx, max_cnt):
+    """Returns a DFplayerMini-compatible way of numbering
+    files which is 001, 002, ... 255"""
+    if indx > max_cnt:
+        quit_with_message("Error: player cannot process more than %s items" % max_cnt)
+    return str(indx).zfill(len(str(max_cnt)))
+
+
 def get_target_file_name(index):
-    name = playerFSnumbers(index, MAXFILECNT)
+    name = get_name_from_id(index, MAXFILECNT)
     return os.sep + name + MP3FILEMARKER
 
 
-print("\
-Starting Conversion script for structuring files for DFplayerMini.\n\
-This script analyzes .m3u playlists and restructures their contents to a format\n\
-readable by the DFmini mp3 module.\n")
+def compile_list_of_playlists():
+    """if Playlist folder exists, print playlists to be evaluated."""
+    _list_of_playlists = os.listdir(PLAYLISTFLDRNAME)
+    for _playlist in _list_of_playlists:
+        if (_playlist.lower()).find(M3UFILETYPE) == -1:
+            msg = "--- ERROR --- PlayListM3U folder contains unsupported file types:  %s\n\
+    make sure you only place .m3u files here! Aborting." % _playlist
+            quit_with_message(msg)
+    _list_of_playlists.sort()
+    print("Folder with playlists found. Trying to create DFplayer folders and files for: %s" % _list_of_playlists)
+    return _list_of_playlists
+
+
+def create_folder(name):
+    try:
+        os.makedirs(name)
+    except:
+        quit_with_message("Couldn't create folder %s. Is directory read-only?" % name)
+
+
+print("Starting Conversion application for structuring files for DFplayerMini.\n\
+This script analyzes .m3u playlists and restructures their contents to a format readable by the DFmini mp3 module.\n")
 
 # get current working directory
 myPath = os.getcwd()
 # create directories for playlists and target folders
 plPath = os.path.join(os.sep, myPath, PLAYLISTFLDRNAME)
 crdPath = os.path.join(os.sep, myPath, CARDFLDRNAME)
-listOfPlaylists = None
+list_of_playlists = None
 
 print("Hooked to current working directory: %s" % myPath)
 
-# Check for playlist path
-if not os.path.exists(PLAYLISTFLDRNAME):
-    print("\
-Did not find folder containing m3u playlists.\n\
-Trying to create folder 'PlayListsM3U' for you.")
-    try:
-        os.makedirs(PLAYLISTFLDRNAME)
-    except:
-        quitWithMessage("Couldn't create folder. Is directory read-only?")
-        quitWithMessage("\
-Playlist folder successfully created: %s\n\
-Please move your playlists to this place before restarting the script." % PLAYLISTFLDRNAME)
+# Handle playlist folder
+if os.path.exists(PLAYLISTFLDRNAME):
+    list_of_playlists = compile_list_of_playlists()
 else:
-    # if Playlist folder exists, print playlists to be evaluated.
-    listOfPlaylists = os.listdir(PLAYLISTFLDRNAME)
-    for line in listOfPlaylists:
-        if (line.lower()).find(M3UFILETYPE) == -1:
-            msg = "--- ERROR --- PlayListM3U folder contains other file types than .m3u Playlists: %s\n\
-make sure you only place .m3u files here! Aborting." % line
-            quitWithMessage(msg)
-    listOfPlaylists.sort()
-    print("Folder containing playlists found. Will try creating DFplayer folders and files for:")
-    print(listOfPlaylists)
-
-# Check for album(folder) path
+    print("Did not find folder containing m3u playlists. Trying to create one for you...")
+    create_folder(PLAYLISTFLDRNAME)
+    quit_with_message("\
+            SUCCESS: Created folder %s\n\
+            Please move your playlists here and run the application again." % PLAYLISTFLDRNAME)
+
+# Handle SD card output folder
 if os.path.exists(CARDFLDRNAME):
-    # if Playlist folder exists, print playlists to be evaluated.
-    listOfCardFolders = os.listdir(CARDFLDRNAME)
-    print("Folder containing SDcard MP3 folders found. Will modify folder structure based on playlist input.")
-    print("Existing folders: " + str(listOfCardFolders))
+    print("SDcard MP3 folders found. Will modify contents based on playlist input.\n\
+    Existing folders: %s\n" % str(os.listdir(CARDFLDRNAME)))
 else:
-    print("\
-    Did not find folder containing SD card MP3 folders.\n\
-    Trying to create folder 'SDcardFolders' for you.\n \
-    You will find the files to transfer to your DFplayerMini's SD card in this folder.")
-    try:
-        os.makedirs(CARDFLDRNAME)
-    except:
-        quitWithMessage("--- ERROR --- Couldn't create folder. Is directory read-only?")
+    print("Did not find folder containing SD card MP3 folders.\n\
+    Trying to create folder %s for you.\n\
+    You will find the files to transfer to your DFplayerMini's SD card there" % CARDFLDRNAME)
+    create_folder(CARDFLDRNAME)
+
 
-if not listOfPlaylists:
-    quitWithMessage("--- ERROR --- No playlists found in folder. Place .m3u file(s) here, please. Aborting.")
+if not list_of_playlists:
+    quit_with_message("--- ERROR --- No playlists found in %s.\n\
+    Place .m3u file(s) here, please. Aborting." % PLAYLISTFLDRNAME)
 # create folders with correct naming to contain mp3 files
 folderIndex = 0
 target_folder_name = ""
 line_lower = ''
 # Go through all .m3u files in .m3u folder
-for playlist in listOfPlaylists:
+for playlist in list_of_playlists:
     folderIndex += 1
     # get folderIndexes right according to player's needs
-    target_folder_name = playerFSnumbers(folderIndex, MAXFLDRCNT)
+    target_folder_name = get_name_from_id(folderIndex, MAXFLDRCNT)
     target_folder_path = os.sep.join([crdPath, target_folder_name])
     if os.path.exists(target_folder_name):
-        print("Folder '%s' already exists. Will auto-overwrite contents." % target_folder_name)
+        print("Output Folder '%s' already exists. Will auto-overwrite contents." % target_folder_name)
     else:
-        try:
-            os.makedirs(target_folder_path)
-        except:
-            quitWithMessage("--- ERROR --- Couldn't create folder. Is directory read-only?")
+        create_folder(target_folder_path)
     # playlist open and show
     # try to find out if playlist has been renamed already, returns -1 if not
     if playlist.find(target_folder_name, 0, 2) == -1:
@@ -143,7 +139,7 @@ def get_target_file_name(index):
             os.rename(os.sep.join([plPath, playlist], os.sep.join([plPath, new_name])))
             playlist = new_name
         except:
-            quitWithMessage(" --- ERROR --- Couldn't rename playlist " + str(playlist) + ". Aborting.")
+            quit_with_message(" --- ERROR --- Couldn't rename playlist " + str(playlist) + ". Aborting.")
     playlistFile = open(os.sep.join([plPath, playlist]), "r")
     file_index = 0
     for line in playlistFile.readlines():
@@ -155,10 +151,10 @@ def get_target_file_name(index):
             try:
                 shutil.copy2(line, os.sep.join([target_folder_path, target_file_name]))
             except:
-                quitWithMessage(
+                quit_with_message(
                     "--- ERROR --- Couldn't copy file\n" + str(line) + " to:\n" + str(
                         target_folder_path) + "\nAborting.")
     print(
         "...completed for folder %d of %d: %s with %d files" % (
-            folderIndex, len(listOfPlaylists), playlist, file_index))
-quitWithMessage("--- SUCCESS --- All actions completed successfully.")
+            folderIndex, len(list_of_playlists), playlist, file_index))
+quit_with_message("--- SUCCESS --- All actions completed successfully.")

integration_test.py

@@ -15,7 +15,6 @@ def execute_target(tmp_path):
     os.system(TARGET)
 
 
-# executest the script "Software Under Test"
 @pytest.fixture
 def copy_target_to_temp(tmp_path):
     """places SUT in temporary path to prepare for execution"""
@@ -53,6 +52,7 @@ def test_creates_playlist_folder(tmp_path, copy_target_to_temp):
 
 
 def test_creates_sdcard_folder(tmp_path, copy_target_to_temp):
+    execute_target(tmp_path) # creates playlist folder, then terminates
     execute_target(tmp_path)
     d = tmp_path / SDCARDFOLDER
     assert d.exists()