Added option group helpers

Author: MrClock8163

src/instrumentman/geocomtest/__init__.py

@@ -3,8 +3,7 @@
 from click_extra import extra_command
 
 from ..utils import (
-    com_baud_option,
-    com_timeout_option,
+    com_option_group,
     com_port_argument
 )
 
@@ -15,8 +14,7 @@
     context_settings={"auto_envvar_prefix": None}
 )  # type: ignore[misc]
 @com_port_argument()
-@com_baud_option()
-@com_timeout_option()
+@com_option_group()
 def cli(**kwargs: Any) -> None:
     """Test the availability of various GeoCom protocol functions on an
     instrument."""

src/instrumentman/geocomtest/app.py

@@ -58,13 +58,17 @@ def tests(tps: GeoCom) -> None:
 def main(
     port: str,
     baud: int = 9600,
-    timeout: int = 15
+    timeout: int = 15,
+    retry: int = 1,
+    sync_after_timeout: bool = False
 ) -> None:
     try:
         with open_serial(
             port,
             speed=baud,
-            timeout=timeout
+            timeout=timeout,
+            retry=retry,
+            sync_after_timeout=sync_after_timeout
         ) as com:
             tps = GeoCom(com)
             tests(tps)

src/instrumentman/inclination/__init__.py

@@ -4,15 +4,13 @@
     extra_command,
     argument,
     option,
-    option_group,
     IntRange,
     File,
     file_path
 )
 
 from ..utils import (
-    com_baud_option,
-    com_timeout_option,
+    com_option_group,
     com_port_argument
 )
 
@@ -23,12 +21,7 @@
     context_settings={"auto_envvar_prefix": None}
 )  # type: ignore[misc]
 @com_port_argument()
-@option_group(
-    "Connection options",
-    "",
-    com_baud_option(),
-    com_timeout_option()
-)
+@com_option_group()
 @option(
     "-o",
     "--output",

src/instrumentman/inclination/app.py

@@ -56,16 +56,17 @@ def main_measure(
     port: str,
     baud: int = 9600,
     timeout: int = 15,
+    retry: int = 1,
+    sync_after_timeout: bool = False,
     output: TextIOWrapper | None = None,
     positions: int = 1,
     zero: bool = False,
     cycles: int = 1
 ) -> None:
-
     with open_serial(
         port,
-        retry=2,
-        sync_after_timeout=True,
+        retry=retry,
+        sync_after_timeout=sync_after_timeout,
         speed=baud,
         timeout=timeout
     ) as com:

src/instrumentman/morse/__init__.py

@@ -3,15 +3,13 @@
 from click_extra import (
     extra_command,
     option,
-    option_group,
     argument,
     Choice,
     IntRange
 )
 
 from ..utils import (
-    com_baud_option,
-    com_timeout_option,
+    com_option_group,
     com_port_argument
 )
 
@@ -53,12 +51,7 @@
     help="suppress encoding errors and skip non-ASCII characters",
     is_flag=True
 )
