# -*- coding: utf-8 -*-
# (c) The James Hutton Institute 2016-2019
# (c) University of Strathclyde 2019-2020
# Author: Leighton Pritchard
#
# Contact:
# leighton.pritchard@strath.ac.uk
#
# Leighton Pritchard,
# Strathclyde Institute for Pharmacy and Biomedical Sciences,
# Cathedral Street,
# Glasgow,
# G4 0RE
# Scotland,
# UK
#
# The MIT License
#
# Copyright (c) 2016-2019 The James Hutton Institute
# Copyright (c) 2019-2020 University of Strathclyde
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""Provides parser for arguments common to all subcommands."""
from argparse import ArgumentParser
from pathlib import Path
# Common parser for all subcommands
[docs]def build() -> ArgumentParser:
"""Return the common argument parser for all script subcommands.
:param subps: collection of subparsers in main parser
:param parents: parsers from which arguments are inherited
Common arguments are:
-l, --logfile (specify logfile output path)
-v, --verbose (produce verbose output on STDOUT)
"""
parser = ArgumentParser(add_help=False)
parser.add_argument(
"-l",
"--logfile",
dest="logfile",
action="store",
default=None,
type=Path,
help="logfile location",
)
parser.add_argument(
"-v",
"--verbose",
action="store_true",
dest="verbose",
default=False,
help="report verbose progress to log",
)
parser.add_argument(
"--debug",
action="store_true",
dest="debug",
default=False,
help="report debug messages to log",
)
parser.add_argument(
"--disable_tqdm",
action="store_true",
dest="disable_tqdm",
default=False,
help="Turn off tqdm progress bar",
)
parser.add_argument("--version", action="store_true", dest="version")
parser.add_argument("--citation", action="store_true", dest="citation")
return parser