topydo/topydo/Commands.py

# Topydo - A todo.txt client written in Python.
# Copyright (C) 2015 Bram Schoenmakers <bram@topydo.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""
This module is aware of all supported submodules and hands out a Command
instance based on an argument list.
"""

import sys

from topydo.lib.Config import ConfigError, config

SUBCOMMAND_MAP = {
    'add': 'AddCommand',
    'app': 'AppendCommand',
    'append': 'AppendCommand',
    'del': 'DeleteCommand',
    'dep': 'DepCommand',
    'depri': 'DepriCommand',
    'do': 'DoCommand',
    'edit': 'EditCommand',
    'exit': 'ExitCommand',  # used for the prompt
    'ls': 'ListCommand',
    'lscon': 'ListContextCommand',
    'lsprj': 'ListProjectCommand',
    'postpone': 'PostponeCommand',
    'pri': 'PriorityCommand',
    'quit': 'ExitCommand',
    'revert': 'RevertCommand',
    'rm': 'DeleteCommand',
    'sort': 'SortCommand',
    'tag': 'TagCommand',
}

def get_subcommand(p_args):
    """
    Retrieves the to-be executed Command and returns a tuple (Command, args).

    If args is an empty list, then the Command that corresponds with the
    default command specified in the configuration will be returned.

    If the first argument is 'help' and the second a valid subcommand, the
    help text this function returns the Command instance of that subcommand
    with a single argument 'help' (every Command has a help text).

    If no valid command could be found, the subcommand part of the tuple
    is None.
    """
    def import_subcommand(p_subcommand):
        """
        Returns the class of the requested subcommand. An invalid p_subcommand
        will result in an ImportError, since this is a programming mistake
        (most likely an error in the SUBCOMMAND_MAP).
        """
        classname = SUBCOMMAND_MAP[p_subcommand]
        modulename = 'topydo.commands.{}'.format(classname)

        __import__(modulename, globals(), locals(), [classname], 0)
        return getattr(sys.modules[modulename], classname)

    def join_args(p_cli_args, p_alias_args):
        """
        Returns properly joined args from alias definition and from user input.
        """
        if '{}' in p_alias_args:
            pos = p_alias_args.index('{}')
            args = p_alias_args[:pos] + p_cli_args + p_alias_args[pos+1:]
        else:
            args = p_alias_args + p_cli_args

        return args

    def resolve_alias(p_alias, p_args):
        """
        Resolves a subcommand alias and returns a tuple (Command, args).

        If alias resolves to non-existent command, main help message is
        returned.
        """
        try:
            real_subcommand, alias_args = alias_map[p_alias]
        except ValueError as ve:
            raise ConfigError(alias_map[p_alias]) from ve

        try:
            result = import_subcommand(real_subcommand)
            args = join_args(p_args, alias_args)
            return (result, args)
        except KeyError:
            return get_subcommand(['help'])

    result = None
    args = p_args
    alias_map = config().aliases()

    try:
        subcommand = p_args[0]

        if subcommand in alias_map:
            result, args = resolve_alias(subcommand, args[1:])
        elif subcommand in SUBCOMMAND_MAP:
            result = import_subcommand(subcommand)
            args = args[1:]
        elif subcommand == 'help':
            try:
                subcommand = args[1]

                if subcommand in SUBCOMMAND_MAP:
                    args = [subcommand, 'help']
                    return get_subcommand(args)
            except IndexError:
                # will result in empty result
                pass
        else:
            p_command = config().default_command()
            if p_command in alias_map:
                result, args = resolve_alias(p_command, args)
            elif p_command in SUBCOMMAND_MAP:
                result = import_subcommand(p_command)
                # leave args unchanged
    except IndexError:
        p_command = config().default_command()
        if p_command in alias_map:
            result, args = resolve_alias(p_command, args)
        elif p_command in SUBCOMMAND_MAP:
            result = import_subcommand(p_command)

    return (result, args)