[WIP] Add automatic CLI generation from GW tasks

girder_worker/cli/__init__.py

@@ -0,0 +1,11 @@
+from girder_worker_utils.decorators import GWFuncDesc
+from girder_worker.cli.arguments import (
+    VarsArgCli,
+    KwargsArgCli,
+    PositionalArgCli,
+    KeywordArgCli)
+
+GWFuncDesc.VarsArgCls = VarsArgCli
+GWFuncDesc.KwargsArgCls = KwargsArgCli
+GWFuncDesc.PositionalArgCls = PositionalArgCli
+GWFuncDesc.KeywordArgCls = KeywordArgCli

girder_worker/cli/__main__.py

@@ -0,0 +1,87 @@
+import click
+import pkg_resources as pr
+from click.core import Command, Argument, Option
+from girder_worker.entrypoint import get_extensions, get_extension_tasks, import_all_includes
+from stevedore import driver
+from girder_worker_utils.decorators import GWFuncDesc
+
+GWRUN_ENTRYPOINT_GROUP = 'gwrun_output_handlers'
+
+
+def _cast_to_command(f):
+    if isinstance(f, Command):
+        return f
+
+    description = GWFuncDesc.get_description(f)
+
+    if description is not None:
+        for arg in reversed(description.arguments):
+            # Decorator here will be of type click.option or click.argument
+            arg.decorate(f)
+
+
+    # TODO - hide help_ implementation detail in its own function
+    help_ = None
+    # If it quacks like a celery task, and the wrapped function inside
+    # the celery task has no documentation then set the help_ variable
+    # to an empty string, otherwise this will pick up the
+    # documentation from the celery.local.Proxy class which (at this
+    # stage in the execution) is what "f" actually is.
+    if hasattr(f, "__wrapped__") and \
+       hasattr(f.__wrapped__, "__doc__") and \
+       f.__wrapped__.__doc__ is None:
+        help_ = ""
+
+
+    # Make sure to set the name equal to the function name, Click does
+    # some weird name mangling around underscores that converts them
+    # to dashes.
+
+    return click.decorators.command(name=f.__name__, help=help_)(f)
+
+
+def _iterate_tasks():
+    import_all_includes()
+    for extension in get_extensions():
+        if extension not in ('core', 'docker'):
+            for task in get_extension_tasks(extension).values():
+                yield task
+
+
+
+class GWCommand(click.MultiCommand):
+    def list_commands(self, ctx):
+        return [_cast_to_command(task).name for task in _iterate_tasks()]
+
+    def get_command(self, ctx, name):
+        for task in _iterate_tasks():
+            spec = GWFuncDesc.get_description(task)
+            if spec is not None and spec.func_name == name:
+                return _cast_to_command(task)
+
+    def __call__(self, *args, **kwargs):
+        return self.main(*args, **kwargs)
+
+
+
+@click.group(cls=GWCommand, invoke_without_command=True)
+@click.option('-o', '--output',
+              type=click.Choice([ep.name for ep in pr.iter_entry_points(GWRUN_ENTRYPOINT_GROUP)]),
+              default='stdout')
+@click.pass_context
+def main(ctx, output):
+    pass
+
+@main.resultcallback()
+def process_output(processors, output):
+    for ep in pr.iter_entry_points(GWRUN_ENTRYPOINT_GROUP):
+        if ep.name == output:
+            _handler = ep.load()
+            return _handler(processors)
+
+    # Throw warning here?
+    return processors
+
+
+if __name__ == '__main__':
+    main() #noqa

girder_worker/cli/arguments.py

@@ -0,0 +1,76 @@
+import click
+from girder_worker_utils.decorators import (
+    VarsArg,
+    KwargsArg,
+    PositionalArg,
+    KeywordArg)
+
+# TODO Implement MVP
+class VarsArgCli(VarsArg):
+    click_type = click.argument
+
+    def decorate(self, f):
+        pass
+
+    def get_args(self):
+        return []
+
+    def get_opts(self):
+        return {}
+
+
+# TODO Implement MVP
+class KwargsArgCli(KwargsArg):
+    click_type = click.argument
+
+    def decorate(self, f):
+        pass
+
+    def get_args(self):
+        return []
+
+    def get_opts(self):
+        return {}
+
+
+class PositionalArgCli(PositionalArg):
+
+    def decorate(self, f):
+        click.argument(*self.get_args(), **self.get_opts())(f)
+
+    def get_args(self):
+        if not hasattr(self, 'cli_args'):
+            cli_args = (self.name, )
+        else:
+            cli_args = self.cli_args
+
+        return cli_args
+
+    def get_opts(self):
+        if not hasattr(self, 'cli_opts'):
+            cli_opts = {}
+        else:
+            cli_opts = self.cli_opts
+
+        return cli_opts
+
+
+class KeywordArgCli(KeywordArg):
+    def decorate(self, f):
+        click.option(*self.get_args(), **self.get_opts())(f)
+
+    def get_opts(self):
+        if not hasattr(self, 'cli_opts'):
+            cli_opts = {}
+        else:
+            cli_opts = self.cli_opts
+
+        return cli_opts
+
+    def get_args(self):
+        if not hasattr(self, 'cli_args'):
+            cli_args = ('-{}'.format(self.name), )
+        else:
+            cli_args = self.cli_args
+
+        return cli_args

girder_worker/cli/handlers.py

@@ -0,0 +1,23 @@
+from functools import wraps
+import json
+
+def gwrun_output_handler(func):
+    @wraps(func)
+    def _handler(value, **kwargs):
+        # Call the function for its output side effects
+        func(value, **kwargs)
+
+        # Return the value unmodified
+        return value
+
+    return _handler
+
+
+@gwrun_output_handler
+def stdout_output_handler(value):
+    print(value)
+
+
+@gwrun_output_handler
+def json_output_handler(value):
+    print(json.dumps(value))

setup.py

@@ -123,12 +123,17 @@ def run(self, *args, **kwargs):
         'console_scripts': [
             'girder-worker = girder_worker.__main__:main',
             'girder-worker-cleanup = girder_worker.core.cleanup:main',
-            'girder-worker-config = girder_worker.configure:main'
+            'girder-worker-config = girder_worker.configure:main',
+            'gwrun = girder_worker.cli.__main__:main'
         ],
         'girder_worker_plugins': [
             'core = girder_worker:GirderWorkerPlugin',
             'docker = girder_worker.docker:DockerPlugin [docker]'
         ],
+        'gwrun_output_handlers': [
+            'stdout = girder_worker.cli.handlers:stdout_output_handler',
+            'json = girder_worker.cli.handlers:json_output_handler',
+        ],
         'girder_worker._test_plugins.valid_plugins': [
             'core = girder_worker._test_plugins.plugins:TestCore',
             'plugin1 = girder_worker._test_plugins.plugins:TestPlugin1',