post_setup.py

import os
import shutil
import traceback
import logging

logging.basicConfig(format='%(message)s')
log = logging.getLogger()
log.addHandler(logging.FileHandler("CasterInstall.log", "w"))

supporturl = (
    "\nCaster: Report Error to https://github.com/dictation-toolbox/caster/issues\n")


# On error ensures log file is accessible on desktop to end-user.
# Needed due to temporary directory during PIP install
class RunPostInstall:
    def __init__(self):
        # Kicks off the post install script
        if self._setup() is not "CI":  # Do not display command prompt if running continuous integration.
            self._display()

    def _copy_log(self):
        directory = os.path.join(os.environ['USERPROFILE'], "Desktop")
        shutil.copy("CasterInstall.log", os.path.join(directory, "CasterInstall.log"))

    # Returns directory path for caster and engine "wrs" or "dns"
    def _find_directory(self):
        try:
            from natlinkcore import natlinkstatus # pylint: disable=import-error
            status = natlinkstatus.NatlinkStatus()
            directory = status.getUserDirectory()
            return directory, "dns"  # NatLink MacroSystem Directory
        except ImportError:
            directory = os.path.join(os.environ['USERPROFILE'], "Desktop")
            return directory, "wrs"  # Windows User Desktop Directory

    # Copies to directory and renames _caster.py based on engine to caster or UserDirectory directory
    def _setup(self):
        directory, engine = self._find_directory()
        if os.path.isdir(directory) and not directory == os.getcwd():
            try:
                if engine is "dns":
                    shutil.copy("_caster.py", directory)
                    log.warning(
                        "\nCaster: NatLink found.\n"
                        "Defaulting to Dragon NaturallySpeaking Engine\n"
                        "Caster will automatically start with Dragon NaturallySpeaking\n")
                if engine is "wrs":
                    shutil.copy("_caster.py", os.path.join(directory, "start_caster.py"))
                    log.warning(
                        "\nCaster: NatLink not found.\n"
                        "Defaulting to Windows Speech Recognition Engine\n"
                        "Click on 'start_caster.py' on desktop to launch WSR with Caster\n")
            except Exception:
                log.warning('Generic Exception: ' + traceback.format_exc()
                            + "\nManually uninstall Caster `pip uninstall castervoice -y`\n" + supporturl)
                self._copy_log()
        else:  # Manual error handling For dir invalid path or copying `_caster.py` to same directory.
            if engine is "dns":
                log.warning(
                    "Source and destination for copying `_caster.py` is the same directory or directory path not valid."
                    "\nNatlinkStatus function may have failed to obtain Natlink user directory\n"
                    "Check if: `" + str(directory) + "` is a valid path." + "\n" + supporturl +
                    "\nManually uninstall Caster `pip uninstall castervoice -y`")
                self._copy_log()
            else:
                print("Bypassing SameFileError for CI environment")
                return 'CI'

    # Displays CasterInstall.log contents in command prompt window
    # Needs to be reimplemented to be OS agnostic.
    # Difficult to reimplement do to PIP without reading log file.
    def _display(self):
        try:
            casterlog = os.path.join(os.getcwd(), "CasterInstall.log")
            log.warning("Close window when finished with instructions to continue")
            command = ("start /wait cmd /k type " + casterlog)
            exitcode = os.system(command)
            if exitcode != 0:
                log.warning("\n An error has occurred to display log file. Exit Code: " +
                            str(exitcode) + supporturl)
                self._copy_log()
        except Exception:
            log.warning('\n An error has occurred to display log file. \n' +
                        traceback.format_exc() + supporturl)
            self._copy_log()