#!/usr/bin/env python

#-----------------------------------------------------------------------------
# Copyright (c) 2013, The BiPy Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file COPYING.txt, distributed with this software.
#-----------------------------------------------------------------------------

__author__ = "Daniel McDonald"
__copyright__ = "Copyright 2013, The pyqi project"
__credits__ = ["Daniel McDonald", "Greg Caporaso", "Doug Wendel",
               "Jai Ram Rideout"]
__license__ = "BSD"
__version__ = "0.2.0"
__maintainer__ = "Daniel McDonald"
__email__ = "mcdonadt@colorado.edu"

from pyqi.core.command import Command
from pyqi.core.interfaces.optparse import (OptparseOption, OptparseUsageExample,
    OptparseResult)
from pyqi.core.interfaces.optparse.input_handler import (command_handler,
                                                         string_list_handler)
from pyqi.core.interfaces.optparse.output_handler import write_list_of_strings
from pyqi.core.command import make_parameter_collection_lookup_f
from pyqi.commands.make_optparse import CommandConstructor

param_lookup = make_parameter_collection_lookup_f(CommandConstructor)

usage_examples = [
    OptparseUsageExample(ShortDesc="Create an optparse config template",
                         LongDesc="Construct the beginning of an optparse configuration file based on the Parameters required by the Command.",
                         Ex='%prog -c pyqi.commands.make_optparse.MakeOptparse -m pyqi.commands.make_optparse -a "some author" --copyright "Copyright 2013, The pyqi project" -e "foo@bar.com" -l BSD --config-version "0.1" --credits "someone else","and another person" -o pyqi/interfaces/optparse/config/make_optparse.py'),
    OptparseUsageExample(ShortDesc="Create a different optparse config template",
                         LongDesc="Construct the beginning of an optparse configuration file based on the Parameters required by the Command. This command corresponds to the pyqi tutorial example where a sequence_collection_summarizer command line interface is created for a SequenceCollectionSummarizer Command.",
                         Ex='%prog -c sequence_collection_summarizer.SequenceCollectionSummarizer -m sequence_collection_summarizer -a "Greg Caporaso" --copyright "Copyright 2013, Greg Caporaso" -e "gregcaporaso@gmail.com" -l BSD --config-version 0.0.1 -o summarize_sequence_collection.py')
]

inputs = [
    OptparseOption(Parameter=param_lookup('command'),
                   ShortName='c',
                   InputHandler=command_handler),
    OptparseOption(Parameter=param_lookup('command_module'),
                   ShortName='m'),
    OptparseOption(Parameter=param_lookup('author'),
                   ShortName='a'),
    OptparseOption(Parameter=param_lookup('email'),
                   ShortName='e'),
    OptparseOption(Parameter=param_lookup('license'),
                   ShortName='l'),
    OptparseOption(Parameter=param_lookup('copyright')),
    OptparseOption(Parameter=param_lookup('version'), Name='config-version'),
    OptparseOption(Parameter=param_lookup('credits'),
                   InputHandler=string_list_handler,
                   Help='comma-separated list of other authors'),
    OptparseOption(Parameter=None,
                   InputType='new_filepath',
                   ShortName='o',
                   Name='output-fp',
                   Required=True,
                   Help='output filepath to store generated optparse Python configuration file')
]

outputs = [
    OptparseResult(ResultKey='result',
                   OutputHandler=write_list_of_strings,
                   OptionName='output-fp')
]
