kleinkram 0.38.1.dev20241119134715__py3-none-any.whl → 0.38.1.dev20241125112529__py3-none-any.whl

kleinkram/app.py

@@ -1,19 +1,19 @@
 from __future__ import annotations
 
-from collections import OrderedDict
+import logging
+import sys
+import time
 from enum import Enum
-from typing import Any
-from typing import Callable
+from pathlib import Path
 from typing import List
 from typing import Optional
-from typing import Type
 
 import typer
 from click import Context
 from kleinkram._version import __version__
 from kleinkram.api.client import AuthenticatedClient
-from kleinkram.api.routes import claim_admin
-from kleinkram.api.routes import get_api_version
+from kleinkram.api.routes import _claim_admin
+from kleinkram.api.routes import _get_api_version
 from kleinkram.auth import login_flow
 from kleinkram.commands.download import download_typer
 from kleinkram.commands.endpoint import endpoint_typer
@@ -24,11 +24,20 @@ from kleinkram.commands.upload import upload_typer
 from kleinkram.commands.verify import verify_typer
 from kleinkram.config import Config
 from kleinkram.config import get_shared_state
+from kleinkram.errors import ErrorHandledTyper
 from kleinkram.errors import InvalidCLIVersion
+from kleinkram.utils import format_traceback
 from kleinkram.utils import get_supported_api_version
 from rich.console import Console
 from typer.core import TyperGroup
 
+LOG_DIR = Path() / "logs"
+LOG_FILE = LOG_DIR / f"{time.time_ns()}.log"
+LOG_FORMAT = "%(asctime)s | %(name)s | %(levelname)s | %(message)s"
+
+# setup default logging
+logger = logging.getLogger(__name__)
+
 
 CLI_HELP = """\
 Kleinkram CLI
@@ -40,6 +49,14 @@ for more information.
 """
 
 
+class LogLevel(str, Enum):
+    DEBUG = "DEBUG"
+    INFO = "INFO"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    CRITICAL = "CRITICAL"
+
+
 class CommandTypes(str, Enum):
     AUTH = "Authentication Commands"
     CORE = "Core Commands"
@@ -52,40 +69,6 @@ class OrderCommands(TyperGroup):
         return list(self.commands)
 
 
