mirror of
https://github.com/mikf/gallery-dl.git
synced 2024-11-23 03:02:50 +01:00
244 lines
8.3 KiB
Python
244 lines
8.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2017 Mike Fährmann
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License version 2 as
|
|
# published by the Free Software Foundation.
|
|
|
|
"""Command line option parsing"""
|
|
|
|
import argparse
|
|
import logging
|
|
import json
|
|
from .version import __version__
|
|
|
|
log = logging.getLogger("option")
|
|
|
|
|
|
class ConfigAction(argparse.Action):
|
|
"""Set argparse results as config values"""
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
namespace.options.append(((self.dest,), values))
|
|
|
|
|
|
class ConfigConstAction(argparse.Action):
|
|
"""Set argparse const values as config values"""
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
namespace.options.append(((self.dest,), self.const))
|
|
|
|
|
|
class ParseAction(argparse.Action):
|
|
"""Parse <key>=<value> options and set them as config values"""
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
try:
|
|
key, _, value = values.partition("=")
|
|
try:
|
|
value = json.loads(value)
|
|
except ValueError:
|
|
pass
|
|
key = key.split(".")
|
|
namespace.options.append((key, value))
|
|
except ValueError:
|
|
log.warning("Invalid '<key>=<value>' pair: %s", values)
|
|
|
|
|
|
class Formatter(argparse.HelpFormatter):
|
|
"""Custom HelpFormatter class to customize help output"""
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(max_help_position=50, *args, **kwargs)
|
|
|
|
def _format_action_invocation(self, action):
|
|
opts = action.option_strings[:]
|
|
if opts:
|
|
if action.nargs != 0:
|
|
args_string = self._format_args(action, "ARG")
|
|
opts[-1] += " " + args_string
|
|
return ', '.join(opts)
|
|
else:
|
|
return self._metavar_formatter(action, action.dest)(1)[0]
|
|
|
|
|
|
def build_parser():
|
|
"""Build and configure an ArgumentParser object"""
|
|
parser = argparse.ArgumentParser(
|
|
usage="%(prog)s [OPTION]... URL...",
|
|
formatter_class=Formatter,
|
|
add_help=False,
|
|
)
|
|
|
|
general = parser.add_argument_group("General Options")
|
|
general.add_argument(
|
|
"-h", "--help",
|
|
action="help",
|
|
help="Print this help message and exit",
|
|
)
|
|
general.add_argument(
|
|
"--version",
|
|
action="version", version=__version__,
|
|
help="Print program version and exit",
|
|
)
|
|
general.add_argument(
|
|
"-d", "--dest",
|
|
metavar="DEST", action=ConfigAction, dest="base-directory",
|
|
help="Destination directory",
|
|
)
|
|
general.add_argument(
|
|
"-i", "--input-file",
|
|
metavar="FILE", dest="inputfile",
|
|
help="Download URLs found in FILE ('-' for stdin)",
|
|
)
|
|
general.add_argument(
|
|
"--cookies",
|
|
metavar="FILE", action=ConfigAction, dest="cookies",
|
|
help="File to load additional cookies from",
|
|
)
|
|
general.add_argument(
|
|
"--write-unsupported",
|
|
metavar="FILE", dest="unsupportedfile",
|
|
help=("Write URLs, which get emitted by other extractors but cannot "
|
|
"be handled, to FILE"),
|
|
)
|
|
|
|
output = parser.add_argument_group("Output Options")
|
|
output.add_argument(
|
|
"-q", "--quiet", dest="loglevel", action="store_const",
|
|
const=logging.ERROR, default=logging.INFO,
|
|
help="Activate quiet mode",
|
|
)
|
|
output.add_argument(
|
|
"-v", "--verbose", dest="loglevel", action="store_const",
|
|
const=logging.DEBUG, default=logging.INFO,
|
|
help="Print various debugging information",
|
|
)
|
|
output.add_argument(
|
|
"-g", "--get-urls", dest="list_urls", action="count",
|
|
help="Print URLs instead of downloading",
|
|
)
|
|
output.add_argument(
|
|
"-j", "--dump-json", dest="list_data", action="store_true",
|
|
help="Print JSON information",
|
|
)
|
|
output.add_argument(
|
|
"-K", "--list-keywords", dest="list_keywords", action="store_true",
|
|
help=("Print a list of available keywords and example values "
|
|
"for the given URLs"),
|
|
)
|
|
output.add_argument(
|
|
"--list-modules", dest="list_modules", action="store_true",
|
|
help="Print a list of available extractor modules",
|
|
)
|
|
output.add_argument(
|
|
"--list-extractors", dest="list_extractors", action="store_true",
|
|
help=("Print a list of extractor classes "
|
|
"with description, (sub)category and example URL"),
|
|
)
|
|
|
|
downloader = parser.add_argument_group("Downloader Options")
|
|
downloader.add_argument(
|
|
"-r", "--limit-rate",
|
|
metavar="RATE", action=ConfigAction, dest="rate",
|
|
help="Maximum download rate (e.g. 500k or 2.5M)",
|
|
)
|
|
downloader.add_argument(
|
|
"-R", "--retries",
|
|
metavar="RETRIES", action=ConfigAction, dest="retries", type=int,
|
|
help="Number of retries (default: 5)",
|
|
)
|
|
downloader.add_argument(
|
|
"--http-timeout",
|
|
metavar="SECONDS", action=ConfigAction, dest="timeout", type=float,
|
|
help="Timeout for HTTP connections (defaut: 30s)",
|
|
)
|
|
downloader.add_argument(
|
|
"--sleep",
|
|
metavar="SECONDS", action=ConfigAction, dest="sleep", type=float,
|
|
help="Number of seconds to sleep before each download",
|
|
)
|
|
downloader.add_argument(
|
|
"--no-part",
|
|
action=ConfigConstAction, nargs=0, dest="part", const=False,
|
|
help="Do not use .part files",
|
|
)
|
|
downloader.add_argument(
|
|
"--abort-on-skip",
|
|
action=ConfigConstAction, nargs=0, dest="skip", const="abort",
|
|
help=("Abort extractor run if a file download would normally be "
|
|
"skipped, i.e. if a file with the same filename already exists"),
|
|
)
|
|
|
|
configuration = parser.add_argument_group("Configuration Options")
|
|
configuration.add_argument(
|
|
"-c", "--config",
|
|
metavar="CFG", dest="cfgfiles", action="append",
|
|
help="Additional configuration files",
|
|
)
|
|
configuration.add_argument(
|
|
"--config-yaml",
|
|
metavar="CFG", dest="yamlfiles", action="append",
|
|
help="Additional configuration files (YAML format)",
|
|
)
|
|
configuration.add_argument(
|
|
"--ignore-config", dest="load_config", action="store_false",
|
|
help="Do not read the default configuration files",
|
|
)
|
|
configuration.add_argument(
|
|
"-o", "--option",
|
|
metavar="OPT", action=ParseAction, dest="options", default=[],
|
|
help="Additional '<key>=<value>' option values",
|
|
)
|
|
|
|
authentication = parser.add_argument_group("Authentication Options")
|
|
authentication.add_argument(
|
|
"-u", "--username",
|
|
metavar="USER", action=ConfigAction, dest="username",
|
|
)
|
|
authentication.add_argument(
|
|
"-p", "--password",
|
|
metavar="PASS", action=ConfigAction, dest="password",
|
|
)
|
|
authentication.add_argument(
|
|
"--netrc",
|
|
action=ConfigConstAction, nargs=0, dest="netrc", const=True,
|
|
help="Use .netrc authentication data",
|
|
)
|
|
|
|
selection = parser.add_argument_group("Selection Options")
|
|
selection.add_argument(
|
|
"--range",
|
|
metavar="RANGE", dest="image_range",
|
|
help=("Specify which images to download through a comma seperated list"
|
|
" of indices or index-ranges; "
|
|
"for example '--range -2,4,6-8,10-' will download images with "
|
|
"index 1, 2, 4, 6, 7, 8 and 10 up to the last one"),
|
|
)
|
|
selection.add_argument(
|
|
"--chapter-range",
|
|
metavar="RANGE", dest="chapter_range",
|
|
help=("Same as '--range' except for chapters "
|
|
"and other delegated URLs"),
|
|
)
|
|
selection.add_argument(
|
|
"--filter",
|
|
metavar="EXPR", dest="image_filter",
|
|
help=("Python expression controlling which images to download. Images "
|
|
"for which the expression evaluates to False are ignored. "
|
|
"Available keys are the filename-specific ones listed by "
|
|
"'--list-keywords'. Example: --filter \"image_width >= 1000 and "
|
|
"rating in ('s', 'q')\""),
|
|
)
|
|
selection.add_argument(
|
|
"--chapter-filter",
|
|
metavar="EXPR", dest="chapter_filter",
|
|
help=("Same as '--filter' except for chapters "
|
|
"and other delegated URLs"),
|
|
)
|
|
|
|
parser.add_argument(
|
|
"urls",
|
|
nargs="*", metavar="URL",
|
|
help=argparse.SUPPRESS,
|
|
)
|
|
|
|
return parser
|