-@option_group(
-    "Connection options",
-    "Options related to the serial connection",
-    com_baud_option(),
-    com_timeout_option()
-)
+@com_option_group()
 def cli(**kwargs: Any) -> None:
     """Play a Morse encoded ASCII message through the beep signals
         of a GeoCom capable total station.

src/instrumentman/morse/app.py

@@ -124,6 +124,8 @@ def main(
     ignore_non_ascii: bool = False,
     baud: int = 9600,
     timeout: int = 15,
+    retry: int = 1,
+    sync_after_timeout: bool = False,
     unittime: int = 50,
     compatibility: str = "none",
 ) -> None:
@@ -134,7 +136,13 @@ def main(
             echo_red("The message contains non-ASCII characters.")
             exit(1)
 
-    with open_serial(port, speed=baud, timeout=timeout) as com:
+    with open_serial(
+        port,
+        speed=baud,
+        timeout=timeout,
+        retry=retry,
+        sync_after_timeout=sync_after_timeout
+    ) as com:
         tps = GeoCom(com)
         beepstart = tps.bmm.beep_start
         beepstop = tps.bmm.beep_stop

src/instrumentman/setmeasurement/__init__.py

@@ -4,17 +4,15 @@
     extra_command,
     argument,
     option,
-    option_group,
     Choice,
     IntRange,
     file_path,
     dir_path
 )
-from cloup.constraints import mutually_exclusive
 
 from ..utils import (
-    com_baud_option,
-    com_timeout_option,
+    com_option_group,
+    logging_option_group,
     com_port_argument
 )
 
@@ -35,24 +33,7 @@
     type=dir_path(),
     help="directory to save measurement output to"
 )
-@option_group(
-    "Connection options",
-    "Options related to the serial connection",
-    com_baud_option(),
-    com_timeout_option(),
-    option(
-        "-r",
-        "--retry",
-        help="number of connection retry attempts",
-        type=IntRange(min=0, max=10),
-        default=1
-    ),
-    option(
-        "--sync-after-timeout",
-        help="attempt to synchronize message que after a connection timeout",
-        is_flag=True
-    )
-)
+@com_option_group()
 @option(
     "-f",
     "--format",
@@ -93,27 +74,7 @@
     ),
     default=""
 )
-@option_group(
-    "Logging options",
-    "Options related to the logging functionalities.",
-    option(
-        "--debug",
-        is_flag=True
-    ),
-    option(
-        "--info",
-        is_flag=True
-    ),
-    option(
-        "--warning",
-        is_flag=True
-    ),
-    option(
-        "--error",
-        is_flag=True
-    ),
-    constraint=mutually_exclusive
-)
+@logging_option_group()
 def cli_measure(**kwargs: Any) -> None:
     """Run sets of measurements to predefined targets."""
     from .measure import main

src/instrumentman/setup/__init__.py

@@ -4,14 +4,12 @@
     extra_command,
     argument,
     option,
-    option_group,
     IntRange,
     Choice
 )
 
 from ..utils import (
-    com_baud_option,
-    com_timeout_option,
+    com_option_group,
     com_port_argument
 )
 
@@ -30,24 +28,7 @@
     ),
     type=str
 )
-@option_group(
-    "Connection options",
-    "Options related to the serial connection",
-    com_baud_option(),
-    com_timeout_option(),
-    option(
-        "-r",
-        "--retry",
-        help="number of connection retry attempts",
-        type=IntRange(min=0, max=10),
-        default=1
-    ),
-    option(
-        "--sync-after-timeout",
-        help="attempt to synchronize message que after a connection timeout",
-        is_flag=True
-    )
-)
+@com_option_group()
 def cli_measure(**kwargs: Any) -> None:
     """Measure target points.
 

src/instrumentman/utils.py

@@ -7,10 +7,12 @@
     echo,
     style,
     option,
+    option_group,
     argument,
     Choice,
     IntRange
 )
+from cloup.constraints import mutually_exclusive
 
 
 F = TypeVar('F', bound=Callable[..., Any])
@@ -75,6 +77,51 @@ def com_baud_option() -> Callable[[F], F]:
     )
 
 
+def com_option_group() -> Callable[[F], F]:
+    return option_group(
+        "Connection options",
+        "Options related to the serial connection",
+        com_baud_option(),
+        com_timeout_option(),
+        option(
+            "-r",
+            "--retry",
+            help="number of connection retry attempts",
+            type=IntRange(min=0, max=10),
+            default=1
+        ),
+        option(
+            "--sync-after-timeout",
+            help="attempt to synchronize message que after a timeout",
+            is_flag=True
+        )
+    )
+
+
+def logging_option_group() -> Callable[[F], F]:
+    return option_group(
+        "Logging options",
+        "Options related to the logging functionalities.",
+        option(
+            "--debug",
+            is_flag=True
+        ),
+        option(
+            "--info",
+            is_flag=True
+        ),
+        option(
+            "--warning",
+            is_flag=True
+        ),
+        option(
+            "--error",
+            is_flag=True
+        ),
+        constraint=mutually_exclusive
+    )
+
+
 def echo_color(
     message: Any,
     color: str,