-ExceptionHandler = Callable[[Exception], int]
-
-
-class ErrorHandledTyper(typer.Typer):
-    """\
-    error handlers that are last added will be used first
-    """
-
-    _error_handlers: OrderedDict[Type[Exception], ExceptionHandler]
-
-    def error_handler(
-        self, exc: type[Exception]
-    ) -> Callable[[ExceptionHandler], ExceptionHandler]:
-        def dec(func: ExceptionHandler) -> ExceptionHandler:
-            self._error_handlers[exc] = func
-            return func
-
-        return dec
-
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, **kwargs)
-        self._error_handlers = OrderedDict()
-
-    def __call__(self, *args: Any, **kwargs: Any) -> int:
-        try:
-            return super().__call__(*args, **kwargs)
-        except Exception as e:
-            for tp, handler in reversed(self._error_handlers.items()):
-                if isinstance(e, tp):
-                    exit_code = handler(e)
-                    raise SystemExit(exit_code)
-            raise
-
-
 app = ErrorHandledTyper(
     cls=OrderCommands,
     help=CLI_HELP,
@@ -93,17 +76,6 @@ app = ErrorHandledTyper(
     no_args_is_help=True,
 )
 
-
-@app.error_handler(Exception)
-def base_handler(exc: Exception) -> int:
-    if not get_shared_state().debug:
-        console = Console()
-        console.print(f"{type(exc).__name__}: {exc}", style="red")
-        return 1
-
-    raise exc
-
-
 app.add_typer(download_typer, name="download", rich_help_panel=CommandTypes.CORE)
 app.add_typer(upload_typer, name="upload", rich_help_panel=CommandTypes.CORE)
 app.add_typer(verify_typer, name="verify", rich_help_panel=CommandTypes.CORE)
@@ -113,6 +85,16 @@ app.add_typer(mission_typer, name="mission", rich_help_panel=CommandTypes.CRUD)
 app.add_typer(project_typer, name="project", rich_help_panel=CommandTypes.CRUD)
 
 
+# attach error handler to app
+@app.error_handler(Exception)
+def base_handler(exc: Exception) -> int:
+    if not get_shared_state().debug:
+        Console(file=sys.stderr).print(f"{type(exc).__name__}: {exc}", style="red")
+        logger.error(format_traceback(exc))
+        return 1
+    raise exc
+
+
 @app.command(rich_help_panel=CommandTypes.AUTH)
 def login(
     key: Optional[str] = typer.Option(None, help="CLI key"),
@@ -130,11 +112,11 @@ def logout(all: bool = typer.Option(False, help="logout on all enpoints")) -> No
 @app.command(hidden=True)
 def claim():
     client = AuthenticatedClient()
-    claim_admin(client)
+    _claim_admin(client)
     print("admin rights claimed successfully.")
 
 
-def _version_cb(value: bool) -> None:
+def _version_callback(value: bool) -> None:
     if value:
         typer.echo(__version__)
         raise typer.Exit()
@@ -142,7 +124,7 @@ def _version_cb(value: bool) -> None:
 
 def check_version_compatiblity() -> None:
     cli_version = get_supported_api_version()
-    api_version = get_api_version()
+    api_version = _get_api_version()
     api_vers_str = ".".join(map(str, api_version))
 
     if cli_version[0] != api_version[0]:
@@ -151,11 +133,9 @@ def check_version_compatiblity() -> None:
         )
 
     if cli_version[1] != api_version[1]:
-        console = Console()
-        console.print(
-            f"CLI version {__version__} might not be compatible with API version {api_vers_str}",
-            style="red",
-        )
+        msg = f"CLI version {__version__} might not be compatible with API version {api_vers_str}"
+        Console(file=sys.stderr).print(msg, style="red")
+        logger.warning(msg)
 
 
 @app.callback()
@@ -163,18 +143,35 @@ def cli(
     verbose: bool = typer.Option(True, help="Enable verbose mode."),
     debug: bool = typer.Option(False, help="Enable debug mode."),
     version: Optional[bool] = typer.Option(
-        None, "--version", "-v", callback=_version_cb
+        None, "--version", "-v", callback=_version_callback
     ),
+    log_level: Optional[LogLevel] = typer.Option(None, help="Set log level."),
 ):
     _ = version  # suppress unused variable warning
     shared_state = get_shared_state()
     shared_state.verbose = verbose
     shared_state.debug = debug
 
+    if shared_state.debug:
+        log_level = LogLevel.DEBUG
+
+    if log_level is not None:
+        LOG_DIR.mkdir(parents=True, exist_ok=True)
+        level = logging.getLevelName(log_level)
+        logging.basicConfig(level=level, filename=LOG_FILE, format=LOG_FORMAT)
+    else:
+        logging.disable(logging.CRITICAL)
+
+    logger.info(f"CLI version: {__version__}")
+
     try:
         check_version_compatiblity()
-    except InvalidCLIVersion:
+    except InvalidCLIVersion as e:
+        logger.error(format_traceback(e))
         raise
     except Exception:
-        console = Console()
-        console.print("failed to check version compatibility", style="yellow")
+        err = ("failed to check version compatibility",)
+        Console(file=sys.stderr).print(
+            err, style="yellow" if shared_state.verbose else None
+        )
+        logger.error(err)

kleinkram/auth.py

@@ -9,9 +9,7 @@ from typing import Optional
 
 from kleinkram.config import Config
 from kleinkram.config import CONFIG_PATH
-from kleinkram.config import CorruptedConfigFile
 from kleinkram.config import Credentials
-from kleinkram.config import InvalidConfigFile
 
 CLI_CALLBACK_ENDPOINT = "/cli/callback"
 OAUTH_SLUG = "/auth/google?state=cli"

kleinkram/commands/download.py

@@ -1,24 +1,25 @@
 from __future__ import annotations
 
-import sys
+import logging
 from pathlib import Path
 from typing import List
 from typing import Optional
 
 import typer
 from kleinkram.api.client import AuthenticatedClient
-from kleinkram.api.file_transfer import download_file
-from kleinkram.api.routes import get_files_by_file_spec
+from kleinkram.api.file_transfer import download_files
 from kleinkram.config import get_shared_state
-from kleinkram.models import FILE_STATE_COLOR
 from kleinkram.models import files_to_table
-from kleinkram.models import FileState
-from kleinkram.utils import b64_md5
-from kleinkram.utils import get_valid_file_spec
-from kleinkram.utils import to_name_or_uuid
+from kleinkram.resources import FileSpec
+from kleinkram.resources import get_files_by_spec
+from kleinkram.resources import MissionSpec
+from kleinkram.resources import ProjectSpec
+from kleinkram.utils import split_args
 from rich.console import Console
 
 
+logger = logging.getLogger(__name__)
+
 HELP = """\
 Download files from kleinkram.
 """
@@ -34,70 +35,69 @@ def download(
     files: Optional[List[str]] = typer.Argument(
         None, help="file names, ids or patterns"
     ),
-    project: Optional[str] = typer.Option(
-        None, "--project", "-p", help="project name or id"
+    projects: Optional[List[str]] = typer.Option(
+        None, "--project", "-p", help="project names, ids or patterns"
     ),
-    mission: Optional[str] = typer.Option(
-        None, "--mission", "-m", help="mission name or id"
+    missions: Optional[List[str]] = typer.Option(
+        None, "--mission", "-m", help="mission names, ids or patterns"
     ),
     dest: str = typer.Option(prompt="destination", help="local path to save the files"),
+    nested: bool = typer.Option(
+        False, help="save files in nested directories, project-name/mission-name"
+    ),
+    overwrite: bool = typer.Option(
+        False, help="overwrite files if they already exist and don't match the filehash"
+    ),
 ) -> None:
-    _files = [to_name_or_uuid(f) for f in files or []]
-    _project = to_name_or_uuid(project) if project else None
-    _mission = to_name_or_uuid(mission) if mission else None
-
     # create destionation directory
     dest_dir = Path(dest)
-
     if not dest_dir.exists():
         typer.confirm(f"Destination {dest_dir} does not exist. Create it?", abort=True)
-
     dest_dir.mkdir(parents=True, exist_ok=True)
 
-    client = AuthenticatedClient()
-    file_spec = get_valid_file_spec(_files, mission=_mission, project=_project)
-    parsed_files = get_files_by_file_spec(client, file_spec)
+    # get file spec
+    file_ids, file_patterns = split_args(files or [])
+    mission_ids, mission_patterns = split_args(missions or [])
+    project_ids, project_patterns = split_args(projects or [])
+
+    project_spec = ProjectSpec(patterns=project_patterns, ids=project_ids)
+    mission_spec = MissionSpec(
+        patterns=mission_patterns,
+        ids=mission_ids,
+        project_spec=project_spec,
+    )
+    file_spec = FileSpec(
+        patterns=file_patterns, ids=file_ids, mission_spec=mission_spec
+    )
 
-    # check if filenames are unique
-    if len(set(f.name for f in parsed_files)) != len(parsed_files):
-        raise ValueError(
-            "the files you are trying to download do not have unique names"
-        )
+    client = AuthenticatedClient()
+    parsed_files = get_files_by_spec(client, file_spec)
 
-    console = Console()
     if get_shared_state().verbose:
         table = files_to_table(parsed_files, title="downloading files...")
-        console.print(table)
+        Console().print(table)
 
-    for file in parsed_files:
-        if file.state != FileState.OK:
-            if get_shared_state().verbose:
-                console.print(
-                    f"Skipping file {file.name} with state ",
-                    end="",
-                )
-                console.print(f"{file.state.value}", style=FILE_STATE_COLOR[file.state])
-            else:
-                print(
-                    f"skipping file {file.name} with state {file.state.value}",
-                    file=sys.stderr,
-                )
-            continue
-
-        try:
-            download_file(
-                client,
-                file_id=file.id,
-                name=file.name,
-                dest=dest_dir,
-                hash=file.hash,
-                size=file.size,
-            )
-        except FileExistsError:
-            local_hash = b64_md5(dest_dir / file.name)
-            if local_hash == file.hash:
-                print(f"{file.name} already exists in dest, skipping...")
-            else:
-                print(f"{file.name} already exists in dest, but has different hash!")
-        except Exception as e:
-            print(f"Error downloading file {file.name}: {repr(e)}")
+    # get paths to files map
+    if (
+        len(set([(file.project_id, file.mission_id) for file in parsed_files])) > 1
+        and not nested
+    ):
+        raise ValueError(
+            "files from multiple missions were selected, consider using `--nested`"
+        )
+    elif not nested:
+        # flat structure
+        paths_to_files = {dest_dir / file.name: file for file in parsed_files}
+    else:
+        # allow for nested directories
+        paths_to_files = {}
+        for file in parsed_files:
+            paths_to_files[
+                dest_dir / file.project_name / file.mission_name / file.name
+            ] = file
+
+    # download files
+    logger.info(f"downloading {paths_to_files} files to {dest_dir}")
+    download_files(
+        client, paths_to_files, verbose=get_shared_state().verbose, overwrite=overwrite
+    )

kleinkram/commands/list.py

@@ -5,17 +5,18 @@ from typing import Optional
 
 import typer
 from kleinkram.api.client import AuthenticatedClient
-from kleinkram.api.routes import get_files_by_file_spec
-from kleinkram.api.routes import get_missions
-from kleinkram.api.routes import get_projects
 from kleinkram.config import get_shared_state
 from kleinkram.models import files_to_table
 from kleinkram.models import missions_to_table
 from kleinkram.models import projects_to_table
-from kleinkram.utils import get_valid_file_spec
-from kleinkram.utils import to_name_or_uuid
+from kleinkram.resources import FileSpec
+from kleinkram.resources import get_files_by_spec
+from kleinkram.resources import get_missions_by_spec
+from kleinkram.resources import get_projects_by_spec
+from kleinkram.resources import MissionSpec
+from kleinkram.resources import ProjectSpec
+from kleinkram.utils import split_args
 from rich.console import Console
-from typer import BadParameter
 
 
 HELP = """\
@@ -28,75 +29,79 @@ list_typer = typer.Typer(
 )
 
 
-def _parse_metadata(raw: List[str]) -> dict:
-    ret = {}
-    for tag in raw:
-        if "=" not in tag:
-            raise BadParameter("tag must be formatted as `key=value`")
-        k, v = tag.split("=")
-        ret[k] = v
-    return ret
-
-
 @list_typer.command()
 def files(
     files: Optional[List[str]] = typer.Argument(
-        None, help="file names, ids or patterns"
+        None,
+        help="file names, ids or patterns",
     ),
-    project: Optional[str] = typer.Option(
+    projects: Optional[List[str]] = typer.Option(
         None, "--project", "-p", help="project name or id"
     ),
-    mission: Optional[str] = typer.Option(
+    missions: Optional[List[str]] = typer.Option(
         None, "--mission", "-m", help="mission name or id"
     ),
 ) -> None:
-    client = AuthenticatedClient()
-
-    _files = [to_name_or_uuid(f) for f in files or []]
-    _project = to_name_or_uuid(project) if project else None
-    _mission = to_name_or_uuid(mission) if mission else None
+    file_ids, file_patterns = split_args(files or [])
+    mission_ids, mission_patterns = split_args(missions or [])
+    project_ids, project_patterns = split_args(projects or [])
+
+    project_spec = ProjectSpec(patterns=project_patterns, ids=project_ids)
+    mission_spec = MissionSpec(
+        project_spec=project_spec,
+        ids=mission_ids,
+        patterns=mission_patterns,
+    )
+    file_spec = FileSpec(
+        mission_spec=mission_spec, patterns=file_patterns, ids=file_ids
+    )
 
     client = AuthenticatedClient()
-    file_spec = get_valid_file_spec(_files, mission=_mission, project=_project)
-    parsed_files = get_files_by_file_spec(client, file_spec)
+    parsed_files = get_files_by_spec(client, file_spec)
 
     if get_shared_state().verbose:
-        table = files_to_table(parsed_files)
-        console = Console()
-        console.print(table)
+        Console().print(files_to_table(parsed_files))
     else:
         for file in parsed_files:
             print(file.id)
 
 
 @list_typer.command()
-def projects() -> None:
+def missions(
+    projects: Optional[List[str]] = typer.Option(
+        None, "--project", "-p", help="project name or id"
+    ),
+    missions: Optional[List[str]] = typer.Argument(None, help="mission names"),
+) -> None:
+    mission_ids, mission_patterns = split_args(missions or [])
+    project_ids, project_patterns = split_args(projects or [])
+
+    project_spec = ProjectSpec(ids=project_ids, patterns=project_patterns)
+    mission_spec = MissionSpec(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_spec=project_spec,
+    )
+
     client = AuthenticatedClient()
-    projects = get_projects(client)
+    parsed_missions = get_missions_by_spec(client, mission_spec)
 
     if get_shared_state().verbose:
-        table = projects_to_table(projects)
-        console = Console()
-        console.print(table)
-    else:
-        for project in projects:
-            print(project.id)
+        Console().print(missions_to_table(parsed_missions))
 
 
 @list_typer.command()
-def missions(
-    project: Optional[str] = typer.Option(None, "--project", "-p", help="project name"),
-    metadata: Optional[List[str]] = typer.Argument(None, help="tag=value pairs"),
+def projects(
+    projects: Optional[List[str]] = typer.Argument(None, help="project names"),
 ) -> None:
-    client = AuthenticatedClient()
+    project_ids, project_patterns = split_args(projects or [])
+    project_spec = ProjectSpec(patterns=project_patterns, ids=project_ids)
 
-    _metadata = _parse_metadata(metadata or [])
-    missions = get_missions(client, project=project, tags=_metadata)
+    client = AuthenticatedClient()
+    parsed_projects = get_projects_by_spec(client, project_spec)
 
     if get_shared_state().verbose:
-        table = missions_to_table(missions)
-        console = Console()
-        console.print(table)
+        Console().print(projects_to_table(parsed_projects))
     else:
-        for mission in missions:
-            print(mission.id)
+        for project in parsed_projects:
+            print(project.id)

kleinkram/commands/mission.py

@@ -5,12 +5,14 @@ from typing import Optional
 
 import typer
 from kleinkram.api.client import AuthenticatedClient
-from kleinkram.api.routes import get_mission_by_spec
-from kleinkram.api.routes import update_mission_metadata
-from kleinkram.errors import MissionDoesNotExist
-from kleinkram.utils import get_valid_mission_spec
+from kleinkram.api.routes import _update_mission_metadata
+from kleinkram.errors import MissionNotFound
+from kleinkram.resources import get_missions_by_spec
+from kleinkram.resources import mission_spec_is_unique
+from kleinkram.resources import MissionSpec
+from kleinkram.resources import ProjectSpec
 from kleinkram.utils import load_metadata
-from kleinkram.utils import to_name_or_uuid
+from kleinkram.utils import split_args
 
 mission_typer = typer.Typer(
     no_args_is_help=True, context_settings={"help_option_names": ["-h", "--help"]}
@@ -32,19 +34,29 @@ def update(
     mission: str = typer.Option(..., "--mission", "-m", help="mission id or name"),
     metadata: str = typer.Option(help="path to metadata file (json or yaml)"),
 ) -> None:
-    _project = to_name_or_uuid(project) if project else None
-    _mission = to_name_or_uuid(mission) if mission else None
+    mission_ids, mission_patterns = split_args([mission])
+    project_ids, project_patterns = split_args([project] if project else [])
 
-    client = AuthenticatedClient()
+    project_spec = ProjectSpec(ids=project_ids, patterns=project_patterns)
+    mission_spec = MissionSpec(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_spec=project_spec,
+    )
+
+    if not mission_spec_is_unique(mission_spec):
+        raise ValueError(f"mission spec is not unique: {mission_spec}")
 
-    mission_spec = get_valid_mission_spec(_mission, _project)
-    mission_parsed = get_mission_by_spec(client, mission_spec)
+    client = AuthenticatedClient()
+    missions = get_missions_by_spec(client, mission_spec)
 
-    if mission_parsed is None:
-        raise MissionDoesNotExist(f"Mission {mission} does not exist")
+    if not missions:
+        raise MissionNotFound(f"Mission {mission} does not exist")
+    elif len(missions) > 1:
+        raise RuntimeError(f"Multiple missions found: {missions}")  # unreachable
 
     metadata_dct = load_metadata(Path(metadata))
-    update_mission_metadata(client, mission_parsed.id, metadata_dct)
+    _update_mission_metadata(client, missions[0].id, metadata=metadata_dct)
 
 
 @mission_typer.command(help=NOT_IMPLEMENTED_YET)