From 9c6580bb43da90dbea45b72ef85e622d56a57d99 Mon Sep 17 00:00:00 2001
From: clearml <>
Date: Sun, 9 Mar 2025 18:43:41 +0200
Subject: [PATCH] Add clearml-debug CLI

---
 clearml/cli/debug/__init__.py |   0
 clearml/cli/debug/__main__.py | 111 ++++++++++++++++++++++++++++++++++
 setup.py                      |   3 +-
 3 files changed, 113 insertions(+), 1 deletion(-)
 create mode 100644 clearml/cli/debug/__init__.py
 create mode 100644 clearml/cli/debug/__main__.py

diff --git a/clearml/cli/debug/__init__.py b/clearml/cli/debug/__init__.py
new file mode 100644
index 00000000..e69de29b
diff --git a/clearml/cli/debug/__main__.py b/clearml/cli/debug/__main__.py
new file mode 100644
index 00000000..067c8f28
--- /dev/null
+++ b/clearml/cli/debug/__main__.py
@@ -0,0 +1,111 @@
+import sys
+from argparse import ArgumentParser
+from pprint import pprint
+
+from clearml import Task
+from clearml.backend_api.session import Session
+from clearml.config import ConfigWrapper
+from clearml.utilities.pyhocon import HOCONConverter
+from clearml.utilities.pyhocon.exceptions import ConfigMissingException
+from clearml.version import __version__
+
+verbose = 0
+
+
+def print_(msg, verbosity=0):
+    if verbose <= 0:
+        return
+    if verbosity and verbose < verbosity:
+        return
+    print(msg)
+
+
+def do_dump(args):
+    print_("Connecting to ClearML Server at {}".format(Session.get_api_server_host(config=ConfigWrapper._init())))
+
+    session = Task._get_default_session()
+
+    print_(
+        "Server version {} ({} feature set), API version {}".format(
+            session.server_version, Session.feature_set, Session.api_version
+        )
+    )
+
+    msg = "Configuration dump{}:".format("" if not args.path else " ({})".format(args.path))
+    print_(msg)
+    print_("=" * len(msg))
+
+    config = session.config._config._config
+    prefix = ""
+
+    if args.path:
+        try:
+            config = config.get(args.path)
+            prefix = args.path
+        except ConfigMissingException:
+            raise ValueError("Request path {} cannot be found in configuration", format(args.path))
+
+    if args.format.lower() == "dict":
+        pprint(config.as_plain_ordered_dict(), indent=args.indent, width=120)
+    elif args.format.lower() == "json":
+        print(HOCONConverter.to_json(config, indent=args.indent))
+    elif args.format.lower() == "yaml":
+        print(prefix + ": " + HOCONConverter.to_yaml(config, indent=args.indent, level=1 if prefix else 0))
+    elif args.format.lower() == "hocon":
+        print(prefix + " " + HOCONConverter.to_hocon(config, indent=args.indent, level=1 if prefix else 0))
+
+
+def setup_parser(parser):
+    parser.add_argument("-v", "--verbose", action="count", default=0)
+
+    commands = parser.add_subparsers(help="Debug actions", dest="command")
+
+    config = commands.add_parser("config")
+    config_commands = config.add_subparsers(help="Config actions", dest="config_commands")
+    dump = config_commands.add_parser("dump", help="Print configuration dump")
+
+    dump.add_argument(
+        "--format",
+        "-F",
+        choices=["json", "yaml", "dict", "hocon"],
+        help="Output format (default %(default)s)",
+        default="hocon",
+    )
+    dump.add_argument("--indent", "-I", default=2, type=int, help="Indentation (default: %(default)d)")
+    dump.add_argument("--path", "-p", type=str, help='Configuration path to dump (e.g. "api" or "sdk.aws.s3")')
+
+    dump.set_defaults(func=do_dump)
+
+
+def cli():
+    title = "ClearML Debug - debugging tools for using ClearML SDK"
+    parser = ArgumentParser(description=title)
+    setup_parser(parser)
+
+    # get the args
+    args = parser.parse_args()
+
+    global verbose
+    verbose = args.verbose
+
+    print_("ClearML Version {}".format(__version__))
+
+    if len(sys.argv) < 2:
+        parser.print_help()
+        exit(0)
+
+    args.func(args)
+
+
+def main():
+    try:
+        cli()
+    except KeyboardInterrupt:
+        print("\nUser aborted")
+    except Exception as ex:
+        print("\nError: {}".format(ex))
+        exit(1)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/setup.py b/setup.py
index fb9aff84..82300aa6 100644
--- a/setup.py
+++ b/setup.py
@@ -105,7 +105,8 @@ setup(
             'clearml-init = clearml.cli.config.__main__:main',
             'clearml-data = clearml.cli.data.__main__:main',
             'clearml-task = clearml.cli.task.__main__:main',
-            'clearml-param-search = clearml.cli.hpo.__main__:main'
+            'clearml-param-search = clearml.cli.hpo.__main__:main',
+            'clearml-debug = clearml.cli.debug.__main__:main'
         ],
     },
 )