Merge pull request #5928 from ynput/feature/wrap-click

Chore: Wrapper for click proposal

openpype/hosts/standalonepublisher/addon.py

@@ -1,10 +1,13 @@
 import os
 
-import click
-
 from openpype.lib import get_openpype_execute_args
 from openpype.lib.execute import run_detached_process
-from openpype.modules import OpenPypeModule, ITrayAction, IHostAddon
+from openpype.modules import (
+    click_wrap,
+    OpenPypeModule,
+    ITrayAction,
+    IHostAddon,
+)
 
 STANDALONEPUBLISH_ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
 
@@ -37,10 +40,10 @@ def run_standalone_publisher(self):
         run_detached_process(args)
 
     def cli(self, click_group):
-        click_group.add_command(cli_main)
+        click_group.add_command(cli_main.to_click_obj())
 
 
-@click.group(
+@click_wrap.group(
     StandAlonePublishAddon.name,
     help="StandalonePublisher related commands.")
 def cli_main():

openpype/hosts/traypublisher/addon.py

@@ -1,10 +1,13 @@
 import os
 
-import click
-
 from openpype.lib import get_openpype_execute_args
 from openpype.lib.execute import run_detached_process
-from openpype.modules import OpenPypeModule, ITrayAction, IHostAddon
+from openpype.modules import (
+    click_wrap,
+    OpenPypeModule,
+    ITrayAction,
+    IHostAddon,
+)
 
 TRAYPUBLISH_ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
 
@@ -38,10 +41,12 @@ def run_traypublisher(self):
         run_detached_process(args)
 
     def cli(self, click_group):
-        click_group.add_command(cli_main)
+        click_group.add_command(cli_main.to_click_obj())
 
 
-@click.group(TrayPublishAddon.name, help="TrayPublisher related commands.")
+@click_wrap.group(
+    TrayPublishAddon.name,
+    help="TrayPublisher related commands.")
 def cli_main():
     pass
 

openpype/hosts/webpublisher/addon.py

@@ -1,8 +1,6 @@
 import os
 
-import click
-
-from openpype.modules import OpenPypeModule, IHostAddon
+from openpype.modules import click_wrap, OpenPypeModule, IHostAddon
 
 WEBPUBLISHER_ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
 
@@ -38,21 +36,21 @@ def headless_publish(self, log, close_plugin_name=None, is_test=False):
         )
 
     def cli(self, click_group):
-        click_group.add_command(cli_main)
+        click_group.add_command(cli_main.to_click_obj())
 
 
-@click.group(
+@click_wrap.group(
     WebpublisherAddon.name,
     help="Webpublisher related commands.")
 def cli_main():
     pass
 
 
 @cli_main.command()
-@click.argument("path")
-@click.option("-u", "--user", help="User email address")
-@click.option("-p", "--project", help="Project")
-@click.option("-t", "--targets", help="Targets", default=None,
+@click_wrap.argument("path")
+@click_wrap.option("-u", "--user", help="User email address")
+@click_wrap.option("-p", "--project", help="Project")
+@click_wrap.option("-t", "--targets", help="Targets", default=None,
               multiple=True)
 def publish(project, path, user=None, targets=None):
     """Start publishing (Inner command).
@@ -67,11 +65,11 @@ def publish(project, path, user=None, targets=None):
 
 
 @cli_main.command()
-@click.argument("path")
-@click.option("-p", "--project", help="Project")
-@click.option("-h", "--host", help="Host")
-@click.option("-u", "--user", help="User email address")
-@click.option("-t", "--targets", help="Targets", default=None,
+@click_wrap.argument("path")
+@click_wrap.option("-p", "--project", help="Project")
+@click_wrap.option("-h", "--host", help="Host")
+@click_wrap.option("-u", "--user", help="User email address")
+@click_wrap.option("-t", "--targets", help="Targets", default=None,
               multiple=True)
 def publishfromapp(project, path, host, user=None, targets=None):
     """Start publishing through application (Inner command).
@@ -86,10 +84,10 @@ def publishfromapp(project, path, host, user=None, targets=None):
 
 
 @cli_main.command()
-@click.option("-e", "--executable", help="Executable")
-@click.option("-u", "--upload_dir", help="Upload dir")
-@click.option("-h", "--host", help="Host", default=None)
-@click.option("-p", "--port", help="Port", default=None)
+@click_wrap.option("-e", "--executable", help="Executable")
+@click_wrap.option("-u", "--upload_dir", help="Upload dir")
+@click_wrap.option("-h", "--host", help="Host", default=None)
+@click_wrap.option("-p", "--port", help="Port", default=None)
 def webserver(executable, upload_dir, host=None, port=None):
     """Start service for communication with Webpublish Front end.
 

openpype/modules/__init__.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from . import click_wrap
 from .interfaces import (
     ILaunchHookPaths,
     IPluginPaths,
@@ -28,6 +29,8 @@
 
 
 __all__ = (
+    "click_wrap",
+
     "ILaunchHookPaths",
     "IPluginPaths",
     "ITrayModule",