Merge pull request #9 from larsks/fix/remove-defaults.py

Remove defaults.py

Author: memalhot

basecommand.py

@@ -3,6 +3,7 @@
 import abc
 from typing import Protocol
 from typing import Any
+from typing_extensions import override
 
 import argparse
 
@@ -22,6 +23,19 @@ def add_parser(
     ) -> argparse.ArgumentParser: ...
 
 
+class ArgumentDefaultsHelpFormatter(argparse.ArgumentDefaultsHelpFormatter):
+    """Provide the behavior of both argparse.ArgumentDefaultsHelpFormatter
+    and argparse.RawDescriptionHelpFormatter. This means that argparse will
+    care of documenting default values for us, and it won't reformat our
+    carefully crafted help text."""
+
+    @override
+    def _fill_text(
+        self, text: str, width: int | None = None, indent: str | None = None
+    ):
+        return "".join(indent + line for line in text.splitlines(keepends=True))
+
+
 class Command(abc.ABC):
     """
     Base class for all command implementations.
@@ -37,7 +51,7 @@ def build_parser(cls, subparsers: SubParserFactory) -> argparse.ArgumentParser:
             cls.name,
             help=cls.help,
             description=cls.__doc__,
-            formatter_class=argparse.RawDescriptionHelpFormatter,
+            formatter_class=ArgumentDefaultsHelpFormatter,
         )
 
         return p

batchtools.py

@@ -1,7 +1,6 @@
 import argparse
 import sys
 
-import defaults
 from basecommand import Command
 from basecommand import SubParserFactory
 from bj import ListJobsCommand
@@ -33,7 +32,6 @@ def build_parser(self) -> None:
             "--verbose",
             "-v",
             action="count",
-            default=defaults.verbose,
             help="Increase verbosity of output",
         )
 
@@ -59,7 +57,9 @@ def run(self, args: list[str] | None = None):
 
 def main() -> None:
     if not is_logged_in():
-        sys.exit("You are not logged in to the oc cli. Retrieve the token using 'oc login --web' or retrieving the login token from the openshift UI.")
+        sys.exit(
+            "You are not logged in to the oc cli. Retrieve the token using 'oc login --web' or retrieving the login token from the openshift UI."
+        )
 
     app = BatchTools()
     app.run()

br.py

@@ -1,12 +1,13 @@
+# pyright: reportUninitializedInstanceVariable=false
 from typing import cast
-import typing_extensions
 from typing_extensions import override
 
 import argparse
 import os
 import socket
 import sys
 import time
+import uuid
 
 import openshift_client as oc
 
@@ -19,19 +20,27 @@
 
 
 class CreateJobCommandArgs(argparse.Namespace):
+    """This class serves two purposes:
+
+    1. It provides type hints that permit a properly configured IDE (or type
+       checker) to perform type checking on command line option values.
+
+    2. It provides default values for command line options.
+    """
+
     gpu: str = "v100"
     image: str = "image-registry.openshift-image-registry.svc:5000/redhat-ods-applications/csw-run-f25:latest"
     context: bool = True
     name: str = "job"
-    job_id: int = os.getpid()
+    job_id: str = uuid.uuid5(uuid.NAMESPACE_OID, f"{os.getpid()}-{time.time()}").hex
     job_delete: bool = True
     wait: bool = True
     timeout: int = 60 * 15 * 4
     max_sec: int = 60 * 15
     gpu_numreq: int = 1
     gpu_numlim: int = 1
     verbose: int = 0
-    command: list[str] = []
+    command: list[str]
 
 
 class CreateJobCommand(Command):
@@ -76,65 +85,64 @@ def build_parser(cls, subparsers: SubParserFactory):
         p.add_argument(
             "--gpu",
             default=CreateJobCommandArgs.gpu,
-            help=f"Select GPU type (default {CreateJobCommandArgs.gpu})",
+            help="Select GPU type",
         )
         p.add_argument(
             "--image",
             default=CreateJobCommandArgs.image,
-            help=f"Specify container image for job (default {CreateJobCommandArgs.image})",
+            help="Specify container image for job",
         )
         p.add_argument(
             "--context",
             action=argparse.BooleanOptionalAction,
             default=CreateJobCommandArgs.context,
-            help=f"Copy working directory (default {CreateJobCommandArgs.context})",
+            help="Copy working directory",
         )
         p.add_argument(
             "--name",
             default=CreateJobCommandArgs.name,
-            help=f"Base job name (default {CreateJobCommandArgs.name})",
+            help="Base job name",
         )
         p.add_argument(
             "--job-id",
             default=CreateJobCommandArgs.job_id,
-            type=int,
-            help="Job ID suffix (default current pid)",
+            help="Job ID suffix",
         )
         p.add_argument(
             "--job-delete",
             action=argparse.BooleanOptionalAction,
             default=CreateJobCommandArgs.job_delete,
-            help=f"Delete job on completion (default {CreateJobCommandArgs.job_delete})",
+            help="Delete job on completion",
         )
         p.add_argument(
             "--wait",
             action=argparse.BooleanOptionalAction,
             default=CreateJobCommandArgs.wait,
-            help=f"Wait for job completion (default {CreateJobCommandArgs.wait})",
+            help="Wait for job completion",
         )
         p.add_argument(
             "--timeout",
             default=CreateJobCommandArgs.timeout,
             type=int,
-            help=f"Wait timeout in seconds (default {CreateJobCommandArgs.timeout})",
+            help="Wait timeout in seconds",
         )
         p.add_argument(
             "--max-sec",
             default=CreateJobCommandArgs.max_sec,
             type=int,
-            help=f"Maximum execution time in seconds (default {CreateJobCommandArgs.max_sec})",
+            help="Maximum execution time in seconds",
         )
         p.add_argument(
             "--gpu-numreq",
             default=CreateJobCommandArgs.gpu_numreq,
             type=int,
-            help=f"Number of GPUs requested (default {CreateJobCommandArgs.gpu_numreq})",
+            help="Number of GPUs requested",
         )
         p.add_argument(
             "--gpu-numlim",
             default=CreateJobCommandArgs.gpu_numlim,
             type=int,
-            help=f"Number of GPUs limited (default {CreateJobCommandArgs.gpu_numlim})",
+            help="Number of GPUs limited",
         )
         p.add_argument(
             "command",