remote/client: separate ArgumentParser() definition

This is an idiomatic way of setting up argument parsers and allows the
parser to be re-used for manpage/documentation generation.

Signed-off-by: Jonas Rebmann <jre@pengutronix.de>
[bst: rebased]
Signed-off-by: Bastian Krause <bst@pengutronix.de>

Author: jonrebm

labgrid/remote/client.py

@@ -1758,25 +1758,7 @@ def __str__(self):
         return self.value
 
 
-def main():
-    import inspect
-
-    basicConfig(
-        level=logging.WARNING,
-        stream=sys.stderr,
-    )
-
-    StepLogger.start()
-    processwrapper.enable_logging()
-
-    # Support both legacy variables and properly namespaced ones
-    place = os.environ.get("PLACE", None)
-    place = os.environ.get("LG_PLACE", place)
-    state = os.environ.get("STATE", None)
-    state = os.environ.get("LG_STATE", state)
-    initial_state = os.environ.get("LG_INITIAL_STATE", None)
-    token = os.environ.get("LG_TOKEN", None)
-
+def get_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser()
     parser.add_argument(
         "-x",
@@ -1789,24 +1771,19 @@ def main():
         "-c",
         "--config",
         type=str,
-        default=os.environ.get("LG_ENV"),
         help="env config file (default: value from env variable LG_ENV)",
     )
-    parser.add_argument(
-        "-p", "--place", type=str, default=place, help="place name/alias (default: value from env variable LG_PLACE)"
-    )
+    parser.add_argument("-p", "--place", type=str, help="place name/alias (default: value from env variable LG_PLACE)")
     parser.add_argument(
         "-s",
         "--state",
         type=str,
-        default=state,
         help="strategy state to switch into before command (default: value from env varibale LG_STATE)",
     )
     parser.add_argument(
         "-i",
         "--initial-state",
         type=str,
-        default=initial_state,
         help="strategy state to force into before switching to desired state",
     )
     parser.add_argument(
@@ -2120,11 +2097,11 @@ def main():
     subparser.set_defaults(func=ClientSession.create_reservation)
 
     subparser = subparsers.add_parser("cancel-reservation", help="cancel a reservation")
-    subparser.add_argument("token", type=str, default=token, nargs="?" if token else None)
+    subparser.add_argument("token", type=str, nargs="?")
     subparser.set_defaults(func=ClientSession.cancel_reservation)
 
     subparser = subparsers.add_parser("wait", help="wait for a reservation to be allocated")
-    subparser.add_argument("token", type=str, default=token, nargs="?" if token else None)
+    subparser.add_argument("token", type=str, nargs="?")
     subparser.set_defaults(func=ClientSession.wait_reservation)
 
     subparser = subparsers.add_parser("reservations", help="list current reservations")
@@ -2147,13 +2124,57 @@ def main():
     subparser = subparsers.add_parser("version", help="show version")
     subparser.set_defaults(func=ClientSession.print_version)
 
+    return parser
+
+
+def main():
+    import inspect
+
+    basicConfig(
+        level=logging.WARNING,
+        stream=sys.stderr,
+    )
+
+    StepLogger.start()
+    processwrapper.enable_logging()
+
+    # Support both legacy variables and properly namespaced ones
+    place = os.environ.get("PLACE", None)
+    place = os.environ.get("LG_PLACE", place)
+    state = os.environ.get("STATE", None)
+    state = os.environ.get("LG_STATE", state)
+    initial_state = os.environ.get("LG_INITIAL_STATE", None)
+    token = os.environ.get("LG_TOKEN", None)
+
+    parser = get_parser()
+
     # make any leftover arguments available for some commands
     args, leftover = parser.parse_known_args()
     if args.command not in ["ssh", "rsync", "forward"]:
         args = parser.parse_args()
     else:
         args.leftover = leftover
 
+    # handle dynamic defaults
+    if args.config is None:
+        args.config = os.environ.get("LG_ENV")
+
+    if args.place is None:
+        args.place = place
+
+    if args.state is None:
+        args.state = state
+
+    if args.initial_state is None:
+        args.initial_state = initial_state
+
+    if args.command in ["cancel-reservation", "wait"] and args.token is None:
+        if token:
+            args.token = token
+        else:
+            print("Please provide a token", file=sys.stderr)
+            exit(1)
+
     if args.verbose:
         logging.getLogger().setLevel(logging.INFO)
     if args.verbose > 1:

man/labgrid-client.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LABGRID-CLIENT" "1" "Nov 05, 2025" "" "labgrid"
+.TH "LABGRID-CLIENT" "1" "2025" "" "labgrid"
 .SH NAME
 labgrid-client \- labgrid's client interface to control boards
 .SH LABGRID-CLIENT INTERFACE TO CONTROL BOARDS

man/labgrid-coordinator.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LABGRID-COORDINATOR" "1" "Nov 05, 2025" "" "labgrid"
+.TH "LABGRID-COORDINATOR" "1" "2025" "" "labgrid"
 .SH NAME
 labgrid-coordinator \- managing labgrid resources and places
 .SH LABGRID-COORDINATOR MANAGING LABGRID RESOURCES AND PLACES

man/labgrid-device-config.5

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LABGRID-DEVICE-CONFIG" "5" "Nov 05, 2025" "" "labgrid"
+.TH "LABGRID-DEVICE-CONFIG" "5" "2025" "" "labgrid"
 .SH NAME
 labgrid-device-config \- test configuration files
 .SH LABGRID TEST CONFIGURATION FILES

man/labgrid-exporter.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LABGRID-EXPORTER" "1" "Nov 05, 2025" "" "labgrid"
+.TH "LABGRID-EXPORTER" "1" "2025" "" "labgrid"
 .SH NAME
 labgrid-exporter \- interface to control boards
 .SH LABGRID-EXPORTER INTERFACE TO CONTROL BOARDS

man/labgrid-pytest.7

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LABGRID-PYTEST" "7" "Nov 05, 2025" "" "labgrid"
+.TH "LABGRID-PYTEST" "7" "2025" "" "labgrid"
 .SH NAME
 labgrid-pytest \- labgrid integration for pytest
 .SH LABGRID-PYTEST LABGRID INTEGRATION FOR PYTEST

man/labgrid-suggest.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LABGRID-SUGGEST" "1" "Nov 05, 2025" "" "labgrid"
+.TH "LABGRID-SUGGEST" "1" "2025" "" "labgrid"
 .SH NAME
 labgrid-suggest \- generator for YAML config files
 .SH LABGRID-SUGGEST GENERATOR FOR YAML CONFIG FILES