kleinkram 0.38.1__tar.gz → 0.38.1.dev20241120100707__tar.gz

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kleinkram
-Version: 0.38.1
+Version: 0.38.1.dev20241120100707
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Classifier: Programming Language :: Python :: 3

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram/api/client.py

@@ -1,30 +1,41 @@
 from __future__ import annotations
 
+import logging
+from typing import Any
+
 import httpx
 from kleinkram.auth import Config
 from kleinkram.config import Credentials
 from kleinkram.errors import LOGIN_MESSAGE
 from kleinkram.errors import NotAuthenticatedException
 
+logger = logging.getLogger(__name__)
+
 
 COOKIE_AUTH_TOKEN = "authtoken"
 COOKIE_REFRESH_TOKEN = "refreshtoken"
 COOKIE_CLI_KEY = "clikey"
 
 
+class NotLoggedInException(Exception): ...
+
+
 class AuthenticatedClient(httpx.Client):
-    def __init__(self, *args, **kwargs) -> None:
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self.config = Config()
 
         if self.config.has_cli_key:
             assert self.config.cli_key, "unreachable"
+            logger.info("using cli key...")
             self.cookies.set(COOKIE_CLI_KEY, self.config.cli_key)
 
         elif self.config.has_refresh_token:
+            logger.info("using refresh token...")
             assert self.config.auth_token is not None, "unreachable"
             self.cookies.set(COOKIE_AUTH_TOKEN, self.config.auth_token)
         else:
+            logger.info("not authenticated...")
             raise NotAuthenticatedException(self.config.endpoint)
 
     def _refresh_token(self) -> None:
@@ -37,6 +48,7 @@ class AuthenticatedClient(httpx.Client):
 
         self.cookies.set(COOKIE_REFRESH_TOKEN, refresh_token)
 
+        logger.info("refreshing token...")
         response = self.post(
             "/auth/refresh-token",
         )
@@ -45,21 +57,39 @@ class AuthenticatedClient(httpx.Client):
         new_access_token = response.cookies[COOKIE_AUTH_TOKEN]
         creds = Credentials(auth_token=new_access_token, refresh_token=refresh_token)
 
+        logger.info("saving new tokens...")
         self.config.save_credentials(creds)
         self.cookies.set(COOKIE_AUTH_TOKEN, new_access_token)
 
-    def request(self, method, url, *args, **kwargs):
+    def request(
+        self, method: str, url: str | httpx.URL, *args: Any, **kwargs: Any
+    ) -> httpx.Response:
+        if isinstance(url, httpx.URL):
+            raise ValueError("url must be a slug")
+
+        # try to do a request
         full_url = f"{self.config.endpoint}{url}"
+        logger.info(f"requesting {method} {full_url}")
         response = super().request(method, full_url, *args, **kwargs)
+        logger.info(f"got response {response}")
 
+        # if the requesting a refresh token fails, we are not logged in
         if (url == "/auth/refresh-token") and response.status_code == 401:
-            raise RuntimeError(LOGIN_MESSAGE)
+            logger.info("got 401, not logged in...")
+            raise NotLoggedInException(LOGIN_MESSAGE)
 
+        # otherwise we try to refresh the token
         if response.status_code == 401:
+            logger.info("got 401, trying to refresh token...")
             try:
                 self._refresh_token()
             except Exception:
-                raise RuntimeError(LOGIN_MESSAGE)
-            return super().request(method, full_url, *args, **kwargs)
+                raise NotLoggedInException(LOGIN_MESSAGE)
+
+            logger.info(f"retrying request {method} {full_url}")
+            resp = super().request(method, full_url, *args, **kwargs)
+            logger.info(f"got response {resp}")
+            return resp
+
         else:
             return response

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram/api/file_transfer.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 import os
 import sys
 from concurrent.futures import ThreadPoolExecutor
@@ -20,12 +21,19 @@ from kleinkram.config import Config
 from kleinkram.config import LOCAL_S3
 from kleinkram.errors import AccessDeniedException
 from kleinkram.errors import CorruptedFile
+from kleinkram.errors import NotValidUUID
+from kleinkram.errors import UploadCredentialsFailed
 from kleinkram.errors import UploadFailed
 from kleinkram.utils import b64_md5
-from kleinkram.utils import raw_rich
-from rich.text import Text
+from kleinkram.utils import format_error
+from kleinkram.utils import format_traceback
+from kleinkram.utils import styled_string
+from rich.console import Console
 from tqdm import tqdm
 
+
+logger = logging.getLogger(__name__)
+
 UPLOAD_CREDS = "/file/temporaryAccess"
 UPLOAD_CONFIRM = "/queue/confirmUpload"
 UPLOAD_CANCEL = "/file/cancelUpload"
