Add Action optional ok_msg and nl

Author: mohabusama

clickclick/console.py

@@ -82,15 +82,18 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
 class Action:
 
-    def __init__(self, msg, **kwargs):
+    def __init__(self, msg, ok_msg=' OK', nl=False, **kwargs):
         self.msg = msg
+        self.ok_msg = ok_msg
         self.msg_args = kwargs
+        self.nl = nl
         self.errors = []
         self._suppress_exception = False
-        self.ok_msg = ' OK'
 
     def __enter__(self):
         action(self.msg, **self.msg_args)
+        if self.nl:
+            secho('')
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
@@ -134,7 +137,7 @@ def format_time(ts):
     diff = now - dt
     s = diff.total_seconds()
     if s > (3600 * 49):
-        t = '{:.0f}d'.format(s / (3600*24))
+        t = '{:.0f}d'.format(s / (3600 * 24))
     elif s > 3600:
         t = '{:.0f}h'.format(s / 3600)
     elif s > 70:
@@ -208,7 +211,7 @@ def print_table(cols, rows, styles=None, titles=None, max_column_widths=None):
     for i, col in enumerate(cols):
         click.secho(('{:' + str(colwidths[col]) + '}').format(titles.get(col, col.title().replace('_', ' '))),
                     nl=False, fg='black', bg='white')
-        if i < len(cols)-1:
+        if i < len(cols) - 1:
             click.secho('│', nl=False, fg='black', bg='white')
     click.echo('')
 
@@ -256,12 +259,12 @@ def choice(prompt: str, options: list, default=None):
             value = label = option
         if value == default:
             promptdefault = i + 1
-        click.secho('{}) {}'.format(i+1, label), err=stderr)
+        click.secho('{}) {}'.format(i + 1, label), err=stderr)
     while True:
         selection = click.prompt('Please select (1-{})'.format(len(options)),
                                  type=int, default=promptdefault, err=stderr)
         try:
-            result = options[int(selection)-1]
+            result = options[int(selection) - 1]
             if isinstance(result, tuple):
                 value, label = result
             else:
@@ -275,6 +278,7 @@ class AliasedGroup(click.Group):
     """
     Click group which allows using abbreviated commands
     """
+
     def get_command(self, ctx, cmd_name):
         rv = click.Group.get_command(self, ctx, cmd_name)
         if rv is not None:

setup.py

@@ -52,8 +52,9 @@ def read_version(package):
 
 class PyTest(TestCommand):
 
-    user_options = [('cov=', None, 'Run coverage'), ('cov-xml=', None, 'Generate junit xml report'), ('cov-html=',
-                    None, 'Generate junit html report'), ('junitxml=', None, 'Generate xml of test results')]
+    user_options = [('cov=', None, 'Run coverage'), ('cov-xml=', None, 'Generate junit xml report'),
+                    ('cov-html=', None, 'Generate junit html report'),
+                    ('junitxml=', None, 'Generate xml of test results')]
 
     def initialize_options(self):
         TestCommand.initialize_options(self)

tests/test_console.py

@@ -45,6 +45,12 @@ def test_action():
     with Action('Perform and progress..') as act:
         act.progress()
 
+    with Action('Perform, progress and done', ok_msg='DONE') as act:
+        act.progress()
+
+    with Action('Perform action new line', nl=True):
+        print('In new line!')
+
     with pytest.raises(SystemExit):
         with Action('Try and fail badly..') as act:
             act.fatal_error('failing..')