CLI flag for getting current branch name for sanity check with venv & pip magic behind the scenes

armory/__main__.py

@@ -23,6 +23,7 @@
 from armory.eval import Evaluator
 import armory.logs
 from armory.logs import log
+from armory.cli.tools import log_current_branch
 from armory.utils.configuration import load_config, load_config_stdin
 from armory.utils.version import to_docker_tag
 import docker
@@ -718,6 +719,23 @@ def exec(command_args, prog, description):
     sys.exit(exit_code)
 
 
+def utils(command_args, prog, description):
+    parser = argparse.ArgumentParser(prog=prog, description=description)
+    _debug(parser)
+
+    parser.add_argument(
+        "--branch",
+        action="store_true",
+        help="Print the current branch name",
+    )
+
+    args = parser.parse_args(command_args)
+    armory.logs.update_filters(args.log_level, args.debug)
+
+    if args.branch:
+        log_current_branch()
+
+
 # command, (function, description)
 PROGRAM = "armory"
 COMMANDS = {
@@ -729,6 +747,7 @@ def exec(command_args, prog, description):
     "configure": (configure, "set up armory and dataset paths"),
     "launch": (launch, "launch a given docker container in armory"),
     "exec": (exec, "run a single exec command in the container"),
+    "utils": (utils, "run a utility script"),
 }
 
 

armory/cli/tools.py

@@ -0,0 +1,26 @@
+import os
+
+from armory.logs import log
+
+
+def log_current_branch():
+    """Log the current git branch of armory. Works independent of the current working directory."""
+    try:
+        from armory.__about__ import __version__
+
+        log.info(f"Armory version: {__version__}")
+    except ModuleNotFoundError:
+        log.info("Unable to extract armory version from __about__.py")
+    try:
+        import git
+
+        repo = git.Repo(
+            os.path.dirname(os.path.realpath(__file__)), search_parent_directories=True
+        )
+        log.info(f"Git branch: {repo.active_branch}")
+    except ImportError:
+        log.info("Unable to import gitpython, cannot determine git branch")
+    except git.exc.InvalidGitRepositoryError:
+        log.info("Unable to find .git directory, cannot determine git branch")
+    except git.exc.GitCommandError:
+        log.info("Unable to determine git branch")