use new click_wrap in existing openpype modules

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 @@ class StandAlonePublishAddon(OpenPypeModule, ITrayAction, IHostAddon):
         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 @@ class TrayPublishAddon(OpenPypeModule, IHostAddon, ITrayAction):
         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,10 +36,10 @@ class WebpublisherAddon(OpenPypeModule, IHostAddon):
         )
 
     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():
@@ -49,10 +47,10 @@ def cli_main():
 
 
 @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/example_addons/example_addon/addon.py

@@ -8,9 +8,9 @@ in global space here until are required or used.
 """
 
 import os
-import click
 
 from openpype.modules import (
+    click_wrap,
     JsonFilesSettingsDef,
     OpenPypeAddOn,
     ModulesManager,
@@ -115,10 +115,10 @@ class ExampleAddon(OpenPypeAddOn, IPluginPaths, ITrayAction):
         }
 
     def cli(self, click_group):
-        click_group.add_command(cli_main)
+        click_group.add_command(cli_main.to_click_obj())
 
 
-@click.group(ExampleAddon.name, help="Example addon dynamic cli commands.")
+@click_wrap.group(ExampleAddon.name, help="Example addon dynamic cli commands.")
 def cli_main():
     pass
 

openpype/modules/ftrack/ftrack_module.py

@@ -3,8 +3,8 @@ import json
 import collections
 import platform
 
-from openpype import click_wrap
 from openpype.modules import (
+    click_wrap,
     OpenPypeModule,
     ITrayModule,
     IPluginPaths,

openpype/modules/job_queue/module.py

@@ -41,8 +41,7 @@ import json
 import copy
 import platform
 
-import click
-from openpype.modules import OpenPypeModule
+from openpype.modules import OpenPypeModule, click_wrap
 from openpype.settings import get_system_settings
 
 
@@ -153,7 +152,7 @@ class JobQueueModule(OpenPypeModule):
         return requests.get(api_path).json()
 
     def cli(self, click_group):
-        click_group.add_command(cli_main)
+        click_group.add_command(cli_main.to_click_obj())
 
     @classmethod
     def get_server_url_from_settings(cls):
@@ -213,7 +212,7 @@ class JobQueueModule(OpenPypeModule):
         return main(str(executable), server_url)
 
 
-@click.group(
+@click_wrap.group(
     JobQueueModule.name,
     help="Application job server. Can be used as render farm."
 )
@@ -225,8 +224,8 @@ def cli_main():
     "start_server",
     help="Start server handling workers and their jobs."
 )
-@click.option("--port", help="Server port")
-@click.option("--host", help="Server host (ip address)")
+@click_wrap.option("--port", help="Server port")
+@click_wrap.option("--host", help="Server host (ip address)")
 def cli_start_server(port, host):
     JobQueueModule.start_server(port, host)
 
@@ -236,7 +235,7 @@ def cli_start_server(port, host):
         "Start a worker for a specific application. (e.g. \"tvpaint/11.5\")"
     )
 )
-@click.argument("app_name")
-@click.option("--server_url", help="Server url which handle workers and jobs.")
+@click_wrap.argument("app_name")
+@click_wrap.option("--server_url", help="Server url which handle workers and jobs.")
 def cli_start_worker(app_name, server_url):
     JobQueueModule.start_worker(app_name, server_url)

openpype/modules/kitsu/kitsu_module.py

@@ -1,9 +1,9 @@
 """Kitsu module."""
 
-import click
 import os
 
 from openpype.modules import (
+    click_wrap,
     OpenPypeModule,
     IPluginPaths,
     ITrayAction,
@@ -98,17 +98,17 @@ class KitsuModule(OpenPypeModule, IPluginPaths, ITrayAction):
         }
 
     def cli(self, click_group):
-        click_group.add_command(cli_main)
+        click_group.add_command(cli_main.to_click_obj())
 
 
-@click.group(KitsuModule.name, help="Kitsu dynamic cli commands.")
+@click_wrap.group(KitsuModule.name, help="Kitsu dynamic cli commands.")
 def cli_main():
     pass
 
 
 @cli_main.command()
-@click.option("--login", envvar="KITSU_LOGIN", help="Kitsu login")
-@click.option(
+@click_wrap.option("--login", envvar="KITSU_LOGIN", help="Kitsu login")
+@click_wrap.option(
     "--password", envvar="KITSU_PWD", help="Password for kitsu username"
 )
 def push_to_zou(login, password):
@@ -124,11 +124,11 @@ def push_to_zou(login, password):
 
 
 @cli_main.command()
-@click.option("-l", "--login", envvar="KITSU_LOGIN", help="Kitsu login")
-@click.option(
+@click_wrap.option("-l", "--login", envvar="KITSU_LOGIN", help="Kitsu login")
+@click_wrap.option(
     "-p", "--password", envvar="KITSU_PWD", help="Password for kitsu username"
 )
-@click.option(
+@click_wrap.option(
     "-prj",
     "--project",
     "projects",
@@ -136,7 +136,7 @@ def push_to_zou(login, password):
     default=[],
     help="Sync specific kitsu projects",
 )
-@click.option(
+@click_wrap.option(
     "-lo",
     "--listen-only",
     "listen_only",

openpype/modules/sync_server/sync_server_module.py

@@ -7,7 +7,6 @@ import copy
 import signal
 from collections import deque, defaultdict
 
-import click
 from bson.objectid import ObjectId
 
 from openpype.client import (
@@ -15,7 +14,12 @@ from openpype.client import (
     get_representations,
     get_representation_by_id,
 )
-from openpype.modules import OpenPypeModule, ITrayModule, IPluginPaths
+from openpype.modules import (
+    OpenPypeModule,
+    ITrayModule,
+    IPluginPaths,
+    click_wrap,
+)
 from openpype.settings import (
     get_project_settings,
     get_system_settings,
@@ -2405,7 +2409,7 @@ class SyncServerModule(OpenPypeModule, ITrayModule, IPluginPaths):
         return presets[project_name]['sites'][site_name]['root']
 
     def cli(self, click_group):
-        click_group.add_command(cli_main)
+        click_group.add_command(cli_main.to_click_obj())
 
     # Webserver module implementation
     def webserver_initialization(self, server_manager):
@@ -2417,13 +2421,15 @@ class SyncServerModule(OpenPypeModule, ITrayModule, IPluginPaths):
             )
 
 
-@click.group(SyncServerModule.name, help="SyncServer module related commands.")
+@click_wrap.group(
+    SyncServerModule.name,
+    help="SyncServer module related commands.")
 def cli_main():
     pass
 
 
 @cli_main.command()
-@click.option(
+@click_wrap.option(
     "-a",
     "--active_site",
     required=True,