X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Futils%2Fstartopt.py;h=bf9fcf4120ce95d1e227036d7388c42fddbe5bb1;hb=3636f8f37183e1b1f1c581b4edfff1b1abd70462;hp=a1824ee8ca61b31346c83cb0c77065a291cd5b14;hpb=b75a67a8ef2924dbcfdb9838d5b35447baf1e4be;p=mpd-sima.git diff --git a/sima/utils/startopt.py b/sima/utils/startopt.py index a1824ee..bf9fcf4 100644 --- a/sima/utils/startopt.py +++ b/sima/utils/startopt.py @@ -21,7 +21,6 @@ from argparse import ArgumentParser, RawDescriptionHelpFormatter, SUPPRESS - from .utils import Wfile, Rfile, Wdir DESCRIPTION = """ @@ -29,8 +28,6 @@ MPD_sima automagicaly queue new tracks in MPD playlist. Command line options override their equivalent in configuration file. If a positional arguments is provided MPD_sima execute the command and returns. -Commands available: -{} """ @@ -40,11 +37,6 @@ def clean_dict(to_clean): if not to_clean.get(k): to_clean.pop(k) -# COMMANDS LIST -CMDS = {'config-test': 'Test configuration (MPD connection and Tags plugin only)', - 'create-db': 'Create the database', - 'generate-config': 'Generate a configuration file to stdout', - } # OPTIONS LIST # pop out 'sw' value before creating Parser object. # PAY ATTENTION: @@ -59,57 +51,69 @@ OPTS = [ 'type': str, 'dest': 'logfile', 'action': Wfile, + 'metavar': 'LOG', 'help': 'file to log message to, default is stdout/stderr'}, { 'sw': ['-v', '--log-level'], 'type': str, 'dest': 'verbosity', 'choices': ['debug', 'info', 'warning', 'error'], - 'help': 'Log messages verbosity, default is info'}, + 'help': 'log messages verbosity, default is info'}, { 'sw': ['-p', '--pid'], 'dest': 'pidfile', 'action': Wfile, + 'metavar': 'FILE', 'help': 'file to save PID to, default is not to store pid'}, { 'sw': ['-d', '--daemon'], 'dest': 'daemon', 'action': 'store_true', - 'help': 'Daemonize process.'}, + 'help': 'daemonize process'}, { 'sw': ['-S', '--host'], 'dest': 'host', - 'help': 'Host MPD in running on (IP or FQDN)'}, + 'help': 'host MPD in running on (IP or FQDN)'}, { 'sw': ['-P', '--port'], 'type': int, 'dest': 'port', - 'help': 'Port MPD in listening on'}, + 'help': 'port MPD in listening on'}, { 'sw': ['-c', '--config'], 'dest': 'conf_file', 'action': Rfile, - 'help': 'Configuration file to load'}, - { # TODO: To remove eventually in next major realese v0.18 - 'sw': ['--generate-config'], - 'dest': 'generate_config', - 'action': 'store_true', - 'help': SUPPRESS}, + 'metavar': 'CONFIG', + 'help': 'configuration file to load'}, { 'sw': ['--var-dir', '--var_dir'], 'dest': 'var_dir', 'action': Wdir, - 'help': 'Directory to store var content (ie. database, cache)'}, - { # TODO: To remove eventually in next major realese v0.18 - 'sw': ['--create-db'], - 'action': 'store_true', - 'dest': 'create_db', - 'help': SUPPRESS}, - { - 'sw': ['command'], - 'nargs': '?', - 'choices': CMDS.keys(), - 'help': 'Command to run (cf. description or unix manual for more)'}, + 'help': 'directory to store var content (ie. database, cache)'}, +] +# Commands +CMDS = [ + {'config-test': [{}], 'help': 'Test configuration (MPD connection and Tags plugin only)'}, + {'create-db': [{}], 'help': 'Create the database'}, + {'generate-config': [{}], 'help': 'Generate a configuration file to stdout'}, + {'purge-history': [{}], 'help': 'Remove play history'}, + {'bl-view': [{}], 'help': 'List blocklist IDs'}, + {'bl-add-artist': [ + {'name': 'artist', 'type': str, 'nargs': '?', + 'help': 'If artist is provided use it else use currently playing value'} + ], 'help': 'Add artist to the blocklist'}, + {'bl-add-album': [ + {'name': 'album', 'type': str, 'nargs': '?', + 'help': 'If album is provided use it else use currently playing value'} + ], 'help': 'Add album to the blocklist'}, + {'bl-add-track': [ + {'name': 'track', 'type': str, 'nargs': '?', + 'help': 'If track is provided use it else use currently playing value'} + ], 'help': 'Add track to the blocklist'}, + {'bl-delete': [ + {'name': 'id', 'type': int, 'nargs': '?', + 'help': 'blocklist ID to suppress (use bl-view list IDs)'} + ], 'help': 'Remove entries from the blocklist'}, ] @@ -127,8 +131,7 @@ class StartOpt: """ Declare options in ArgumentParser object. """ - cmds = '\n'.join([f' * {k}: {v}' for k, v in CMDS.items()]) - self.parser = ArgumentParser(description=DESCRIPTION.format(cmds), + self.parser = ArgumentParser(description=DESCRIPTION, prog=self.info.get('prog'), epilog='Happy Listening', formatter_class=RawDescriptionHelpFormatter, @@ -139,6 +142,19 @@ class StartOpt: for opt in OPTS: opt_names = opt.pop('sw') self.parser.add_argument(*opt_names, **opt) + # Add sub commands + sp = self.parser.add_subparsers( + title=f'{self.info["prog"]} commands as positional arguments', + description=f"""Use them after optionnal arguments.\n"{self.info["prog"]} command -h" for more info.""", + metavar='', dest='command') + for cmd in CMDS: + helpmsg = cmd.pop('help') + cmd, args = cmd.popitem() + _ = sp.add_parser(cmd, description=helpmsg, help=helpmsg) + for arg in args: + name = arg.pop('name', None) + if name: + _.add_argument(name, **arg) def main(self): """