class ScriptCommand(argparse.ArgumentParser):
"""
Parent class for cli subcommands
"""
def __init__(self, name, description='', epilog='', mode_flags=[]):
self.script = None
self.name = name
self.description = description
self.epilog = epilog
self.logger = SoundforestLogger()
self.log = self.logger.default_stream
if not isinstance(mode_flags, list):
raise ScriptError('Mode flags must be a list')
self.mode_flags = mode_flags
self.selected_mode_flags = []
@property
def db(self):
return self.script.db
def exit(self, *args, **kwargs):
self.script.exit(*args, **kwargs)
def message(self, *args, **kwargs):
self.script.message(*args, **kwargs)
def parse_args(self, args):
if hasattr(args, 'debug') and getattr(args, 'debug'):
self.logger.set_level('DEBUG')
self.selected_mode_flags = []
for flag in self.mode_flags:
if not hasattr(args, flag):
continue
if getattr(self, flag) not in ( None, False, [], ):
self.selected_mode_flags.append(flag)
xterm_title('soundforest %s' % (self.name))
return args
def match_path(self, path, matches=[]):
for m in matches:
m_realpath = os.path.realpath(m)
t_realpath = os.path.realpath(path)
if fnmatch.fnmatch(path, m):
return True
if path[:len(m)] == m:
return True
if t_realpath[:len(m_realpath)] == m_realpath:
return True
return False
class Script(object):
"""
Common CLI tool setup class
"""
def __init__(self, name=None, description=None, epilog=None, debug_flag=True):
self.db = ConfigDB()
self.name = os.path.basename(sys.argv[0])
reload(sys)
sys.setdefaultencoding('utf-8')
setproctitle('%s %s' % (self.name, ' '.join(sys.argv[1:])))
signal.signal(signal.SIGINT, self.SIGINT)
if name is None:
name = self.name
self.logger = SoundforestLogger()
self.log = self.logger.default_stream
self.parser = argparse.ArgumentParser(
prog=name,
description=description,
epilog=epilog,
add_help=True,
conflict_handler='resolve',
)
self.subcommand_parser = None
self.subcommands = None
if debug_flag:
self.parser.add_argument('--debug', action='store_true', help='Show debug messages')
def SIGINT(self, signum, frame):
"""
Parse SIGINT signal by quitting the program cleanly with exit code 1
"""
for t in filter(lambda t: t.name!='MainThread', threading.enumerate()):
t.join()
self.exit(1)
def wait(self, poll_interval=1):
"""
Wait for running threads to finish.
Poll interval is time to wait between checks for threads
"""
while True:
active = filter(lambda t: t.name!='MainThread', threading.enumerate())
if not len(active):
break
time.sleep(poll_interval)
def exit(self, value=0, message=None):
"""
Exit the script with given exit value.
If message is not None, it is printed on screen.
"""
if message is not None:
self.message(message)
while True:
active = filter(lambda t: t.name!='MainThread', threading.enumerate())
if not len(active):
break
time.sleep(1)
sys.exit(value)
def message(self, message):
sys.stdout.write('%s\n' % message)
sys.stdout.flush()
def error(self, message):
sys.stderr.write('%s\n' % message)
sys.stdout.flush()
def add_subcommand(self, command):
if self.subcommand_parser is None:
self.subcommand_parser = self.parser.add_subparsers(
dest='command',
help='Please select one command mode below',
title='Command modes'
)
self.subcommands = {}
if not isinstance(command, ScriptCommand):
raise ScriptError('Subcommand must be a ScriptCommand instance')
parser = self.subcommand_parser.add_parser(
command.name,
help=command.description,
description=command.description,
epilog=command.epilog
)
self.subcommands[command.name] = command
command.script = self
return parser
def add_argument(self, *args, **kwargs):
"""
Shortcut to add argument to main argumentparser instance
"""
self.parser.add_argument(*args, **kwargs)
def parse_args(self):
"""
Call parse_args for parser and check for default logging flags
"""
args = self.parser.parse_args()
if hasattr(args, 'debug') and getattr(args, 'debug'):
self.logger.set_level('DEBUG')
return args
def run(self):
args = self.parse_args()
if self.subcommand_parser is not None:
self.subcommands[args.command].run(args)
class Script(object):
"""
Common CLI tool setup class
"""
def __init__(self,
name=None,
description=None,
epilog=None,
debug_flag=True):
self.db = ConfigDB()
self.name = os.path.basename(sys.argv[0])
reload(sys)
sys.setdefaultencoding('utf-8')
setproctitle('%s %s' % (self.name, ' '.join(sys.argv[1:])))
signal.signal(signal.SIGINT, self.SIGINT)
if name is None:
name = self.name
self.logger = SoundforestLogger()
self.log = self.logger.default_stream
self.parser = argparse.ArgumentParser(
prog=name,
description=description,
epilog=epilog,
add_help=True,
conflict_handler='resolve',
)
self.subcommand_parser = None
self.subcommands = None
if debug_flag:
self.parser.add_argument('--debug',
action='store_true',
help='Show debug messages')
def SIGINT(self, signum, frame):
"""
Parse SIGINT signal by quitting the program cleanly with exit code 1
"""
for t in filter(lambda t: t.name != 'MainThread',
threading.enumerate()):
t.join()
self.exit(1)
def wait(self, poll_interval=1):
"""
Wait for running threads to finish.
Poll interval is time to wait between checks for threads
"""
while True:
active = filter(lambda t: t.name != 'MainThread',
threading.enumerate())
if not len(active):
break
time.sleep(poll_interval)
def exit(self, value=0, message=None):
"""
Exit the script with given exit value.
If message is not None, it is printed on screen.
"""
if message is not None:
self.message(message)
while True:
active = filter(lambda t: t.name != 'MainThread',
threading.enumerate())
if not len(active):
break
time.sleep(1)
sys.exit(value)
def message(self, message):
sys.stdout.write('%s\n' % message)
sys.stdout.flush()
def error(self, message):
sys.stderr.write('%s\n' % message)
sys.stdout.flush()
def add_subcommand(self, command):
if self.subcommand_parser is None:
self.subcommand_parser = self.parser.add_subparsers(
dest='command',
help='Please select one command mode below',
title='Command modes')
self.subcommands = {}
if not isinstance(command, ScriptCommand):
raise ScriptError('Subcommand must be a ScriptCommand instance')
parser = self.subcommand_parser.add_parser(
command.name,
help=command.description,
description=command.description,
epilog=command.epilog)
self.subcommands[command.name] = command
command.script = self
return parser
def add_argument(self, *args, **kwargs):
"""
Shortcut to add argument to main argumentparser instance
"""
self.parser.add_argument(*args, **kwargs)
def parse_args(self):
"""
Call parse_args for parser and check for default logging flags
"""
args = self.parser.parse_args()
if hasattr(args, 'debug') and getattr(args, 'debug'):
self.logger.set_level('DEBUG')
return args
def run(self):
args = self.parse_args()
if self.subcommand_parser is not None:
self.subcommands[args.command].run(args)
class ScriptCommand(argparse.ArgumentParser):
"""
Parent class for cli subcommands
"""
def __init__(self, name, description='', epilog='', mode_flags=[]):
self.script = None
self.name = name
self.description = description
self.epilog = epilog
self.logger = SoundforestLogger()
self.log = self.logger.default_stream
if not isinstance(mode_flags, list):
raise ScriptError('Mode flags must be a list')
self.mode_flags = mode_flags
self.selected_mode_flags = []
@property
def db(self):
return self.script.db
def exit(self, *args, **kwargs):
self.script.exit(*args, **kwargs)
def message(self, *args, **kwargs):
self.script.message(*args, **kwargs)
def parse_args(self, args):
if hasattr(args, 'debug') and getattr(args, 'debug'):
self.logger.set_level('DEBUG')
self.selected_mode_flags = []
for flag in self.mode_flags:
if not hasattr(args, flag):
continue
if getattr(self, flag) not in (
None,
False,
[],
):
self.selected_mode_flags.append(flag)
xterm_title('soundforest %s' % (self.name))
return args
def match_path(self, path, matches=[]):
for m in matches:
m_realpath = os.path.realpath(m)
t_realpath = os.path.realpath(path)
if fnmatch.fnmatch(path, m):
return True
if path[:len(m)] == m:
return True
if t_realpath[:len(m_realpath)] == m_realpath:
return True
return False
