Some typing fixes (#581)

* Some typing fixes

* Use explicit Never return type

* Add command name to error messages

Author: wch

rsconnect/actions_content.py

@@ -83,23 +83,37 @@ def build_add_content(
             build_store.set_content_item_build_status(content["guid"], BuildStatus.NEEDS_BUILD)
 
 
+def _validate_build_rm_args(guid: Optional[str], all: bool, purge: bool):
+    if guid and all:
+        raise RSConnectException("You must specify only one of -g/--guid or --all, not both.")
+    if not guid and not all:
+        raise RSConnectException("You must specify one of -g/--guid or --all.")
+
+
 def build_remove_content(
     connect_server: RSConnectServer,
-    guid: str,
-    all: bool = False,
-    purge: bool = False,
+    guid: Optional[str],
+    all: bool,
+    purge: bool,
 ) -> list[str]:
     """
     :return: A list of guids of the content items that were removed
     """
+
+    # Make sure that either `guid` is a string or `all == True`, but not both.
+    _validate_build_rm_args(guid, all, purge)
+
     build_store = ensure_content_build_store(connect_server)
     if build_store.get_build_running():
         raise RSConnectException(
             "There is a build running on this server, " + "please wait for it to finish before removing content."
         )
-    guids: list[str] = [guid]
+    guids: list[str]
     if all:
         guids = [c["guid"] for c in build_store.get_content_items()]
+    else:
+        # If we got here, we know `guid` is not None.
+        guids = [cast(str, guid)]
     for guid in guids:
         build_store.remove_content_item(guid, purge)
     return guids
@@ -125,7 +139,7 @@ def build_start(
     running: bool = False,
     retry: bool = False,
     all: bool = False,
-    poll_wait: int = 2,
+    poll_wait: float = 2,
     debug: bool = False,
 ):
     build_store = ensure_content_build_store(connect_server)
@@ -288,7 +302,7 @@ def _monitor_build(connect_server: RSConnectServer, content_items: list[ContentI
     return True
 
 
-def _build_content_item(connect_server: RSConnectServer, content: ContentItemWithBuildState, poll_wait: int):
+def _build_content_item(connect_server: RSConnectServer, content: ContentItemWithBuildState, poll_wait: float):
     build_store = ensure_content_build_store(connect_server)
     with RSConnectClient(connect_server) as client:
         # Pending futures will still try to execute when ThreadPoolExecutor.shutdown() is called

rsconnect/main.py

@@ -17,6 +17,11 @@
 else:
     from typing_extensions import ParamSpec
 
+if sys.version_info >= (3, 11):
+    from typing import Never
+else:
+    from typing_extensions import Never
+
 from rsconnect.certificates import read_certificate_file
 
 from . import VERSION, api, validation
@@ -101,7 +106,7 @@
 def cli_exception_handler(func: Callable[P, T]) -> Callable[P, T]:
     @wraps(func)
     def wrapper(*args: P.args, **kwargs: P.kwargs):
-        def failed(err: str):
+        def failed(err: str) -> Never:
             click.secho(str(err), fg="bright_red", err=False)
             sys.exit(1)
 
@@ -643,6 +648,8 @@ def details(
     set_verbosity(verbose)
 
     ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert).validate_server()
+    if not isinstance(ce.remote_server, RSConnectServer):
+        raise RSConnectException("`rsconnect details` requires a Posit Connect server.")
 
     click.echo("    Posit Connect URL: %s" % ce.remote_server.url)
 
@@ -2102,13 +2109,6 @@ def _write_framework_manifest(
             write_environment_file(environment, directory)
 
 
-def _validate_build_rm_args(guid: str, all: bool, purge: bool):
-    if guid and all:
-        raise RSConnectException("You must specify only one of -g/--guid or --all, not both.")
-    if not guid and not all:
-        raise RSConnectException("You must specify one of -g/--guid or --all.")
-
-
 @cli.group(no_args_is_help=True, help="Interact with Posit Connect's content API.")
 def content():
     pass
@@ -2217,6 +2217,8 @@ def content_describe(
     output_params(ctx, locals().items())
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert, logger=None).validate_server()
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("`rsconnect content describe` requires a Posit Connect server.")
         result = get_content(ce.remote_server, guid)
         json.dump(result, sys.stdout, indent=2)
 
@@ -2264,6 +2266,8 @@ def content_bundle_download(
     output_params(ctx, locals().items())
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert, logger=None).validate_server()
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("`rsconnect content download-bundle` requires a Posit Connect server.")
         if exists(output) and not overwrite:
             raise RSConnectException("The output file already exists: %s" % output)
 
@@ -2306,6 +2310,8 @@ def add_content_build(
     output_params(ctx, locals().items())
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert, logger=None).validate_server()
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("`rsconnect content build add` requires a Posit Connect server.")
         build_add_content(ce.remote_server, guid)
         if len(guid) == 1:
             logger.info('Added "%s".' % guid[0])
@@ -2356,7 +2362,8 @@ def remove_content_build(
     output_params(ctx, locals().items())
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert, logger=None).validate_server()
-        _validate_build_rm_args(guid, all, purge)
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("`rsconnect content build rm` requires a Posit Connect server.")
         guids = build_remove_content(ce.remote_server, guid, all, purge)
         if len(guids) == 1:
             logger.info('Removed "%s".' % guids[0])
@@ -2400,6 +2407,8 @@ def list_content_build(
     output_params(ctx, locals().items())
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert, logger=None).validate_server()
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("`rsconnect content build ls` requires a Posit Connect server.")
         result = build_list_content(ce.remote_server, guid, status)
         json.dump(result, sys.stdout, indent=2)
 
@@ -2432,6 +2441,8 @@ def get_build_history(
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert)
         ce.validate_server()
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("`rsconnect content build history` requires a Posit Connect server.")
         result = build_history(ce.remote_server, guid)
         json.dump(result, sys.stdout, indent=2)
 
@@ -2481,6 +2492,8 @@ def get_build_logs(
     output_params(ctx, locals().items())
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert, logger=None).validate_server()
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("`rsconnect content build logs` requires a Posit Connect server.")
         for line in emit_build_log(ce.remote_server, guid, format, task_id):
             sys.stdout.write(line)
 
@@ -2548,6 +2561,8 @@ def start_content_build(
     logger.set_log_output_format(format)
     with cli_feedback("", stderr=True):
         ce = RSConnectExecutor(ctx, name, server, api_key, insecure, cacert, logger=None).validate_server()
+        if not isinstance(ce.remote_server, RSConnectServer):
+            raise RSConnectException("rsconnect content build run` requires a Posit Connect server.")
         build_start(ce.remote_server, parallelism, aborted, error, running, retry, all, poll_wait, debug)