qdbg.cli

Complexity

Total Complexity

11

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Importance

Changes

0

3 Functions

Rating	Name	Duplication	Size	Complexity
B	main()	0	45	6
A	parse_traceback()	0	19	4
A	get_search_url()	0	13	1

#!/usr/bin/python3

import logging
import subprocess
import sys
import webbrowser
from urllib.parse import quote_plus
from typing import List


class QdbgError(Exception):
    pass


def main(args: List[str]) -> None:
    """Run a command with special error handling. If the command returns a non-zero
    return code, this function will automatically open a new webbrowser tab and
    search for the error message.

    Args:
        *args*: a shell command to run

    Exceptions:
        * A QdbgError is raised if no command is provided
        * A QdbgError is raised if no default webbrowser if found
        * The program exits if a FileNotFoundError occurs

    Returns:
        None
    """

    if len(args) < 1:  # pragma: no cover
        logging.error("Qdbg requires a command")
        raise QdbgError

    try:
        child_proc = subprocess.run(args=args, check=False, capture_output=True)

        # On non-zero return code, raise subprocess.CalledProcessError
        child_proc.check_returncode()

        # On success, flush output to stdout
        print(child_proc.stdout.decode().rstrip(), flush=True)

    except subprocess.CalledProcessError:
        search_url = get_search_url(cmd=args[0], stderr=child_proc.stderr.decode())

        if not webbrowser.open_new_tab(url=search_url):
            logging.error("Unable to open default browser - is one installed?")
            raise QdbgError

        exit(1)

    except FileNotFoundError as e:
        logging.error(f"Command not found: {e}")
        sys.exit(127)

    except Exception as e:
        raise QdbgError(e)


def parse_traceback(stderr: str, from_bottom: bool = True) -> str:
    """Return first non-empty line of the string stderr

    Args:
        *stderr*: a string of the stderr output stream
        *from_bottom*: when true, search from the end of the stream

    Returns:
        a non-empty string in the traceback (ideally the error message), if it
        exists
    """
    spl = stderr.split("\n")

    for line in reversed(spl) if from_bottom else iter(spl):
        if not line:
            continue
        return line

    return ""


def get_search_url(cmd: str, stderr: str) -> str:
    """Create a search url. Defaults to the "you" search engine.

    Args:
        *cmd*: the first argument of the command provided to `qdbg`
        *stderr*: a string of the stderr output stream

    Returns:
        a parameterized search url
    """
    err = parse_traceback(stderr=stderr)
    search_query = quote_plus(f"{cmd} {err}")
    return f"https://you.com/search?q={search_query}"


if __name__ == "__main__":
    logging.basicConfig(level=logging.WARN)

    if len(sys.argv) < 2:  # pragma: no cover
        logging.error("Qdbg requires a command")
        raise QdbgError

    main(sys.argv[1:])