Aesthetic changes in usage messages

[mpd-sima.git] / sima / utils / startopt.py

diff --git a/sima/utils/startopt.py b/sima/utils/startopt.py
index 2081c19266951f3b215d6353cd0229467c75c47a..cdcfcecc3cdce09314b2a7adcfc98e31a45cbf5c 100644 (file)
--- a/sima/utils/startopt.py
+++ b/sima/utils/startopt.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2015, 2021 kaliko <kaliko@azylum.org>
 #
 #  This file is part of sima
 #
@@ -19,14 +19,19 @@
 #
 #
 
-from argparse import (ArgumentParser, SUPPRESS)
+from argparse import ArgumentParser, RawDescriptionHelpFormatter, SUPPRESS
 
 
 from .utils import Wfile, Rfile, Wdir
 
 DESCRIPTION = """
 MPD_sima automagicaly queue new tracks in MPD playlist.
-Command line options override their equivalent in configuration file."""
+
+Command line options override their equivalent in configuration file.
+If a positional arguments is provided MPD_sima execute the command and returns.
+Commands available:
+{}
+"""
 
 
 def clean_dict(to_clean):
@@ -35,7 +40,11 @@ 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:
@@ -46,74 +55,68 @@ def clean_dict(to_clean):
 #   name it is meant to override.
 OPTS = [
     {
-        'sw':['-l', '--log'],
+        'sw': ['-l', '--log'],
         'type': str,
         'dest': 'logfile',
         'action': Wfile,
+        'metavar': 'LOG',
         'help': 'file to log message to, default is stdout/stderr'},
     {
-        'sw':['-v', '--log-level'],
+        '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'],
+        'sw': ['-c', '--config'],
         'dest': 'conf_file',
         'action': Rfile,
-        'help': 'Configuration file to load'},
-    {
-        'sw':['--generate-config'],
+        'metavar': 'CONFIG',
+        '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': 'Generate a sample configuration file to stdout according to the current\
-         configuration. You can put other options with this one to get them in\
-         the generated configuration.'},
+        'help': SUPPRESS},
     {
-        'sw':['--var_dir'],
+        'sw': ['--var-dir', '--var_dir'],
         'dest': 'var_dir',
         'action': Wdir,
-        'help': 'Directory to store var content (ie. database, cache)'},
-    {
+        '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': '''Create database and exit, use destination
-                   specified in --var_dir or standard location.'''},
-    {
-        'sw':['--queue-mode', '-q'],
-        'dest': 'queue_mode',
-        'choices': ['track', 'top', 'album'],
-        #'help': 'Queue mode in [track, top, album]',
-        'help': SUPPRESS, },
-    {
-        'sw':['--purge_history'],
-        'action': 'store_true',
-        'dest': 'do_purge_history',
         'help': SUPPRESS},
+    {
+        'sw': ['command'],
+        'nargs': '?',
+        'choices': CMDS.keys(),
+        'help': 'command to run (cf. description or unix manual for more)'},
 ]
 
 
-class StartOpt(object):
+class StartOpt:
     """Command line management.
     """
 
@@ -127,10 +130,12 @@ class StartOpt(object):
         """
         Declare options in ArgumentParser object.
         """
-        self.parser = ArgumentParser(description=DESCRIPTION,
+        cmds = '\n'.join([f'    * {k}: {v}' for k, v in CMDS.items()])
+        self.parser = ArgumentParser(description=DESCRIPTION.format(cmds),
                                      prog=self.info.get('prog'),
                                      epilog='Happy Listening',
-                                    )
+                                     formatter_class=RawDescriptionHelpFormatter,
+                                     )
         self.parser.add_argument('--version', action='version',
                         version='%(prog)s {version}'.format(**self.info))
         # Add all options declare in OPTS