Source code for pimlico.cli.locations

# This file is part of Pimlico
# Copyright (C) 2016 Mark Granroth-Wilding
# Licensed under the GNU GPL v3.0 - http://www.gnu.org/licenses/gpl-3.0.en.html
import sys

from pimlico.cli.subcommands import PimlicoCLISubcommand
from pimlico.utils.core import remove_duplicates


class InputsCmd(PimlicoCLISubcommand):
    command_name = "inputs"
    command_help = "Show the locations of the inputs of a given module. If the input datasets " \
                   "are available, their actual location is shown. Otherwise, all directories " \
                   "in which the data is being checked for are shown"
    command_desc = "Show the (expected) locations of the inputs of a given module"

    def add_arguments(self, parser):
        parser.add_argument("module_name", help="The name (or number) of the module to display input locations for")

    def run_command(self, pipeline, opts):
        module_name = opts.module_name
        print "Input locations for module '%s'" % module_name
        try:
            module = pipeline[module_name]
        except KeyError:
            print >>sys.stderr, "Error: module '{}' does not exist".format(module_name)
            sys.exit(1)

        # Display info for each input to this module
        for input_name in module.input_names:
            print "\nInput '%s'" % input_name
            input_lst = module.get_input(input_name, always_list=True)
            input_connections = module.get_input_module_connection(input_name, always_list=True)
            multiple_inputs = len(input_lst) > 1
            if multiple_inputs:
                print "Multiple input sources: showing locations for all"

            for i, (input_datatype, (prev_module, prev_output_name, __)) in \
                    enumerate(zip(input_lst, input_connections)):
                if multiple_inputs:
                    print "## Input source %d ##" % i

                if input_datatype.data_ready():
                    corpus_dir = input_datatype.absolute_base_dir
                    if corpus_dir is None:
                        print "Data (%s) available, but no directory given: probably a filter datatype" % \
                              input_datatype.full_datatype_name()
                    else:
                        print "Data (%s) available in:" % input_datatype.full_datatype_name()
                        print " - %s" % corpus_dir
                else:
                    print "Data not available. Data will be found in any of the following locations:"
                    # Get the relative dir within the Pimlico dir structures
                    rel_path = prev_module.get_output_dir(prev_output_name)
                    # Resolve this to all possible absolute dirs (usually two)
                    abs_paths = remove_duplicates(pipeline.get_data_search_paths(rel_path))
                    print "\n".join(" - %s" % pth for pth in abs_paths)


class OutputCmd(PimlicoCLISubcommand):
    command_name = "output"
    command_help = "Show the location where the given module's output data will be (or has been) stored"

    def add_arguments(self, parser):
        parser.add_argument("module_name", help="The name (or number) of the module to display input locations for")

    def run_command(self, pipeline, opts):
        module_name = opts.module_name
        try:
            module = pipeline[module_name]
        except KeyError:
            print >>sys.stderr, "Error: module '{}' does not exist".format(module_name)
            sys.exit(1)
        # Get the output dir for the module
        module_output_dir = module.get_module_output_dir(short_term_store=True)
        print "Output location for module '%s': %s" % (module_name, module_output_dir)