divbase-cli 0.1.0a9__tar.gz → 0.1.0a12__tar.gz

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: divbase-cli
-Version: 0.1.0a9
+Version: 0.1.0a12
 Summary: Command Line Interface for Divbase
 Project-URL: Homepage, https://divbase.scilifelab-2-prod.sys.kth.se
 Project-URL: Documentation, https://scilifelabdatacentre.github.io/divbase
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.12
-Requires-Dist: divbase-lib==0.1.0a9
+Requires-Dist: divbase-lib==0.1.0a12
 Requires-Dist: keyring>=25.7.0
 Requires-Dist: typer==0.26.7
 Description-Content-Type: text/markdown

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/pyproject.toml

@@ -10,7 +10,7 @@ requires-python = ">=3.12"
 dependencies = [
     "typer==0.26.7",
     "keyring>=25.7.0",
-    "divbase-lib==0.1.0a9",
+    "divbase-lib==0.1.0a12",
 ]
 dynamic = ["version"]
 

divbase_cli-0.1.0a12/src/divbase_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0a12"

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/cli_commands/auth_cli.py

@@ -11,7 +11,12 @@ from pydantic import SecretStr
 from rich import print
 
 from divbase_cli.cli_config import cli_settings
-from divbase_cli.cli_exceptions import DivBaseAPIConnectionError, DivBaseAPIError
+from divbase_cli.cli_exceptions import (
+    DivBaseAPIConnectionError,
+    DivBaseAPIError,
+    InvalidPersonalAccessTokenError,
+    PersonalAccessTokenAlreadyExistsError,
+)
 from divbase_cli.config_resolver import resolve_url_for_non_project_specific_commands
 from divbase_cli.services.announcements import get_and_display_announcements
 from divbase_cli.user_auth import (
@@ -109,27 +114,26 @@ def add_pat(
     """
     existing = load_stored_user_pat()
     if existing and not overwrite_existing:
-        print(
+        raise PersonalAccessTokenAlreadyExistsError(
             f"A personal access token named '{existing.name}' is already stored on your device \n"
             f"It is due to expire on: {existing.pat_expiry_formatted()} \n"
             "Append the flag --overwrite-existing (-o) to this command if you want to replace it. \n"
             "You can only store one PAT at a time."
         )
-        raise typer.Exit(code=1)
 
     if expires_unix_timestamp and expires_unix_timestamp < time.time():
-        print("The expiry time you entered is in the past. Please enter a valid expiry time for the PAT.")
-        raise typer.Exit(code=1)
+        raise InvalidPersonalAccessTokenError(
+            "The expiry time you entered is in the past. Please enter a valid expiry time for the PAT."
+        )
 
     pat = SecretStr(
         typer.prompt("please paste your personal access token now", hide_input=True, confirmation_prompt=False)
     )
     if not pat.get_secret_value().startswith(PAT_TOKEN_PREFIX):
-        print(
+        raise InvalidPersonalAccessTokenError(
             "It looks like the token you entered is not a valid personal access token. "
             f"Please make sure you copied the entire token, including the '{PAT_TOKEN_PREFIX}' prefix."
         )
-        raise typer.Exit(code=1)
 
     pat_data = PATData(name=name, pat=pat, pat_expires_at=expires_unix_timestamp)
     pat_data.dump_pat_data()

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/cli_commands/dimensions_cli.py

@@ -102,11 +102,8 @@ def show_dimensions_index(
     project_config = resolve_project(project_name=project)
     logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
 
-    # These two options are mutually exclusive. But due to how typer handles options, this error will only be raised if --sample-names-output has an input value (i.e. path).
-    # If the path is missing, it will raise an error about the missing path argument instead...
     if sample_names_output and sample_names_stdout:
-        typer.echo("Use only one of --sample-names-output or --sample-names-stdout.", err=True)
-        raise typer.Exit(code=1)
+        raise typer.BadParameter("Use only one of --sample-names-output or --sample-names-stdout.")
 
     if unique_samples:
         response = make_authenticated_request(

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/cli_commands/file_cli.py

@@ -17,6 +17,13 @@ from rich.tree import Tree
 from typing_extensions import Annotated
 
 from divbase_cli.cli_commands.shared_args_options import DOWNLOAD_DIR_OPTION, FORMAT_AS_TSV_OPTION, PROJECT_NAME_OPTION
+from divbase_cli.cli_exceptions import (
+    DuplicateFileNamesError,
+    NoFilesSpecifiedError,
+    NotEmptyDirectoryError,
+    ShellExpandedGlobError,
+    UnsupportedCharactersError,
+)
 from divbase_cli.config_resolver import ensure_logged_in, resolve_download_dir, resolve_project
 from divbase_cli.services.project_versions import get_version_details_command
 from divbase_cli.services.s3_files import (
@@ -46,7 +53,7 @@ from divbase_lib.utils import format_file_size
 file_app = typer.Typer(no_args_is_help=True, help="Download/upload/list files to/from the project's store on DivBase.")
 
 NO_FILES_SPECIFIED_MSG = "No files specified for the command, exiting..."
-NO_UPLOAD_MATCHES_MSG = "Error: The following file paths or glob patterns did not match any existing files:"
+NO_UPLOAD_MATCHES_MSG = "The following file paths or glob patterns did not match any existing files:"
 
 
 PREFIX_ARGUMENT = typer.Argument(
@@ -131,12 +138,10 @@ def list_files(
     """
     if show_deleted_files and include_results_files:
         raise typer.BadParameter(
-            message="The --show-deleted-files option cannot be used with the flag --include-results-files. Please use these options separately."
+            message="The --show-deleted-files and --include-results-files options cannot be used together."
         )
     if detailed and format_output_as_tsv:
-        raise typer.BadParameter(
-            message="The --detailed option cannot be used with the flag --format-output-as-tsv. Please use these options separately."
-        )
+        raise typer.BadParameter(message="The --detailed option and --tsv option cannot be used together.")
 
     project_config = resolve_project(project_name=project)
     logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
@@ -335,6 +340,12 @@ def download_files(
     logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
     download_dir_path = resolve_download_dir(download_dir=download_dir)
 
+    if project_version == "":
+        raise typer.BadParameter(
+            "It seems like you provided an empty string for --project-version. \n"
+            "Please provide a valid project version or omit the flag."
+        )
+
     raw_files_input = _resolve_file_inputs(files=files, file_list=file_list)
     raw_files_input = _expand_folder_prefixes(
         files=raw_files_input,
@@ -399,6 +410,11 @@ def download_all_files(
             message="The --resume and --disable-verify-checksums options cannot be used together, "
             "as checksums are used to determine which files don't need to be downloaded."
         )
+    if project_version == "":
+        raise typer.BadParameter(
+            "It seems like you provided an empty string for --project-version. \n"
+            "Please provide a valid project version or omit the flag."
+        )
 
     project_config = resolve_project(project_name=project)
     logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
@@ -609,16 +625,14 @@ def upload_files(
     logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
 
     if bool(files) + bool(file_list) > 1:
-        print("You cannot specify files as arguments and provide a --file-list.")
-        raise typer.Exit(1)
+        raise typer.BadParameter("You cannot specify files as arguments and provide a --file-list.")
 
     if skip_existing and disable_safe_mode:
-        print(
+        raise typer.BadParameter(
             "The --skip-existing and --disable-safe-mode options cannot be used together.\n"
             "Safe mode calculates file checksums, "
             "and these checksums are needed for --skip-existing to know what files to skip uploading."
         )
-        raise typer.Exit(1)
 
     to_upload = _resolve_user_upload_inputs(
         files=files,
@@ -741,12 +755,11 @@ def remove_directory(
         )
         non_placeholder_files = [f for f in files if f.name != dir]
         if non_placeholder_files:
-            print(
-                f"[red bold]Error: The directory '{dir}' is not empty.\n"
-                f"You must first remove all files and/or subdirectories inside the directory using:\n"
-                "'divbase-cli files rm' and 'divbase-cli files rmdir' [/red bold]"
+            raise NotEmptyDirectoryError(
+                f"The directory '{dir}' is not empty.\n"
+                "You must first remove all files and/or subdirectories inside the directory using:\n"
+                "'divbase-cli files rm' and 'divbase-cli files rmdir'"
             )
-            raise typer.Exit(1)
 
     # NOTE: as dirs are just empty files which end with "/", we can just do a regular soft delete on them.
     deleted_dirs = soft_delete_objects_command(
@@ -849,7 +862,7 @@ def restore_soft_deleted_files(
             print(f"- '{file}'")
 
     if restored_objects_response.not_restored:
-        print("[bold red]WARNING: Some files could not be restored:[/bold red]")
+        print("[bold red]Error: Some files could not be restored:[/bold red]")
         for file in restored_objects_response.not_restored:
             print(f"[red]- '{file}'[/red]")
 
@@ -927,9 +940,8 @@ def _print_ls_detailed(files: list[ObjectDetails], folders: list[str]) -> None:
 
 def _resolve_file_inputs(files: list[str] | None, file_list: Path | None) -> list[str]:
     """Helper function to resolve file inputs from command line arguments."""
-    if bool(files) + bool(file_list) > 1:
-        print("Please specify only one of --files or --file-list.")
-        raise typer.Exit(1)
+    if bool(files) + bool(file_list) != 1:
+        raise typer.BadParameter("Please specify files as arguments or provide a --file-list.")
 
     all_files = set()
     if files:
@@ -941,8 +953,7 @@ def _resolve_file_inputs(files: list[str] | None, file_list: Path | None) -> lis
                 all_files.add(line.strip())
 
     if not all_files:
-        print(NO_FILES_SPECIFIED_MSG)
-        raise typer.Exit(1)
+        raise NoFilesSpecifiedError(NO_FILES_SPECIFIED_MSG)
     return list(all_files)
 
 
@@ -965,21 +976,19 @@ def _resolve_user_upload_inputs(
         remote_dir = remote_dir[1:] if remote_dir.startswith("/") else remote_dir
         remote_dir = remote_dir if remote_dir.endswith("/") else remote_dir + "/"
         if any(char in remote_dir for char in UNSUPPORTED_CHARACTERS_IN_FILENAMES):
-            print(
-                f"[red bold]Error: The --to destination path contains unsupported characters.[/red bold]\n"
-                f"[red]Unsupported characters: {UNSUPPORTED_CHARACTERS_DISPLAY}[/red]\n"
+            raise UnsupportedCharactersError(
+                "The --to destination path contains unsupported characters.\n"
+                f"Unsupported characters: {UNSUPPORTED_CHARACTERS_DISPLAY}"
             )
-            raise typer.Exit(1)
 
     if recursive and files and not any("*" in p for p in files) and any(len(Path(p).parts) > 1 for p in files):
-        print(
-            "[red bold]Error: --recursive was passed but all arguments provided are file paths.[/red bold]\n"
+        raise ShellExpandedGlobError(
+            "--recursive was passed but all arguments provided are file paths.\n"
             "Your shell likely expanded the glob before passing it to this command.\n"
             "To solve the problem, wrap the pattern(s) in quotes to prevent shell expansion, e.g.:\n"
-            "  [green]divbase-cli files upload 'my_data/**/*.vcf.gz' --recursive[/green] AND NOT \n"
-            "  [red]divbase-cli files upload my_data/**/*.vcf.gz --recursive[/red]"
+            "  'divbase-cli files upload 'my_data/**/*.vcf.gz' --recursive' AND NOT \n"
+            "  'divbase-cli files upload my_data/**/*.vcf.gz --recursive'"
         )
-        raise typer.Exit(1)
 
     if files:
         for pattern in files:
@@ -1026,20 +1035,17 @@ def _resolve_user_upload_inputs(
                 to_upload.append(ToUpload(file_path=path, destination_key=(remote_dir or "") + path.name))
 
         if missing_files:
-            print("[red bold]Error: The following file paths provided in your --file-list were not found:[/red bold]")
-            for path in missing_files:
-                print(f"[red]- '{path}'[/red]")
-            raise typer.Exit(1)
+            missing_files_str = "\n".join(f"- '{path}'" for path in missing_files)
+            raise NoFilesSpecifiedError(
+                f"The following file paths provided in your --file-list were not found:\n{missing_files_str}"
+            )
 
     if missing_patterns:
-        print(f"[red bold]{NO_UPLOAD_MATCHES_MSG}[/red bold]")
-        for pattern in missing_patterns:
-            print(f"[red]- '{pattern}'[/red]")
-        raise typer.Exit(1)
+        missing_patterns_str = "\n".join(f"- '{pattern}'" for pattern in missing_patterns)
+        raise NoFilesSpecifiedError(f"{NO_UPLOAD_MATCHES_MSG}\n{missing_patterns_str}")
 
     if not to_upload:
-        print(NO_FILES_SPECIFIED_MSG)
-        raise typer.Exit(1)
+        raise NoFilesSpecifiedError(NO_FILES_SPECIFIED_MSG)
 
     return to_upload
 
@@ -1052,16 +1058,15 @@ def _check_for_duplicate_object_keys(to_upload: list[ToUpload]) -> None:
 
     duplicates = {key: paths for key, paths in key_to_paths.items() if len(paths) > 1}
     if duplicates:
-        print(
-            "[red bold]Error: The following S3 destination keys appear more than once in the upload list.[/red bold]\n"
-            "[red]Multiple local files would overwrite each other at the same key:[/red]\n"
+        duplicates_str = "\n".join(
+            f"'{key}':\n" + "\n".join(f"- {p.resolve()}" for p in paths) for key, paths in duplicates.items()
+        )
+        raise DuplicateFileNamesError(
+            "The following destination names appear more than once in the upload list.\n"
+            "Multiple local files would overwrite each other at the same key:\n"
+            f"{duplicates_str}\n"
+            "Ensure each file maps to a unique destination file, or upload them separately and use the '--to' flag to place the files in separate folders."
         )
-        for key, paths in duplicates.items():
-            print(f"[red bold]'{key}':[/red bold]")
-            for p in paths:
-                print(f"[red]- {p.resolve()}[/red]")
-        print("\nEnsure each file maps to a unique destination key, or use --to to place them in separate folders.")
-        raise typer.Exit(1)
 
 
 def _expand_folder_prefixes(
@@ -1073,7 +1078,7 @@ def _expand_folder_prefixes(
     Given a list of user provided file args, expand any args that are for folders, i.e. they end with a trailing '/'.
     SO updates the list of files to (e.g. download) to include all files inside the folder(s) and returns the updated list.
 
-    Non-folder arguments are passed through unchanged. Raises Exit(1) if a prefix has no files.
+    Non-folder arguments are passed through unchanged. Raises NoFilesSpecifiedError if a prefix has no files.
     """
     all_files: set[str] = set()
     for arg in files:
@@ -1091,8 +1096,7 @@ def _expand_folder_prefixes(
         # strip off any subfolders
         real_files = [f.name for f in full_s3_file_paths if not f.name.endswith("/")]
         if not real_files:
-            print(f"[red bold]Error: No files found inside the folder: '{arg}' that you provided.[/red bold]")
-            raise typer.Exit(1)
+            raise NoFilesSpecifiedError(f"No files found inside the folder: '{arg}' that you provided.")
 
         all_files.update(real_files)
 
@@ -1120,18 +1124,15 @@ def check_no_overlap_on_flattened_downloads(to_download: list[str]) -> None:
 
     duplicates = {name: paths for name, paths in name_to_paths.items() if len(paths) > 1}
     if duplicates:
-        print(
-            "[red bold]Error: The following files would overwrite each other when downloaded with --flatten option.[/red bold]\n"
-            "[red]Multiple files would resolve to the same local file path:[/red]\n"
+        duplicates_str = "\n".join(
+            f"'{name}':\n" + "\n".join(f"-  '{p}'" for p in paths) for name, paths in duplicates.items()
         )
-        for name, paths in duplicates.items():
-            print(f"[red bold]'{name}':[/red bold]")
-            for p in paths:
-                print(f"[red]- {p}[/red]")
-        print(
-            "\nYou must either download without the --flatten option or only download a subset of the the files to avoid this error."
+        raise DuplicateFileNamesError(
+            "The following files would overwrite each other when downloaded with the --flatten option.\n"
+            "Multiple files would resolve to the same local file path:\n"
+            f"{duplicates_str}\n"
+            "You must either download without the --flatten option or only download a subset of the files to avoid this error."
         )
-        raise typer.Exit(1)
 
 
 def _check_for_unsupported_files(all_files: list[ToUpload]) -> None:
@@ -1179,11 +1180,10 @@ def _sanitize_directory_names(directories: list[str]) -> list[str]:
     cleaned_dir_names = []
     for directory in directories:
         if any(char in directory for char in UNSUPPORTED_CHARACTERS_IN_FILENAMES):
-            print(
-                f"[red bold]Error: The directory name '{directory}' contains unsupported characters.[/red bold]\n"
-                f"[red]Unsupported characters: {UNSUPPORTED_CHARACTERS_DISPLAY}[/red]\n"
+            raise UnsupportedCharactersError(
+                f"The directory name '{directory}' contains unsupported characters.\n"
+                f"Unsupported characters: {UNSUPPORTED_CHARACTERS_DISPLAY}"
             )
-            raise typer.Exit(1)
 
         directory = directory if directory.endswith("/") else directory + "/"
         directory = directory[1:] if directory.startswith("/") else directory

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/cli_commands/query_cli.py

@@ -21,7 +21,7 @@ from rich import print
 from divbase_cli.cli_commands.file_cli import _pretty_print_download_results
 from divbase_cli.cli_commands.shared_args_options import DOWNLOAD_DIR_OPTION, PROJECT_NAME_OPTION
 from divbase_cli.cli_config import cli_settings
-from divbase_cli.cli_exceptions import PolledTaskNotFinalError
+from divbase_cli.cli_exceptions import PolledTaskNotFinalError, QueryTaskFailedError
 from divbase_cli.config_resolver import (
     ensure_logged_in,
     resolve_download_dir,
@@ -284,12 +284,11 @@ def get_results_from_query_job_by_task_id(
         )
         _pretty_print_download_results(download_results=download_results)
     else:
-        print(f"Task {task_id} failed. Run 'divbase-cli task-history id {task_id}' for more details on the failure.")
-        print(
+        raise QueryTaskFailedError(
+            f"Task {task_id} failed. Run 'divbase-cli task-history id {task_id}' for more details on the failure.\n"
             f"The task's log file can be downloaded for debugging using the command:\n'divbase-cli files download {log_filename}'\n"
             f"You can view the log file contents directly in your terminal with:\n'divbase-cli files stream {log_filename}'"
         )
-        raise typer.Exit(code=1)
 
 
 def poll_task_until_final_state_reached(divbase_url: str, task_id: int, timeout_mins: int) -> str:

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/cli_config.py

@@ -26,9 +26,13 @@ DEFAULT_PATS_PATH = APP_DIR / ".pat"  # no plural because only 1 stored.
 if DEV_MODE:
     DEFAULT_DIVBASE_API_URL = "http://localhost:8000/api"
     DEFAULT_LOGGING_ON = "1"
+    DEFAULT_TRACEBACKS_ON = "1"
+    DEFAULT_DIVBASE_DOCS_URL = "http://localhost:8008/divbase"
 else:
     DEFAULT_DIVBASE_API_URL = "https://divbase.scilifelab-2-prod.sys.kth.se/api"
     DEFAULT_LOGGING_ON = "0"
+    DEFAULT_TRACEBACKS_ON = "0"
+    DEFAULT_DIVBASE_DOCS_URL = "https://scilifelabdatacentre.github.io/divbase"
 
 
 @dataclass
@@ -50,8 +54,10 @@ class DivBaseCLISettings:
     TOKENS_FALLBACK_PATH: Path = Path(os.getenv("DIVBASE_CLI_TOKENS_PATH", DEFAULT_TOKENS_PATH))
     PATS_FALLBACK_PATH: Path = Path(os.getenv("DIVBASE_CLI_PATS_PATH", DEFAULT_PATS_PATH))
 
+    DIVBASE_DOCS_URL: str = os.getenv("DIVBASE_DOCS_URL", DEFAULT_DIVBASE_DOCS_URL)
     DIVBASE_API_URL: str = os.getenv("DIVBASE_API_URL", DEFAULT_DIVBASE_API_URL)
     METADATA_TSV_NAME: str = os.getenv("DIVBASE_METADATA_TSV_NAME", DEFAULT_METADATA_TSV_NAME)
+    TRACEBACKS_ON: bool = os.getenv("DIVBASE_TRACEBACKS_ON", DEFAULT_TRACEBACKS_ON) == "1"
     LOGGING_ON: bool = os.getenv("DIVBASE_LOGGING_ON", DEFAULT_LOGGING_ON) == "1"
     LOG_LEVEL: str = os.getenv("DIVBASE_LOG_LEVEL", DEFAULT_LOG_LEVEL).upper()
 

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/cli_exceptions.py

@@ -18,6 +18,20 @@ class AuthenticationError(DivBaseCLIError):
         super().__init__(error_message)
 
 
+class PersonalAccessTokenAlreadyExistsError(DivBaseCLIError):
+    """Raised when a user tries to store a new personal access token while one is already stored."""
+
+    def __init__(self, error_message: str = "A personal access token is already stored on this device."):
+        super().__init__(error_message)
+
+
+class InvalidPersonalAccessTokenError(DivBaseCLIError):
+    """Raised when a personal access token provided by the user is invalid."""
+
+    def __init__(self, error_message: str = "The personal access token provided is invalid."):
+        super().__init__(error_message)
+
+
 class DivBaseAPIConnectionError(DivBaseCLIError):
     """Raised when CLI tool can't connect to the provided DivBase API URL."""
 
@@ -63,6 +77,17 @@ class DivBaseAPIError(DivBaseCLIError):
         super().__init__(error_message)
 
 
+class InvalidInputError(DivBaseCLIError):
+    """
+    Raised when invalid input is provided to a CLI command.
+
+    Use this when the issue in the input is only discovered in e.g. service layer, and therefore using typer.BadParameter is not recommended.
+    """
+
+    def __init__(self, error_message: str):
+        super().__init__(error_message)
+
+
 class FileDoesNotExistInSpecifiedVersionError(DivBaseCLIError):
     """Raised when a file does not exist in the project at the specified project version"""
 
@@ -82,6 +107,48 @@ class FileDoesNotExistInSpecifiedVersionError(DivBaseCLIError):
         super().__init__(error_message)
 
 
+class FileAlreadyUploadedError(DivBaseCLIError):
+    """Raised when one or more files being uploaded already exist in the project's store on DivBase."""
+
+    def __init__(self, error_message: str):
+        super().__init__(error_message)
+
+
+class NotEmptyDirectoryError(DivBaseCLIError):
+    """Raised when trying to remove a directory from the project's store that still contains files."""
+
+    def __init__(self, error_message: str):
+        super().__init__(error_message)
+
+
+class NoFilesSpecifiedError(DivBaseCLIError):
+    """Raised when no files were specified or resolved for a command that requires at least one."""
+
+    def __init__(self, error_message: str):
+        super().__init__(error_message)
+
+
+class UnsupportedCharactersError(DivBaseCLIError):
+    """Raised when a user-provided file or directory name contains characters that DivBase does not support."""
+
+    def __init__(self, error_message: str):
+        super().__init__(error_message)
+
+
+class ShellExpandedGlobError(DivBaseCLIError):
+    """Raised when --recursive is passed but the shell has already expanded the glob pattern into file paths."""
+
+    def __init__(self, error_message: str):
+        super().__init__(error_message)
+
+
+class DuplicateFileNamesError(DivBaseCLIError):
+    """Raised when two or more files would resolve to the same destination name."""
+
+    def __init__(self, error_message: str):
+        super().__init__(error_message)
+
+
 class ProjectNameNotSpecifiedError(DivBaseCLIError):
     """
     Raised when the project name is not specified in the command line arguments, and
@@ -117,7 +184,15 @@ class ProjectNotInConfigError(DivBaseCLIError):
         super().__init__(error_message)
 
 
-class PolledTaskNotFinalError(Exception):
-    """Raised when a polled celerytask is not in a final state."""
+class PolledTaskNotFinalError(DivBaseCLIError):
+    """Raised when a polled DivBase task is not in a final state."""
 
-    pass
+    def __init__(self, error_message: str = "The polled task is still running."):
+        super().__init__(error_message)
+
+
+class QueryTaskFailedError(DivBaseCLIError):
+    """Raised when a submitted query task did not complete successfully."""
+
+    def __init__(self, error_message: str = "The query task failed."):
+        super().__init__(error_message)

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/divbase_cli.py

@@ -7,6 +7,7 @@ import os
 import sys
 
 import typer
+from rich import print
 
 from divbase_cli import __version__
 from divbase_cli.cli_commands.auth_cli import auth_app
@@ -17,6 +18,7 @@ from divbase_cli.cli_commands.task_history_cli import task_history_app
 from divbase_cli.cli_commands.user_config_cli import config_app
 from divbase_cli.cli_commands.version_cli import version_app
 from divbase_cli.cli_config import cli_settings
+from divbase_cli.cli_exceptions import DivBaseCLIError
 
 logger = logging.getLogger(__name__)
 
@@ -40,7 +42,7 @@ def version_callback(show_version: bool) -> None:
     """
     if show_version:
         typer.echo(f"divbase-cli version: {__version__}")
-        raise typer.Exit()
+        raise typer.Exit(0)
 
 
 @app.callback()
@@ -74,7 +76,17 @@ def main():
     if cli_settings.LOGGING_ON and not in_auto_complete_mode:
         logging.basicConfig(level=cli_settings.LOG_LEVEL, handlers=[logging.StreamHandler(sys.stderr)])
         logger.info(f"Starting divbase_cli CLI application with logging level: {cli_settings.LOG_LEVEL}")
-    app()
+
+    try:
+        app()
+    except DivBaseCLIError as exc:
+        if cli_settings.TRACEBACKS_ON:
+            raise
+        print(f"[red bold]Error:[/red bold] {str(exc)}")
+        print(
+            f"[dim]Tip: see our guide if you want to see the full traceback for debugging purposes: {cli_settings.DIVBASE_DOCS_URL}/user-guides/troubleshooting/ [/dim]"
+        )
+        sys.exit(1)
 
 
 if __name__ == "__main__":

{divbase_cli-0.1.0a9 → divbase_cli-0.1.0a12}/src/divbase_cli/services/s3_files.py

@@ -11,7 +11,9 @@ import typer
 from rich import print
 
 from divbase_cli.cli_exceptions import (
+    FileAlreadyUploadedError,
     FileDoesNotExistInSpecifiedVersionError,
+    InvalidInputError,
 )
 from divbase_cli.services.pre_signed_urls import (
     DownloadOutcome,
@@ -235,19 +237,16 @@ def download_files_command(
             f"The specified download directory '{download_dir}' is not a directory. Please create it or specify a valid directory before continuing."
         )
 
-    if project_version is not None:
+    if project_version:
         offending_files = [file for file in raw_files_input if ":" in file]
         if offending_files:
-            print(
-                "[red] ERROR: bad Input: If you provide a global project version (using --project-version) "
-                "you cannot also specify specific versions of individual files to download. \n"
-                "offending files in your input: \n"
-                f"{'\n'.join(offending_files)} \n"
-                "Exiting..."
+            raise InvalidInputError(
+                "If you provide a global project version (using --project-version) "
+                "you cannot also specify specific versions of individual files to download.\n"
+                "Offending files in your input:\n"
+                f"{'\n'.join(offending_files)}"
             )
-            raise typer.Exit(1)
 
-    if project_version:
         project_version_details = get_version_details_command(
             project_name=project_name, divbase_base_url=divbase_base_url, version_name=project_version
         )
@@ -370,19 +369,17 @@ def upload_files_command(
         if already_uploaded:
             # skip_existing means we just skip uploading those files that are already there
             if not skip_existing:
-                if dry_run:
-                    print(
-                        "[red bold]Error: The following upload attempt would have failed due to the below error:\n[/red bold]"
-                    )
-
-                files_str = "\n".join(f"'{f.file_path}' (Checksum: {f.checksum_local})" for f in already_uploaded)
-                print(
-                    f"\n[red bold]Error: For the project: '{project_name}'\n"
-                    "The exact version of the following files that you're trying to upload already exist inside the project:\n[/red bold]"
-                    f"[red]{files_str}[/red]\n"
-                    "[bold green]Tip: if you want to skip re-uploading these files and continue uploading the other files, re-run this command with the '--skip-existing' flag.[/bold green]"
+                files_str = "\n".join(f"'{f.file_path}' (Checksum: '{f.checksum_local}')" for f in already_uploaded)
+                message = (
+                    f"For the project: '{project_name}'\n"
+                    "The exact version of the following files that you're trying to upload already exist inside the project:\n"
+                    f"{files_str}\n\n"
+                    "[bold green]Tip: if you want to skip re-uploading these files and continue uploading the other files, "
+                    "re-run this command with the '--skip-existing' flag.[/bold green]"
                 )
-                raise typer.Exit(1)
+                if dry_run:
+                    message = "The following upload attempt would have failed due to the below error:\n" + message
+                raise FileAlreadyUploadedError(message)
             else:
                 for file in already_uploaded:
                     all_skipped_uploads.append(

divbase_cli-0.1.0a9/src/divbase_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.0a9"