divbase-cli 0.1.0.dev2__py3-none-any.whl → 0.1.0.dev4__py3-none-any.whl

divbase_cli/cli_exceptions.py

@@ -4,7 +4,7 @@ Custom exceptions for the divbase CLI.
 
 from pathlib import Path
 
-from divbase_lib.api_schemas.s3 import ExistingFileResponse
+from divbase_lib.divbase_constants import SUPPORTED_DIVBASE_FILE_TYPES, UNSUPPORTED_CHARACTERS_IN_FILENAMES
 
 
 class DivBaseCLIError(Exception):
@@ -41,7 +41,7 @@ class DivBaseAPIError(DivBaseCLIError):
         self,
         error_details: str = "Not Provided",
         error_type: str = "unknown",
-        status_code: int = None,
+        status_code: int = 500,
         http_method: str = "unknown",
         url: str = "unknown",
     ):
@@ -87,8 +87,10 @@ class FilesAlreadyInProjectError(DivBaseCLIError):
     and the user does not want to accidently create a new version of any file.
     """
 
-    def __init__(self, existing_files: list[ExistingFileResponse], project_name: str):
-        files_list = "\n".join(f"- '{obj.object_name}'" for obj in existing_files)
+    def __init__(self, existing_files: dict[Path, str], project_name: str):
+        files_list = "\n".join(
+            f"'{file_path}' (Checksum: {checksum})" for file_path, checksum in existing_files.items()
+        )
         self.existing_files = existing_files
         self.project_name = project_name
 
@@ -106,12 +108,12 @@ class ProjectNameNotSpecifiedError(DivBaseCLIError):
     no default project is set in the user config file.
     """
 
-    def __init__(self, config_path: Path):
-        self.config_path = config_path
+    def __init__(self):
         error_message = (
-            "No project name provided. \n"
-            f"Please either set a default project in your user configuration file at '{config_path.resolve()}'.\n"
-            f"or pass the flag '--project <project_name>' to this command.\n"
+            "No project name provided.\n"
+            "Please either set a default project in your user configuration file.\n"
+            "or pass the flag '--project <project_name>' to this command.\n"
+            "To set a default project, you can run 'divbase-cli config set-default <project_name>'.\n"
         )
         super().__init__(error_message)
 
@@ -135,17 +137,30 @@ class ProjectNotInConfigError(DivBaseCLIError):
         super().__init__(error_message)
 
 
-class ConfigFileNotFoundError(DivBaseCLIError):
-    """Raised when the user's config file cannot be found."""
+class UnsupportedFileTypeError(DivBaseCLIError):
+    """Raised when one or more files to be uploaded are not supported by DivBase (based on file extension)."""
 
-    def __init__(
-        self,
-        error_message: str = (
-            "You're DivBase configuration file was not found or does not exist.\n"
-            "To create a user configuration file, run 'divbase-cli config create'.\n"
-            "If you already have a user configuration file that but it is not stored in the default location, "
-            "you can pass the '--config <path>' flag to specify the location. \n"
-            "You very probably want to just run 'divbase-cli config create' though."
-        ),
-    ):
-        super().__init__(error_message)
+    def __init__(self, unsupported_files: list[Path], supported_types: tuple[str, ...] = SUPPORTED_DIVBASE_FILE_TYPES):
+        self.unsupported_files = unsupported_files
+        self.supported_types = supported_types
+        message = (
+            f"The following file(s) have types that are not supported by DivBase and therefore cannot be uploaded: \n"
+            f"{'\n'.join(str(file) for file in unsupported_files)}\n"
+            f"DivBase currently supports the following file types: {', '.join(SUPPORTED_DIVBASE_FILE_TYPES)}\n"
+            "If you want us to support another file type, please let us know."
+        )
+        super().__init__(message)
+
+
+class UnsupportedFileNameError(DivBaseCLIError):
+    """Raised when one or more files to be uploaded have unsupported characters in their filenames."""
+
+    def __init__(self, unsupported_files: list[Path]):
+        self.unsupported_files = unsupported_files
+        message = (
+            f"The following file(s) have unsupported characters in their filenames and therefore cannot be uploaded: \n"
+            f"{'\n'.join(str(file) for file in unsupported_files)}\n"
+            f"Filenames cannot contain any of the following characters: {', '.join(UNSUPPORTED_CHARACTERS_IN_FILENAMES)}\n"
+            "Please rename the files and try again."
+        )
+        super().__init__(message)

divbase_cli/config_resolver.py

@@ -3,7 +3,7 @@ Functions that resolve for the CLI commands things like:
     - which project to use
     - which download directory to use
     - which DivBase API URL to use
-Based on provider user input and their config file.
+Based on provided user input and their config file.
 """
 
 from pathlib import Path
@@ -12,7 +12,7 @@ from divbase_cli.cli_exceptions import AuthenticationError, ProjectNameNotSpecif
 from divbase_cli.user_config import ProjectConfig, load_user_config
 
 
-def ensure_logged_in(config_path: Path, desired_url: str | None = None) -> str:
+def ensure_logged_in(desired_url: str | None = None) -> str:
     """
     Ensure the user is logged in by checking the logged_in_url value in the user config.
 
@@ -20,7 +20,7 @@ def ensure_logged_in(config_path: Path, desired_url: str | None = None) -> str:
 
     Returns the logged_in_url if valid, otherwise raises an AuthenticationError.
     """
-    config = load_user_config(config_path)
+    config = load_user_config()
     if not config.logged_in_url:
         raise AuthenticationError("You are not logged in. Please log in with 'divbase-cli auth login [EMAIL]'.")
     if desired_url and config.logged_in_url != desired_url:
@@ -30,7 +30,7 @@ def ensure_logged_in(config_path: Path, desired_url: str | None = None) -> str:
     return config.logged_in_url
 
 
-def resolve_project(project_name: str | None, config_path: Path) -> ProjectConfig:
+def resolve_project(project_name: str | None) -> ProjectConfig:
     """
     Helper function to resolve the project to use for a CLI command.
     Falls back to the default project set in the user config if not explicitly provided.
