import logging
import shlex
import subprocess
from collections import namedtuple

CommandResult = namedtuple("Result", ['rc', 'out', 'err'])


[docs]def run_through_shell(command, enable_shell=False):
    """
    Retrieve output of a command.
    Returns a named tuple with three elements:

    * ``rc`` (integer) Return code of command.
    * ``out`` (string) Everything that was printed to stdout.
    * ``err`` (string) Everything that was printed to stderr.

    Don't use this function with programs that outputs lots of data since the
    output is saved in one variable.

    :param command: A string or a list of strings containing the name and
     arguments of the program.
    :param enable_shell: If set ot `True` users default shell will be invoked
     and given ``command`` to execute. The ``command`` should obviously be a
     string since shell does all the parsing.
    """

    if not enable_shell and isinstance(command, str):
        command = shlex.split(command)

    returncode = None
    stderr = None
    try:
        proc = subprocess.Popen(command, stderr=subprocess.PIPE,
                                stdout=subprocess.PIPE, shell=enable_shell)
        out, stderr = proc.communicate()
        out = out.decode("UTF-8")
        stderr = stderr.decode("UTF-8")

        returncode = proc.returncode

    except OSError as e:
        out = e.strerror
        stderr = e.strerror
        logging.getLogger("i3pystatus.core.command").exception("")
    except subprocess.CalledProcessError as e:
        out = e.output
        logging.getLogger("i3pystatus.core.command").exception("")

    return CommandResult(returncode, out, stderr)


[docs]def execute(command, detach=False):
    """
    Runs a command in background. No output is retrieved. Useful for running GUI
    applications that would block click events.

    :param command: A string or a list of strings containing the name and
     arguments of the program.
    :param detach: If set to `True` the program will be executed using the
     `i3-msg` command. As a result the program is executed independent of
     i3pystatus as a child of i3 process. Because of how i3-msg parses its
     arguments the type of `command` is limited to string in this mode.
    """

    if detach:
        if not isinstance(command, str):
            msg = "Detached mode expects a string as command, not {}".format(
                  command)
            logging.getLogger("i3pystatus.core.command").error(msg)
            raise AttributeError(msg)
        command = ["i3-msg", "exec", command]
    else:
        if isinstance(command, str):
            command = shlex.split(command)

    try:
        subprocess.Popen(command, stdin=subprocess.DEVNULL,
                         stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
    except OSError:
        logging.getLogger("i3pystatus.core.command").exception("")
    except subprocess.CalledProcessError:
        logging.getLogger("i3pystatus.core.command").exception("")