lfss 0.12.0__tar.gz → 0.12.2__tar.gz

{lfss-0.12.0 → lfss-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lfss
-Version: 0.12.0
+Version: 0.12.2
 Summary: Lite file storage service
 Home-page: https://github.com/MenxLi/lfss
 Author: Li, Mengxun
@@ -10,16 +10,15 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: aiofiles (==24.*)
-Requires-Dist: aiosqlite (==0.*)
-Requires-Dist: fastapi (==0.*)
-Requires-Dist: mimesniff (==1.*)
-Requires-Dist: pillow
-Requires-Dist: python-multipart
+Provides-Extra: all
+Requires-Dist: aiofiles (==24.*) ; extra == "all"
+Requires-Dist: aiosqlite (==0.*) ; extra == "all"
+Requires-Dist: fastapi[standard] (==0.*) ; extra == "all"
+Requires-Dist: mimesniff (==1.*) ; extra == "all"
+Requires-Dist: pillow ; extra == "all"
 Requires-Dist: requests (==2.*)
-Requires-Dist: rich
-Requires-Dist: stream-zip (==0.*)
-Requires-Dist: uvicorn (==0.*)
+Requires-Dist: rich ; extra == "all"
+Requires-Dist: stream-zip (==0.*) ; extra == "all"
 Project-URL: Repository, https://github.com/MenxLi/lfss
 Description-Content-Type: text/markdown
 
@@ -41,7 +40,7 @@ Tested on 2 million files, and it is still fast.
 
 Usage: 
 ```sh
-pip install lfss
+pip install "lfss[all]"
 lfss-user add <username> <password>
 lfss-serve
 ```

{lfss-0.12.0 → lfss-0.12.2}/Readme.md

@@ -16,7 +16,7 @@ Tested on 2 million files, and it is still fast.
 
 Usage: 
 ```sh
-pip install lfss
+pip install "lfss[all]"
 lfss-user add <username> <password>
 lfss-serve
 ```

{lfss-0.12.0 → lfss-0.12.2}/docs/Client.md

@@ -3,8 +3,7 @@
 
 To install python CLI tools without dependencies (to avoid conflicts with your existing packages):
 ```sh
-pip install requests
-pip install lfss --no-deps
+pip install lfss
 ```
 
 Then set the `LFSS_ENDPOINT`, `LFSS_TOKEN` environment variables, 

{lfss-0.12.0 → lfss-0.12.2}/docs/changelog.md

@@ -1,5 +1,13 @@
 ## 0.12
 
+### 0.12.2
+- Setup optional dependencies
+- Present only the name by default for CLI list command
+
+### 0.12.1
+- Add `cat` command
+- Use unicode icons for CLI list command
+
 ### 0.12.0
 - Change default script to client CLI
 - Client CLI default to verbose output

{lfss-0.12.0 → lfss-0.12.2}/lfss/api/connector.py

@@ -212,12 +212,12 @@ class Connector:
         if response is None: return None
         return response.content
     
-    def get_stream(self, path: str) -> Iterator[bytes]:
+    def get_stream(self, path: str, chunk_size = 1024) -> Iterator[bytes]:
         """Downloads a file from the specified path, will raise PathNotFoundError if path not found."""
         path = _p(path)
         response = self._get(path, stream=True)
         if response is None: raise PathNotFoundError("Path not found: " + path)
-        return response.iter_content(chunk_size=1024)
+        return response.iter_content(chunk_size)
 
     def get_json(self, path: str) -> Optional[dict]:
         path = _p(path)

{lfss-0.12.0 → lfss-0.12.2}/lfss/cli/__init__.py

@@ -16,16 +16,13 @@ def catch_request_error(error_code_handler: Optional[ dict[int, Callable[[reques
             print(f"\033[91m[Error message]: {e.response.text}\033[0m")
 
 T = TypeVar('T')
-def line_sep(iter: Iterable[T], enable=True, start=True, end=True, color="\033[90m") -> Generator[T, None, None]:
+def line_sep(iter: Iterable[T], enable=True, start=True, end=True, middle=False, color="\033[90m") -> Generator[T, None, None]:
     screen_width = os.get_terminal_size().columns
     def print_ln():
         if enable: print(color + "-" * screen_width + "\033[0m")
 
-    if start:
-        print_ln()
+    if start: print_ln()
     for i, line in enumerate(iter):
-        if i > 0:
-            print_ln()
+        if i > 0 and middle: print_ln()
         yield line
-    if end:
-        print_ln()
+    if end: print_ln()

{lfss-0.12.0 → lfss-0.12.2}/lfss/cli/cli.py

@@ -1,12 +1,15 @@
 from pathlib import Path
 import argparse, typing, sys
 from lfss.api import Connector, upload_directory, upload_file, download_file, download_directory
-from lfss.eng.datatype import FileReadPermission, FileSortKey, DirSortKey, AccessLevel
+from lfss.eng.datatype import (
+    FileReadPermission, AccessLevel, 
+    FileSortKey, DirSortKey, 
+    FileRecord, DirectoryRecord, PathContents
+    )
 from lfss.eng.utils import decode_uri_components, fmt_storage_size
-from . import catch_request_error, line_sep as _line_sep
 
-# monkey patch to avoid printing line separators...may remove line_sep in the future
-line_sep = lambda *args, **kwargs: _line_sep(*args, enable=False, **kwargs)
+from . import catch_request_error, line_sep
+from .cli_lib import mimetype_unicode, stream_text
 
 def parse_permission(s: str) -> FileReadPermission:
     for p in FileReadPermission:
@@ -25,6 +28,50 @@ def default_error_handler_dict(path: str):
         404: lambda _: print(f"\033[31mNot found\033[0m ({path})", file=sys.stderr), 
         409: lambda _: print(f"\033[31mConflict\033[0m ({path})", file=sys.stderr),
     }
+def print_path_list(
+    path_list: list[FileRecord] | list[DirectoryRecord] | PathContents, 
+    detailed: bool = False
+    ):
+    dirs: list[DirectoryRecord]
+    files: list[FileRecord]
+    if isinstance(path_list, PathContents):
+        dirs = path_list.dirs
+        files = path_list.files
+    else:
+        dirs = [p for p in path_list if isinstance(p, DirectoryRecord)]
+        files = [p for p in path_list if isinstance(p, FileRecord)]
+    # check if terminal supports unicode
+    supports_unicode = sys.stdout.encoding.lower().startswith("utf")
+    def print_ln(r: DirectoryRecord | FileRecord):
+        nonlocal detailed, supports_unicode
+        match (r, supports_unicode):
+            case (DirectoryRecord(), True):
+                print(mimetype_unicode(r), end=" ")
+            case (DirectoryRecord(), False):
+                print("[D]", end=" ")
+            case (FileRecord(), True):
+                print(mimetype_unicode(r), end=" ")
+            case (FileRecord(), False):
+                print("[F]", end=" ")
+            case _:
+                print("[?]", end=" ")
+        # if not detailed, only print name
+        if not detailed:
+            if isinstance(r, DirectoryRecord):
+                assert r.url.endswith("/")
+                print(decode_uri_components(r.url).rstrip("/").split("/")[-1], end="/")
+            else:
+                print(decode_uri_components(r.url).split("/")[-1], end="")
+        else:
+            print(decode_uri_components(r.url), end="")
+            if isinstance(r, FileRecord):
+                print(f" :: {fmt_storage_size(r.file_size)} {r.permission.name}", end="")
+        print()
+    
+    for d in line_sep(dirs, end=False):
+        print_ln(d)
+    for f in line_sep(files, start=False):
+        print_ln(f)
 
 def parse_arguments():
     parser = argparse.ArgumentParser(description="Client-side command line interface, set LFSS_ENDPOINT and LFSS_TOKEN environment variables for authentication.")
@@ -74,7 +121,7 @@ def parse_arguments():
     sp_list.add_argument("path", help="Path to list", type=str)
     sp_list.add_argument("--offset", type=int, default=0, help="Offset of the list")
     sp_list.add_argument("--limit", type=int, default=100, help="Limit of the list")
-    sp_list.add_argument("-l", "--long", action="store_true", help="Detailed list, including all metadata")
+    sp_list.add_argument("-l", "--long", action="store_true", help="Detailed list")
     sp_list.add_argument("--order", "--order-by", type=str, help="Order of the list", default="", choices=typing.get_args(FileSortKey))
     sp_list.add_argument("--reverse", "--order-desc", action="store_true", help="Reverse the list order")
 
@@ -83,7 +130,7 @@ def parse_arguments():
     sp_list_d.add_argument("path", help="Path to list", type=str)
     sp_list_d.add_argument("--offset", type=int, default=0, help="Offset of the list")
     sp_list_d.add_argument("--limit", type=int, default=100, help="Limit of the list")
-    sp_list_d.add_argument("-l", "--long", action="store_true", help="Detailed list, including all metadata")
+    sp_list_d.add_argument("-l", "--long", action="store_true", help="Detailed list")
     sp_list_d.add_argument("--order", "--order-by", type=str, help="Order of the list", default="", choices=typing.get_args(DirSortKey))
     sp_list_d.add_argument("--reverse", "--order-desc", action="store_true", help="Reverse the list order")
 
@@ -93,10 +140,14 @@ def parse_arguments():
     sp_list_f.add_argument("--offset", type=int, default=0, help="Offset of the list")
     sp_list_f.add_argument("--limit", type=int, default=100, help="Limit of the list")
     sp_list_f.add_argument("-r", "--recursive", "--flat", action="store_true", help="List files recursively")
-    sp_list_f.add_argument("-l", "--long", action="store_true", help="Detailed list, including all metadata")
+    sp_list_f.add_argument("-l", "--long", action="store_true", help="Detailed list")
     sp_list_f.add_argument("--order", "--order-by", type=str, help="Order of the list", default="", choices=typing.get_args(FileSortKey))
     sp_list_f.add_argument("--reverse", "--order-desc", action="store_true", help="Reverse the list order")
 
+    # show content
+    sp_show = sp.add_parser("concatenate", help="Concatenate and print files", aliases=["cat"])
+    sp_show.add_argument("path", help="Path to the text files", type=str, nargs="+")
+    sp_show.add_argument("-e", "--encoding", type=str, default="utf-8", help="Text file encoding, default utf-8")
     return parser.parse_args()
 
 def main():
@@ -213,13 +264,7 @@ def main():
                 order_by=args.order,
                 order_desc=args.reverse,
             )
-            for i, d in enumerate(line_sep(res.dirs, end=False)):
-                d.url = decode_uri_components(d.url)
-                print(f"[d{i+1}] {d if args.long else d.url}")
-            for i, f in enumerate(line_sep(res.files)):
-                f.url = decode_uri_components(f.url)
-                print(f"[f{i+1}] {f if args.long else f.url}")
-
+            print_path_list(res, detailed=args.long)
             if len(res.dirs) + len(res.files) == args.limit:
                 print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more items.\033[0m")
     
@@ -233,10 +278,7 @@ def main():
                 order_by=args.order,
                 order_desc=args.reverse,
             )
-            for i, f in enumerate(line_sep(res)):
-                f.url = decode_uri_components(f.url)
-                print(f"[{i+1}] {f if args.long else f.url}")
-
+            print_path_list(res, detailed=args.long)
             if len(res) == args.limit:
                 print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more files.\033[0m")
         
@@ -250,13 +292,19 @@ def main():
                 order_by=args.order,
                 order_desc=args.reverse,
             )
-            for i, d in enumerate(line_sep(res)):
-                d.url = decode_uri_components(d.url)
-                print(f"[{i+1}] {d if args.long else d.url}")
-
+            print_path_list(res, detailed=args.long)
             if len(res) == args.limit:
                 print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more directories.\033[0m")
     
+    elif args.command in ["cat", "concatenate"]:
+        for _p in args.path:
+            with catch_request_error(default_error_handler_dict(_p)):
+                try:
+                    for chunk in stream_text(connector, _p, encoding=args.encoding):
+                        print(chunk, end="")
+                except (FileNotFoundError, ValueError) as e:
+                    print(f"\033[31m{e}\033[0m", file=sys.stderr)
+    
     else:
         raise NotImplementedError(f"Command {args.command} not implemented.")
     

lfss-0.12.2/lfss/cli/cli_lib.py

@@ -0,0 +1,64 @@
+
+from ..api.connector import Connector
+from ..eng.datatype import DirectoryRecord, FileRecord
+
+def mimetype_unicode(r: DirectoryRecord | FileRecord):
+    if isinstance(r, DirectoryRecord):
+        return "📁"
+    if r.mime_type in ["application/pdf", "application/x-pdf"]:
+        return "📕"
+    elif r.mime_type.startswith("image/"):
+        return "🖼️"
+    elif r.mime_type.startswith("video/"):
+        return "🎞️"
+    elif r.mime_type.startswith("audio/"):
+        return "🎵"
+    elif r.mime_type in ["application/zip", "application/x-tar", "application/gzip", "application/x-7z-compressed"]:
+        return "📦"
+    elif r.mime_type in ["application/vnd.ms-excel", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"]:
+        return "📊"
+    elif r.mime_type in ["application/x-msdownload", "application/x-executable", "application/x-mach-binary", "application/x-elf"]:
+        return "💻"
+    elif r.mime_type in ["application/vnd.ms-powerpoint", "application/vnd.openxmlformats-officedocument.presentationml.presentation"]:
+        return "📈"
+    elif r.mime_type in set([
+        "text/html", "application/xhtml+xml", "application/xml", "text/css", "text/x-scss", "application/javascript", "text/javascript",
+        "application/json", "text/x-yaml", "text/x-markdown", "application/wasm", 
+        "text/x-ruby", "application/x-ruby", "text/x-perl", "application/x-lisp", 
+        "text/x-haskell", "text/x-lua", "application/x-tcl", 
+        "text/x-python", "text/x-java-source", "text/x-go", "application/x-rust", "text/x-asm", 
+        "application/sql", "text/x-c", "text/x-c++", "text/x-csharp", 
+        "application/x-httpd-php", "application/x-sh", "application/x-shellscript", 
+        "application/x-latex", "application/x-tex", 
+    ]):
+        return "👨‍💻"
+    elif r.mime_type.startswith("text/"):
+        return "📃"
+    return "📄"
+
+def stream_text(
+    conn: Connector, 
+    path: str,
+    encoding="utf-8",
+    chunk_size=1024 * 8,
+    ):
+    """
+    Stream text content of a file from the server.
+    Raise FileNotFoundError if the file does not exist.
+    Raise ValueError if the file size exceeds MAX_TEXT_SIZE.
+    
+    Yields str chunks.
+    """
+    MAX_TEXT_SIZE = 100 * 1024 * 1024  # 100 MB
+    r = conn.get_fmeta(path)
+    if r is None:
+        raise FileNotFoundError(f"File not found: {path}")
+    if r.file_size > MAX_TEXT_SIZE:
+        raise ValueError(f"File size {r.file_size} exceeds maximum text size {MAX_TEXT_SIZE}")
+    ss = conn.get_stream(r.url, chunk_size=chunk_size)
+    total_read = 0
+    for chunk in ss:
+        total_read += len(chunk)
+        if total_read > MAX_TEXT_SIZE:
+            raise ValueError(f"File size exceeds maximum text size {MAX_TEXT_SIZE}")
+        yield chunk.decode(encoding, errors='replace')  # decode bytes to str, replace errors

{lfss-0.12.0 → lfss-0.12.2}/lfss/eng/utils.py

@@ -3,7 +3,6 @@ import urllib.parse
 import pathlib
 import functools
 import hashlib
-import aiofiles
 import asyncio
 from asyncio import Lock
 from collections import OrderedDict
@@ -11,6 +10,11 @@ from concurrent.futures import ThreadPoolExecutor
 from typing import TypeVar, Callable, Awaitable
 from functools import wraps, partial
 from uuid import uuid4
+try:
+    # optional dependency for client-side
+    import aiofiles     
+except ImportError:
+    pass
 
 async def copy_file(source: str|pathlib.Path, destination: str|pathlib.Path):
     async with aiofiles.open(source, mode='rb') as src:

{lfss-0.12.0 → lfss-0.12.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "lfss"
-version = "0.12.0"
+version = "0.12.2"
 description = "Lite file storage service"
 authors = ["Li, Mengxun <mengxunli@whu.edu.cn>"]
 readme = "Readme.md"
@@ -11,15 +11,16 @@ include = ["Readme.md", "docs/*", "frontend/*", "lfss/sql/*"]
 [tool.poetry.dependencies]
 python = ">=3.10"   # PEP-622
 requests = "2.*"
-aiosqlite = "0.*"
-aiofiles = "24.*"
-mimesniff = "1.*"
-fastapi = "0.*"
-uvicorn = "0.*"
-stream-zip = "0.*"
-python-multipart = "*"
-pillow = "*"
-rich = "*"
+aiosqlite = {"version" = "0.*", "optional" = true}
+aiofiles = {"version" = "24.*", "optional" = true}
+mimesniff = {"version" = "1.*", "optional" = true}
+stream-zip = {"version" = "0.*", "optional" = true}
+pillow = {"version" = "*", "optional" = true}
+rich = {"version" = "*", "optional" = true}
+fastapi = {"version" = "0.*", "optional" = true, "extras" = ["standard"]}
+
+[tool.poetry.extras]
+all = ["aiosqlite", "aiofiles", "mimesniff", "fastapi", "stream-zip", "pillow", "rich"]
 
 [tool.poetry.dev-dependencies]
 pytest = "*"