@@ -38,15 +38,15 @@ def resolve_project(project_name: str | None, config_path: Path) -> ProjectConfi
     Once the project is resolved a ProjectConfig object is returned,
     which contains the name and API URL of the project.
     """
-    config = load_user_config(config_path)
+    config = load_user_config()
     if not project_name:
         project_name = config.default_project
     if not project_name:
-        raise ProjectNameNotSpecifiedError(config_path=config_path)
+        raise ProjectNameNotSpecifiedError()
     return config.project_info(project_name)
 
 
-def resolve_divbase_api_url(url: str | None, config_path: Path) -> str:
+def resolve_divbase_api_url(url: str | None) -> str:
     """
     Helper function to resolve the DivBase API URL to use for a CLI command.
 
@@ -56,7 +56,7 @@ def resolve_divbase_api_url(url: str | None, config_path: Path) -> str:
     if url:
         return url
 
-    config = load_user_config(config_path=config_path)
+    config = load_user_config()
 
     if not config.default_project:
         raise ValueError(
@@ -68,7 +68,7 @@ def resolve_divbase_api_url(url: str | None, config_path: Path) -> str:
     return project_config.divbase_url
 
 
-def resolve_download_dir(download_dir: str | None, config_path: Path) -> Path:
+def resolve_download_dir(download_dir: str | None) -> Path:
     """
     Helper function to resolve the download directory to use for a CLI command involving downloading files.
 
@@ -76,7 +76,7 @@ def resolve_download_dir(download_dir: str | None, config_path: Path) -> Path:
     Note: "." or None should default to the current working directory.
     """
     if not download_dir:
-        config = load_user_config(config_path)
+        config = load_user_config()
         download_dir = config.default_download_dir
 
     if download_dir and download_dir != ".":

divbase_cli/divbase_cli.py

@@ -67,7 +67,7 @@ app.add_typer(task_history_app, name="task-history")
 
 def main():
     if cli_settings.LOGGING_ON:
-        logging.basicConfig(level=cli_settings.LOG_LEVEL, handlers=[logging.StreamHandler(sys.stdout)])
+        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()
 

divbase_cli/retries.py

@@ -0,0 +1,34 @@
+"""
+Retry logic for the divbase-cli package.
+
+Defines functions to determine whether to retry based on the type of exceptions raised.
+Functions are used in stamina (package) decorators.
+"""
+
+import httpx
+
+from divbase_cli.cli_exceptions import DivBaseAPIConnectionError, DivBaseAPIError
+
+
+def retry_only_on_retryable_http_errors(exc: Exception) -> bool:
+    """
+    Used by stamina's (library for retries) decorators to determine whether to retry the function or not.
+    We avoid retrying on HTTPStatusError for 4xx errors as no point (e.g. 404 Not Found or 403 Forbidden etc...).
+    """
+    if isinstance(exc, httpx.HTTPStatusError):
+        return exc.response.status_code >= 500
+
+    # Want to retry on other HTTPError (parent of HTTPStatusError),
+    # as this includes timeouts, connection errors, etc.
+    return isinstance(exc, httpx.HTTPError)
+
+
+def retry_only_on_retryable_divbase_api_errors(exception: Exception) -> bool:
+    """
+    Retry condition function for stamina to only retry on retryable DivBase API errors.
+    """
+    if isinstance(exception, DivBaseAPIConnectionError):
+        return True
+
+    # Retry only for server errors (5xx) and rate limiting (429)
+    return isinstance(exception, DivBaseAPIError) and (exception.status_code == 429 or exception.status_code >= 500)

divbase_cli/services/announcements.py

@@ -0,0 +1,46 @@
+"""
+Get announcements from divbase API and display them to the user.
+"""
+
+from rich import print
+
+from divbase_cli.user_auth import make_unauthenticated_request
+from divbase_lib.api_schemas.announcements import AnnouncementResponse
+
+COLOR_MAPPING = {
+    "info": "blue",
+    "success": "green",
+    "warning": "yellow",
+    "danger": "red",
+}
+
+
+def get_and_display_announcements(divbase_base_url: str) -> None:
+    """
+    Get announcements from the API and display them to the user.
+    Used when logging in to display any important messages to the user.
+    """
+    response = make_unauthenticated_request(
+        method="GET",
+        divbase_base_url=divbase_base_url,
+        api_route="/v1/core/announcements",
+    )
+    announcements_data = response.json()
+    if not announcements_data:
+        return
+    announcements = [AnnouncementResponse.model_validate(ann) for ann in announcements_data]
+
+    if len(announcements) == 1:
+        print("[bold]An Announcement from DivBase Server:[/bold]")
+        color = COLOR_MAPPING.get(announcements[0].level)
+        print(f"[bold {color}]{announcements[0].heading}[/bold {color}]")
+        if announcements[0].message:
+            print(f"{announcements[0].message}\n")
+        return
+
+    print("[bold]Announcements from DivBase Server:[/bold]")
+    for idx, ann in enumerate(announcements, start=1):
+        color = COLOR_MAPPING.get(ann.level)
+        print(f"[bold {color}]{idx}) {ann.heading}[/bold {color}]")
+        if ann.message:
+            print(f"{ann.message}\n")