131 lines
4.3 KiB
Python
131 lines
4.3 KiB
Python
# -*- Mode: Python -*-
|
|
# vi:si:et:sw=4:sts=4:ts=4
|
|
|
|
import argparse
|
|
import os
|
|
import sys
|
|
|
|
from whipper.common import drive
|
|
|
|
import logging
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Q: What about argparse.add_subparsers(), you ask?
|
|
# A: Unfortunately add_subparsers() does not support specifying the
|
|
# formatter_class of subparsers, nor does it support epilogs, so
|
|
# it does not quite fit our use case.
|
|
|
|
# Q: Why not subclass ArgumentParser and extend/replace the relevant
|
|
# methods?
|
|
# A: If this can be done in a simpler fashion than this current
|
|
# implementation, by all means submit a patch.
|
|
|
|
# Q: Why not argparse.parse_known_args()?
|
|
# A: The prefix matching prevents passing '-h' (and possibly other
|
|
# options) to the child command.
|
|
|
|
|
|
class BaseCommand():
|
|
"""
|
|
A base command class for whipper commands.
|
|
|
|
Creates an argparse.ArgumentParser.
|
|
Override add_arguments() and handle_arguments() to register
|
|
and process arguments before & after argparse.parse_args().
|
|
|
|
Provides self.epilog() formatting command for argparse.
|
|
|
|
device_option = True adds -d / --device option to current command
|
|
no_add_help = True removes -h / --help option from current command
|
|
|
|
Overriding formatter_class sets the argparse formatter class.
|
|
|
|
If the 'subcommands' dictionary is set, __init__ searches the
|
|
arguments for subcommands.keys() and instantiates the class
|
|
implementing the subcommand as self.cmd, passing all non-understood
|
|
arguments, the current options namespace, and the full command path
|
|
name.
|
|
"""
|
|
device_option = False
|
|
no_add_help = False # for rip.main.Whipper
|
|
formatter_class = argparse.RawDescriptionHelpFormatter
|
|
|
|
def __init__(self, argv, prog_name, opts):
|
|
self.opts = opts # for Rip.add_arguments()
|
|
self.prog_name = prog_name
|
|
|
|
self.init_parser()
|
|
self.add_arguments()
|
|
|
|
if hasattr(self, 'subcommands'):
|
|
self.parser.add_argument('remainder',
|
|
nargs=argparse.REMAINDER,
|
|
help=argparse.SUPPRESS)
|
|
|
|
if self.device_option:
|
|
# pick the first drive as default
|
|
drives = drive.getAllDevicePaths()
|
|
if not drives:
|
|
msg = 'No CD-DA drives found!'
|
|
logger.critical(msg)
|
|
# whipper exited with return code 3 here
|
|
raise IOError(msg)
|
|
self.parser.add_argument('-d', '--device',
|
|
action="store",
|
|
dest="device",
|
|
default=drives[0],
|
|
help="CD-DA device")
|
|
|
|
self.options = self.parser.parse_args(argv, namespace=opts)
|
|
|
|
if self.device_option:
|
|
# this can be a symlink to another device
|
|
self.options.device = os.path.realpath(self.options.device)
|
|
if not os.path.exists(self.options.device):
|
|
msg = 'CD-DA device %s not found!' % self.options.device
|
|
logger.critical(msg)
|
|
raise IOError(msg)
|
|
|
|
self.handle_arguments()
|
|
|
|
if hasattr(self, 'subcommands'):
|
|
if not self.options.remainder:
|
|
self.parser.print_help()
|
|
sys.exit(0)
|
|
if not self.options.remainder[0] in self.subcommands:
|
|
logger.critical("incorrect subcommand: %s",
|
|
self.options.remainder[0])
|
|
sys.exit(1)
|
|
self.cmd = self.subcommands[self.options.remainder[0]](
|
|
self.options.remainder[1:],
|
|
prog_name + " " + self.options.remainder[0],
|
|
self.options
|
|
)
|
|
|
|
def init_parser(self):
|
|
kw = {
|
|
'prog': self.prog_name,
|
|
'description': self.description,
|
|
'formatter_class': self.formatter_class,
|
|
}
|
|
if hasattr(self, 'subcommands'):
|
|
kw['epilog'] = self.epilog()
|
|
if self.no_add_help:
|
|
kw['add_help'] = False
|
|
self.parser = argparse.ArgumentParser(**kw)
|
|
|
|
def add_arguments(self):
|
|
pass
|
|
|
|
def handle_arguments(self):
|
|
pass
|
|
|
|
def do(self):
|
|
return self.cmd.do()
|
|
|
|
def epilog(self):
|
|
s = "commands:\n"
|
|
for com in sorted(self.subcommands.keys()):
|
|
s += " %s %s\n" % (com.ljust(8), self.subcommands[com].summary)
|
|
return s
|