@@ -71,7 +79,7 @@ def _confirm_file_upload(
     resp = client.post(UPLOAD_CONFIRM, json=data)
 
     if 400 <= resp.status_code < 500:
-        raise CorruptedFile()
+        raise CorruptedFile("failed to confirm upload")
     resp.raise_for_status()
 
 
@@ -96,7 +104,7 @@ def _get_file_download(client: AuthenticatedClient, id: UUID) -> str:
     if 400 <= resp.status_code < 500:
         raise AccessDeniedException(
             f"Failed to download file: {resp.json()['message']}",
-            "Status Code: " + str(resp.status_code),
+            f"Status Code: {resp.status_code}",
         )
 
     resp.raise_for_status()
@@ -108,7 +116,7 @@ def _get_upload_creditials(
     client: AuthenticatedClient, internal_filenames: List[str], mission_id: UUID
 ) -> Dict[str, UploadCredentials]:
     if mission_id.version != 4:
-        raise ValueError("Mission ID must be a UUIDv4")
+        raise NotValidUUID("Mission ID must be a UUIDv4")
     dct = {
         "filenames": internal_filenames,
         "missionUUID": str(mission_id),
@@ -116,9 +124,8 @@ def _get_upload_creditials(
     resp = client.post(UPLOAD_CREDS, json=dct)
 
     if resp.status_code >= 400:
-        raise ValueError(
-            "Failed to get temporary credentials. Status Code: "
-            f"{resp.status_code}\n{resp.json()['message'][0]}"
+        raise UploadCredentialsFailed(
+            f"Failed to get temporary credentials {internal_filenames}"
         )
 
     data = resp.json()
@@ -178,8 +185,8 @@ def _s3_upload(
             Callback=pbar.update,
         )
     except Exception as e:
-        err = f"error uploading file: {local_path}: {type(e).__name__}"
-        pbar.write(raw_rich(Text(err, style="red")))
+        logger.error(format_traceback(e))
+        pbar.write(format_error(f"error uploading file {local_path}", e))
         return False
     return True
 
@@ -212,6 +219,7 @@ def _upload_file(
         # upload file
         creds = access[job.name]
     except Exception as e:
+        logger.error(format_traceback(e))
         pbar.write(f"unable to get upload credentials for file {job.path.name}: {e}")
         pbar.close()
         if global_pbar is not None:
@@ -226,8 +234,8 @@ def _upload_file(
         try:
             _cancel_file_upload(client, creds.file_id, job.mission_id)
         except Exception as e:
-            msg = Text(f"failed to cancel upload: {type(e).__name__}", style="red")
-            pbar.write(raw_rich(msg))
+            logger.error(format_traceback(e))
+            pbar.write(format_error(f"error cancelling upload {job.path}", e))
     else:
         # tell backend that upload is complete
         try:
@@ -235,15 +243,14 @@ def _upload_file(
             _confirm_file_upload(client, creds.file_id, local_hash)
 
             if global_pbar is not None:
-                msg = Text(f"uploaded {job.path}", style="green")
-                global_pbar.write(raw_rich(msg))
+                msg = f"uploaded {job.path}"
+                logger.info(msg)
+                global_pbar.write(styled_string(msg, style="green"))
                 global_pbar.update()
 
         except Exception as e:
-            msg = Text(
-                f"error confirming upload {job.path}: {type(e).__name__}", style="red"
-            )
-            pbar.write(raw_rich(msg))
+            msg = format_error(f"error confirming upload {job.path}", e)
+            pbar.write(msg)
 
     pbar.close()
     return (job.path.stat().st_size, job.path)
@@ -292,14 +299,16 @@ def upload_files(
 
             total_size += size
         except Exception as e:
+            logger.error(format_traceback(e))
             errors.append(e)
 
     pbar.close()
 
     time = monotonic() - start
-    print(f"upload took {time:.2f} seconds", file=sys.stderr)
-    print(f"total size: {int(total_size)} MB", file=sys.stderr)
-    print(f"average speed: {total_size / time:.2f} MB/s", file=sys.stderr)
+    c = Console(file=sys.stderr)
+    c.print(f"upload took {time:.2f} seconds")
+    c.print(f"total size: {int(total_size)} MB")
+    c.print(f"average speed: {total_size / time:.2f} MB/s")
 
     if errors:
         raise UploadFailed(f"got unhandled errors: {errors} when uploading files")
@@ -307,12 +316,12 @@ def upload_files(
 
 def _url_download(url: str, path: Path, size: int, overwrite: bool = False) -> None:
     if path.exists() and not overwrite:
-        raise FileExistsError(f"File already exists: {path}")
+        raise FileExistsError(f"file already exists: {path}")
 
     with httpx.stream("GET", url) as response:
         with open(path, "wb") as f:
             with tqdm(
-                total=size, desc=f"Downloading {path.name}", unit="B", unit_scale=True
+                total=size, desc=f"downloading {path.name}", unit="B", unit_scale=True
             ) as pbar:
                 for chunk in response.iter_bytes(chunk_size=DOWNLOAD_CHUNK_SIZE):
                     f.write(chunk)
@@ -334,4 +343,4 @@ def download_file(
     observed_hash = b64_md5(file_path)
 
     if observed_hash != hash:
-        raise CorruptedFile("file hash does not match")
+        raise CorruptedFile(f"file hash does not match: {dest}")

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram/api/routes.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 from typing import Any
 from typing import cast
 from typing import Dict
@@ -28,6 +29,8 @@ from kleinkram.models import TagType
 from kleinkram.utils import filtered_by_patterns
 from kleinkram.utils import is_valid_uuid4
 
+logger = logging.getLogger(__name__)
+
 
 MAX_PAGINATION = 10_000
 

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram/app.py

@@ -1,7 +1,12 @@
 from __future__ import annotations
 
+import logging
+import os
+import sys
+import time
 from collections import OrderedDict
 from enum import Enum
+from pathlib import Path
 from typing import Any
 from typing import Callable
 from typing import List
@@ -25,10 +30,18 @@ from kleinkram.commands.verify import verify_typer
 from kleinkram.config import Config
 from kleinkram.config import get_shared_state
 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 +53,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"
@@ -97,10 +118,9 @@ app = ErrorHandledTyper(
 @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")
+        Console(file=sys.stderr).print(f"{type(exc).__name__}: {exc}", style="red")
+        logger.error(format_traceback(exc))
         return 1
-
     raise exc
 
 
@@ -134,7 +154,7 @@ def claim():
     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()
@@ -151,11 +171,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 +181,31 @@ 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)
+
+    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")
+        logger.error(err)

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram/commands/verify.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 import sys
 from enum import Enum
 from pathlib import Path
@@ -22,6 +23,8 @@ from rich.table import Table
 from rich.text import Text
 from tqdm import tqdm
 
+logger = logging.getLogger(__name__)
+
 
 class FileVerificationStatus(str, Enum):
     UPLAODED = "uploaded"
@@ -107,8 +110,7 @@ def verify(
         for path, status in status_dct.items():
             table.add_row(str(path), Text(status, style=FILE_STATUS_STYLES[status]))
 
-        console = Console()
-        console.print(table)
+        Console().print(table)
     else:
         for path, status in status_dct.items():
             stream = (

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram/errors.py

@@ -18,6 +18,9 @@ class MissionDoesNotExist(Exception): ...
 class NoPermission(Exception): ...
 
 
+class UploadCredentialsFailed(Exception): ...
+
+
 class AccessDeniedException(Exception):
     def __init__(self, message: str, api_error: str):
         self.message = message
@@ -38,6 +41,9 @@ class CorruptedFile(Exception): ...
 class NameIsValidUUID(Exception): ...
 
 
+class NotValidUUID(Exception): ...
+
+
 class UploadFailed(Exception): ...
 
 

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram/utils.py

@@ -3,14 +3,13 @@ from __future__ import annotations
 import base64
 import fnmatch
 import hashlib
-import os
 import string
+import traceback
 from hashlib import md5
 from pathlib import Path
 from typing import Any
 from typing import Dict
 from typing import List
-from typing import NamedTuple
 from typing import Optional
 from typing import Sequence
 from typing import Tuple
@@ -44,6 +43,20 @@ def check_file_paths(files: Sequence[Path]) -> None:
             )
 
 
+def format_error(msg: str, exc: Exception, *, verbose: bool = False) -> str:
+    if not verbose:
+        ret = f"{msg}: {type(exc).__name__}"
+    else:
+        ret = f"{msg}: {exc}"
+    return styled_string(ret, style="red")
+
+
+def format_traceback(exc: Exception) -> str:
+    return "".join(
+        traceback.format_exception(etype=type(exc), value=exc, tb=exc.__traceback__)
+    )
+
+
 def filtered_by_patterns(names: Sequence[str], patterns: List[str]) -> List[str]:
     filtered = []
     for name in names:
@@ -52,17 +65,14 @@ def filtered_by_patterns(names: Sequence[str], patterns: List[str]) -> List[str]
     return filtered
 
 
-def raw_rich(*objects: Any, **kwargs: Any) -> str:
+def styled_string(*objects: Any, **kwargs: Any) -> str:
     """\
     accepts any object that Console.print can print
     returns the raw string output
     """
-
     console = Console()
-
     with console.capture() as capture:
         console.print(*objects, **kwargs, end="")
-
     return capture.get()
 
 

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/kleinkram.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kleinkram
-Version: 0.38.1
+Version: 0.38.1.dev20241120100707
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Classifier: Programming Language :: Python :: 3

{kleinkram-0.38.1 → kleinkram-0.38.1.dev20241120100707}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = kleinkram
-version = 0.38.1
+version = 0.38.1-dev20241120100707
 description = give me your bags
 long_description = file: README.md
 long_description_content_type = text/markdown