Resolves #31 - Cleanup files (#53)

Author: VictorCarri

.gitignore

@@ -7,3 +7,16 @@ __pycache__/
 
 # Miscellaneous
 *.swp
+
+# Compiled Python files
+*.pyc
+
+# VIM settings
+.vimrc
+
+# Audio files
+*.flac
+*.m4a
+*.mp3
+*.ogg
+*.wav

cleansio/cleansio.py

@@ -1,27 +1,26 @@
 """ Displays the lyrics of an audio file """
 
-import os
+# Standard imports
 import sys
+from atexit import register
+from signal import signal, SIGABRT, SIGILL, SIGINT, SIGSEGV, SIGTERM
+
+# Imports from our modules
 from audio import AudioFile
 from speech import transcribe
+from utils import cleanup
 
 def valid_input():
     """ Validates the user's input """
     return len(sys.argv) > 1
 
-def cleanup():
-    """ Removes temporary files """
-    if 'CLEANSIO_TEMP_FILE' in os.environ:
-        os.remove(os.environ.get('CLEANSIO_TEMP_FILE'))
-    if 'CLEANSIO_SLICES_LIST' in os.environ:
-        slices_list_env_var = os.environ['CLEANSIO_SLICES_LIST']
-        slices_list = slices_list_env_var[2:-2].split('\', \'')
-        for slice_file in slices_list:
-            os.remove(slice_file)
-
 if __name__ == '__main__':
+    # Set the cleanup handler for each signal which we want to catch
+    for sig in (SIGABRT, SIGILL, SIGINT, SIGSEGV, SIGTERM):
+        signal(sig, cleanup)
+    # Register the cleanup function to be called if the program exits normally
+    register(cleanup)
     if valid_input():
         transcribe(AudioFile(sys.argv[1]))
-        cleanup()
     else:
         print('Please see the README.')

cleansio/utils/__init__.py

@@ -0,0 +1,3 @@
+""" Runs after every import """
+
+from .cleanup import cleanup

cleansio/utils/cleanup.py

@@ -0,0 +1,36 @@
+""" Cleans up temporary files after the program runs """
+
+# environ - To read the environment variables which we use for communication
+# remove  - To remove the temporary files
+from os import environ, remove
+import sys
+
+# Cleans up files on normal or abnormal exit
+# The arguments are unused - they are only here to satisfy atexit.
+def cleanup(_sig_num=None, _cur_stack_frame=None):
+    """ Removes temporary files """
+    remove_temp_file()
+    remove_slices()
+    sys.exit()
+
+def remove_temp_file():
+    """ Removes converted WAV file """
+
+    if 'CLEANSIO_TEMP_FILE' in environ:
+        temp_file = environ.get('CLEANSIO_TEMP_FILE')
+        try:
+            remove(temp_file)
+        except FileNotFoundError:
+            pass
+
+def remove_slices():
+    """ Removes each slice of the converted WAV file """
+
+    if 'CLEANSIO_SLICES_LIST' in environ:
+        slices_list_env_var = environ['CLEANSIO_SLICES_LIST']
+        slices_list = slices_list_env_var[2:-2].split('\', \'')
+        for slice_file in slices_list:
+            try:
+                remove(slice_file)
+            except FileNotFoundError:
+                pass

tests/test_cleanup.py

@@ -0,0 +1,73 @@
+#pylint: skip-file
+
+# Standard imports
+from uuid import uuid4
+from random import randint
+import os
+import pytest
+
+# Function to test
+from cleansio import cleanup
+
+# Tests the cleanup function
+def test_cleanup():
+    ## Temporary file ##
+
+    # Temp file shouldn't exist
+    if 'CLEANSIO_TEMP_FILE' in os.environ: # Temp file var exists
+        # Fetch the name of the temp file
+        temp_file = os.environ.get('CLEANSIO_TEMP_FILE')
+    else: # Temp file variable doesn't exist
+        temp_file_name = str(uuid4().hex) # Fetch a random temporary file name
+        # Create a path to the temporary file
+        temp_file = "./{0}".format(temp_file_name)
+        os.environ['CLEANSIO_TEMP_FILE'] = temp_file # For function
+
+    create_temp_file(temp_file)
+
+    ## Slices ##
+    slices_list = [] # Holds names of slice files. Used later on in test.
+
+    if 'CLEANSIO_SLICES_LIST' in os.environ: # Slices exist
+        slices_list_env_var = os.environ['CLEANSIO_SLICES_LIST']
+        slices_list = slices_list_env_var.split[2:-2].split('\', \'')
+        for slice_file in slices_list:
+            create_temp_file(slice_file)
+    else: # Slices don't exist
+        # Generate a random number of slice files
+        for i in range(0,randint(3, 10)+1):
+            # Choose a random name for the slice which we'll generate
+            temp_slice_name = str(uuid4().hex)
+            create_temp_file(temp_slice_name)
+            slices_list.append(temp_slice_name)
+        os.environ['CLEANSIO_SLICES_LIST'] = str(slices_list)
+
+    with pytest.raises(SystemExit) as pytest_e: # Ignore sys.exit()
+        cleanup() # Run the function
+
+    ## Checking whether or not the function worked ##
+    # The temporary file shouldn't exist after the cleanup function runs
+    assert(not exists(temp_file))
+
+    for slice in slices_list: # None of the "slice files" should exist
+        assert(not exists(slice))
+
+def exists(file_name):
+    """ Checks whether a file with the given name exists. """
+    try:
+        f = open(file_name, "r")
+        f.close()
+        return True
+    except FileNotFoundError:
+        return False
+
+def create_temp_file(file_name):
+    """ Creates a temp file with the given name, if it doesn't already exist """
+    if not exists(file_name):
+        f = open(file_name, "w")
+        fconts = str(uuid4().hex)
+        f.write(fconts)
+        f.close()
+    else:
+        errStr = "File {0} already exists, won't overwrite".format(file_name)
+        raise FileExistsError(errStr)