fix for file.list api pagination

.cspell.json

@@ -1,7 +1,14 @@
 {
   "version": "0.2",
   "language": "en,en-gb",
-  "ignoreWords": ["getframe", "pycache", "pydantic", "UNLCK"],
+  "ignoreWords": [
+    "followlinks",
+    "getframe",
+    "pycache",
+    "pydantic",
+    "toolbelt",
+    "UNLCK"
+  ],
   "words": [
     "chacl",
     "kikan",
@@ -9,7 +16,11 @@
     "mdrsclient",
     "neurodata",
     "Neuroinformatics",
+    "orcid",
     "RIKEN"
   ],
-  "ignorePaths": [".env", "__pycache__"]
+  "ignorePaths": [
+    ".env",
+    "__pycache__"
+  ]
 }

.gitignore

@@ -161,3 +161,4 @@ cython_debug/
 
 # mdrs-cli
 .neurodatacli.config
+poetry.toml

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Neuroinformatics Unit, RIKEN CBS
+Copyright (c) 2023- Neuroinformatics Unit, RIKEN CBS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,7 +4,7 @@ The mdrs-client-python is python library and a command-line client for up- and d
 
 ## Installing
 
-```
+```shell
 poetry install
 ```
 
@@ -14,141 +14,146 @@ poetry install
 
 Create remote host configuration
 
-```
-$ mdrs config create neurodata https://neurodata.riken.jp/api
+```shell
+mdrs config create neurodata https://neurodata.riken.jp/api
 ```
 
 ### login
 
 Login to remote host
 
-```
-$ mdrs login neurodata:
+```shell
+mdrs login neurodata:
 Username: (enter your login name)
 Password: (enter your password)
+
+mdrs login -u USERNAME -p PASSWORD neurodata:
 ```
 
 ### logout
 
 Logout from remote host
 
-```
-$ mdrs logout neurodata:
+```shell
+mdrs logout neurodata:
 ```
 
 ### whoami
 
 Print current user name
 
-```
-$ mdrs whoami neurodata:
+```shell
+mdrs whoami neurodata:
 ```
 
 ### labs
 
 List all laboratories
 
-```
-$ mdrs labs neurodata:
+```shell
+mdrs labs neurodata:
 ```
 
 ### ls
 
 List the folder contents
 
-```
-$ mdrs ls neurodata:/NIU/Repository/
-$ mdrs ls -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
-$ mdrs ls -r neurodata:/NIU/Repository/Dataset1/
-$ mdrs ls -J -r neurodata:/NIU/Repository/Dataset1/
+```shell
+mdrs ls neurodata:/NIU/Repository/
+mdrs ls -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open/
+mdrs ls -r neurodata:/NIU/Repository/Dataset1/
+mdrs ls -J -r neurodata:/NIU/Repository/Dataset1/
 ```
 
 ### mkdir
 
 Create a new folder
 
-```
-$ mdrs mkdir neurodata:/NIU/Repository/TEST
+```shell
+mdrs mkdir neurodata:/NIU/Repository/TEST
 ```
 
 ### upload
 
 Upload the file or directory
 
-```
-$ mdrs upload ./sample.dat neurodata:/NIU/Repository/TEST/
-$ mdrs upload -r ./dataset neurodata:/NIU/Repository/TEST/
+```shell
+mdrs upload ./sample.dat neurodata:/NIU/Repository/TEST/
+mdrs upload -r ./dataset neurodata:/NIU/Repository/TEST/
+mdrs upload -r --skip-if-exists ./dataset neurodata:/NIU/Repository/TEST/
 ```
 
 ### download
 
 Download the file or folder
 
-```
-$ mdrs download neurodata:/NIU/Repository/TEST/sample.dat ./
-$ mdrs download -r neurodata:/NIU/Repository/TEST/dataset/ ./
-$ mdrs download -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.dat ./
+```shell
+mdrs download neurodata:/NIU/Repository/TEST/sample.dat ./
+mdrs download -r neurodata:/NIU/Repository/TEST/dataset/ ./
+mdrs download -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.dat ./
+mdrs download -r --exclude /NIU/Repository/TEST/dataset/skip neurodata:/NIU/Repository/TEST/dataset/ ./
+mdrs download -r --skip-if-exists neurodata:/NIU/Repository/TEST/dataset/ ./
 ```
 
 ### mv
 
 Move or rename the file or folder
 
-```
-$ mdrs mv neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
-$ mdrs mv neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
+```shell
+mdrs mv neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
+mdrs mv neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
 ```
 
 ### cp
 
 Copy the file and folder
 
-```
-$ mdrs cp neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
-$ mdrs cp -r neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
+```shell
+mdrs cp neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
+mdrs cp -r neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
 ```
 
 ### rm
 
 Remove the file or folder
 
-```
-$ mdrs rm neurodata:/NIU/Repository/TEST2/sample2.dat
-$ mdrs rm -r neurodata:/NIU/Repository/TEST2/dataset
+```shell
+mdrs rm neurodata:/NIU/Repository/TEST/sample.dat
+mdrs rm -r neurodata:/NIU/Repository/TEST/dataset
 ```
 
 ### chacl
 
 Change the folder access level
 
-```
-$ mdrs chacl private neurodata:/NIU/Repository/Private
-$ mdrs chacl cbs_open -r neurodata:/NIU/Repository/CBS_Open
-$ mdrs chacl pw_open -r -p FOLDER_PASSWORD neurodata:/NIU/Repository/PW_Open
+```shell
+mdrs chacl private neurodata:/NIU/Repository/Private
+mdrs chacl cbs_open -r neurodata:/NIU/Repository/CBS_Open
+mdrs chacl pw_open -r -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open
 ```
 
 ### metadata
 
 Get a folder metadata
 
-```
-$ mdrs metadata neurodata:/NIU/Repository/TEST/
-$ mdrs metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
+```shell
+mdrs metadata neurodata:/NIU/Repository/TEST/
+mdrs metadata -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open/
 ```
 
 ### file-metadata
 
 Get the file metadata
 
-```
-$ mdrs file-metadata neurodata:/NIU/Repository/TEST/dataset/sample.dat
-$ mdrs file-metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.txt
+```shell
+mdrs file-metadata neurodata:/NIU/Repository/TEST/dataset/sample.dat
+mdrs file-metadata -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.txt
 ```
 
 ### help
 
 Show the help message and exit
 
-```
-$ mdrs -h
+```shell
+mdrs -h
 ```

mdrsclient/VERSION

@@ -1 +1 @@
-1.3.0
+1.3.12

mdrsclient/__main__.py

@@ -1,5 +1,6 @@
 import argparse
 import sys
+from json import JSONDecodeError
 
 from mdrsclient.commands import (
     ChaclCommand,
@@ -52,6 +53,9 @@ def main() -> None:
     except MDRSException as e:
         print(f"Error: {e}")
         sys.exit(2)
+    except JSONDecodeError:
+        print("Unexpected response returned. Please check the configuration or the server's operational status.")
+        sys.exit(2)
     except KeyboardInterrupt:
         sys.exit(130)
 

mdrsclient/api/files.py

@@ -1,8 +1,10 @@
+import mimetypes
 import os
 from typing import Any, Final
 
 from pydantic import TypeAdapter
 from pydantic.dataclasses import dataclass
+from requests_toolbelt.multipart.encoder import MultipartEncoder
 
 from mdrsclient.api.base import BaseApi
 from mdrsclient.api.utils import token_check
@@ -15,8 +17,25 @@ class FilesApiCreateResponse:
     id: str
 
 
+@dataclass(frozen=True)
+class FilesApiListResponse:
+    count: int
+    next: str | None
+    previous: str | None
+    results: list[File]
+
+
 class FilesApi(BaseApi):
     ENTRYPOINT: Final[str] = "v3/files/"
+    FALLBACK_MIMETYPE: Final[str] = "application/octet-stream"
+
+    def list(self, folder_id: str, page_num: int) -> FilesApiListResponse:
+        url = self.ENTRYPOINT
+        token_check(self.connection)
+        params: dict[str, str | int] = {"folder_id": folder_id, "page": page_num}
+        response = self.connection.get(url, params=params)
+        self._raise_response_error(response)
+        return TypeAdapter(FilesApiListResponse).validate_python(response.json())
 
     def retrieve(self, id: str) -> File:
         # print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
@@ -30,30 +49,43 @@ class FilesApi(BaseApi):
         # print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
         url = self.ENTRYPOINT
         token_check(self.connection)
-        data: dict[str, str | int] = {"folder_id": folder_id}
+        data: dict[str, str | int] | MultipartEncoder = {}
         try:
-            with open(os.path.relpath(path), mode="rb") as fp:
-                response = self.connection.post(url, data=data, files={"file": fp})
+            with open(os.path.realpath(path), mode="rb") as fp:
+                data = MultipartEncoder(
+                    fields={"folder_id": folder_id, "file": (os.path.basename(path), fp, self._get_mime_type(path))}
+                )
+                response = self.connection.post(url, data=data, headers={"Content-Type": data.content_type})
                 self._raise_response_error(response)
                 ret = TypeAdapter(FilesApiCreateResponse).validate_python(response.json())
         except OSError:
             raise UnexpectedException(f"Could not open `{path}` file.")
+        except MemoryError:
+            raise UnexpectedException("Out of memory.")
+        except Exception as e:
+            raise UnexpectedException("Unspecified error.") from e
         return ret.id
 
     def update(self, file: File, path: str | None) -> bool:
         # print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
         url = self.ENTRYPOINT + file.id + "/"
         token_check(self.connection)
+        data: dict[str, str | int] | MultipartEncoder = {}
         if path is not None:
             # update file body
             try:
-                with open(os.path.relpath(path), mode="rb") as fp:
-                    response = self.connection.put(url, files={"file": fp})
+                with open(os.path.realpath(path), mode="rb") as fp:
+                    data = MultipartEncoder(fields={"file": (os.path.basename(path), fp, self._get_mime_type(path))})
+                    response = self.connection.put(url, data=data, headers={"Content-Type": data.content_type})
             except OSError:
                 raise UnexpectedException(f"Could not open `{path}` file.")
+            except MemoryError:
+                raise UnexpectedException("Out of memory.")
+            except Exception as e:
+                raise UnexpectedException("Unspecified error.") from e
         else:
             # update metadata
-            data: dict[str, str | int] = {"name": file.name, "description": file.description}
+            data = {"name": file.name, "description": file.description}
             response = self.connection.put(url, data=data)
         self._raise_response_error(response)
         return True
@@ -95,6 +127,7 @@ class FilesApi(BaseApi):
     def download(self, file: File, path: str) -> bool:
         # print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
         url = file.download_url
+        token_check(self.connection)
         response = self.connection.get(url, stream=True)
         self._raise_response_error(response)
         try:
@@ -106,3 +139,9 @@ class FilesApi(BaseApi):
         except PermissionError:
             print(f"Cannot create file `{path}`: Permission denied.")
         return True
+
+    def _get_mime_type(self, path: str) -> str:
+        mt = mimetypes.guess_type(path)
+        if mt:
+            return mt[0] or self.FALLBACK_MIMETYPE
+        return self.FALLBACK_MIMETYPE

mdrsclient/api/users.py

@@ -20,8 +20,10 @@ class UsersCurrentResponseLaboratory:
 class UsersApiCurrentResponse:
     id: int
     username: str
-    full_name: str
+    first_name: str
+    last_name: str
     email: str
+    orcid_id: str
     laboratories: list[UsersCurrentResponseLaboratory]
     is_staff: bool
     is_active: bool

mdrsclient/commands/base.py

@@ -3,7 +3,7 @@ from abc import ABC, abstractmethod
 from typing import Any
 from unicodedata import normalize
 
-from mdrsclient.api import FoldersApi, LaboratoriesApi
+from mdrsclient.api import FilesApi, FoldersApi, LaboratoriesApi
 from mdrsclient.config import ConfigFile
 from mdrsclient.connection import MDRSConnection
 from mdrsclient.exceptions import (
@@ -12,7 +12,8 @@ from mdrsclient.exceptions import (
     UnauthorizedException,
     UnexpectedException,
 )
-from mdrsclient.models import Folder, Laboratory
+from mdrsclient.models import File, Folder, Laboratory
+from mdrsclient.utils import page_num_from_url
 
 
 class BaseCommand(ABC):
@@ -52,6 +53,19 @@ class BaseCommand(ABC):
             folder_api.auth(folders[0].id, password)
         return folder_api.retrieve(folders[0].id)
 
+    @classmethod
+    def _find_files(cls, connection: MDRSConnection, folder_id: str) -> list[File]:
+        files_api = FilesApi(connection)
+        page = 1
+        results_file = []
+        while page:
+            result = files_api.list(folder_id, page)
+            results_file.extend(result.results)
+            page = 0
+            if result.next:
+                page = page_num_from_url(result.next)
+        return results_file
+
     @classmethod
     def _parse_remote_host(cls, path: str) -> str:
         path_array = path.split(":")

mdrsclient/commands/config.py

@@ -25,11 +25,11 @@ class ConfigCommand(BaseCommand):
         update_parser.add_argument("url", help="API entrypoint url of remote host")
         update_parser.set_defaults(func=cls.func_update)
         # config list
-        list_parser = config_parsers.add_parser("list", help="list all the remote hosts")
+        list_parser = config_parsers.add_parser("list", help="list all the remote hosts", aliases=["ls"])
         list_parser.add_argument("-l", "--long", help="show the api url", action="store_true")
         list_parser.set_defaults(func=cls.func_list)
         # config delete
-        delete_parser = config_parsers.add_parser("delete", help="delete an existing remote host")
+        delete_parser = config_parsers.add_parser("delete", help="delete an existing remote host", aliases=["remove"])
         delete_parser.add_argument("remote", help="label of remote host")
         delete_parser.set_defaults(func=cls.func_delete)
 

mdrsclient/commands/cp.py

@@ -6,6 +6,7 @@ from unicodedata import normalize
 from mdrsclient.api import FilesApi, FoldersApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.exceptions import IllegalArgumentException
+from mdrsclient.models.file import find_file
 
 
 class CpCommand(BaseCommand):
@@ -46,11 +47,13 @@ class CpCommand(BaseCommand):
         connection = cls._create_connection(s_remote)
         laboratory = cls._find_laboratory(connection, s_laboratory_name)
         s_parent_folder = cls._find_folder(connection, laboratory, s_dirname)
+        s_parent_files = cls._find_files(connection, s_parent_folder.id)
         d_parent_folder = cls._find_folder(connection, laboratory, d_dirname)
-        s_file = s_parent_folder.find_file(s_basename)
+        d_parent_files = cls._find_files(connection, d_parent_folder.id)
+        s_file = find_file(s_parent_files, s_basename)
         if s_file is not None:
             # source is file
-            d_file = d_parent_folder.find_file(d_basename)
+            d_file = find_file(d_parent_files, d_basename)
             if d_file is not None:
                 raise IllegalArgumentException(f"File `{d_basename}` already exists.")
             d_sub_folder = d_parent_folder.find_sub_folder(d_basename)
@@ -66,7 +69,7 @@ class CpCommand(BaseCommand):
             # source is folder
             if not is_recursive:
                 raise IllegalArgumentException(f"Cannot copy `{s_path}`: Is a folder.")
-            if d_parent_folder.find_file(d_basename) is not None:
+            if find_file(d_parent_files, d_basename) is not None:
                 raise IllegalArgumentException(f"Cannot overwrite non-folder `{d_basename}` with folder `{s_path}`.")
             d_folder = d_parent_folder.find_sub_folder(d_basename)
             if d_folder is not None:

mdrsclient/commands/download.py

@@ -8,8 +8,9 @@ from pydantic.dataclasses import dataclass
 from mdrsclient.api import FilesApi, FoldersApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.connection import MDRSConnection
-from mdrsclient.exceptions import IllegalArgumentException
-from mdrsclient.models import File
+from mdrsclient.exceptions import IllegalArgumentException, UnexpectedException
+from mdrsclient.models import File, Folder, Laboratory
+from mdrsclient.models.file import find_file
 from mdrsclient.settings import CONCURRENT
 
 
@@ -19,6 +20,13 @@ class DownloadFileInfo:
     path: str
 
 
+@dataclass
+class DownloadContext:
+    hasError: bool
+    isSkipIfExists: bool
+    files: list[DownloadFileInfo]
+
+
 class DownloadCommand(BaseCommand):
     @classmethod
     def register(cls, parsers: Any) -> None:
@@ -26,6 +34,15 @@ class DownloadCommand(BaseCommand):
         download_parser.add_argument(
             "-r", "--recursive", help="download folders and their contents recursive", action="store_true"
         )
+        download_parser.add_argument(
+            "-s",
+            "--skip-if-exists",
+            help="skip the download if file is already downloaded and file size is the same",
+            action="store_true",
+        )
+        download_parser.add_argument(
+            "-e", "--exclude", help="exclude to download path matched file or folders", action="append"
+        )
         download_parser.add_argument("-p", "--password", help="password to use when open locked folder")
         download_parser.add_argument("remote_path", help="remote file path (remote:/lab/path/file)")
         download_parser.add_argument("local_path", help="local folder path (/foo/bar/)")
@@ -36,11 +53,21 @@ class DownloadCommand(BaseCommand):
         remote_path = str(args.remote_path)
         local_path = str(args.local_path)
         is_recursive = bool(args.recursive)
+        is_skip_if_exists = bool(args.skip_if_exists)
         password = str(args.password) if args.password else None
-        cls.download(remote_path, local_path, is_recursive, password)
+        excludes = list(map(lambda x: str(x).rstrip("/").lower(), args.exclude)) if args.exclude is not None else []
+        cls.download(remote_path, local_path, is_recursive, is_skip_if_exists, password, excludes)
 
     @classmethod
-    def download(cls, remote_path: str, local_path: str, is_recursive: bool, password: str | None) -> None:
+    def download(
+        cls,
+        remote_path: str,
+        local_path: str,
+        is_recursive: bool,
+        is_skip_if_exists: bool,
+        password: str | None,
+        excludes: list[str],
+    ) -> None:
         (remote, laboratory_name, r_path) = cls._parse_remote_host_with_path(remote_path)
         r_path = r_path.rstrip("/")
         r_dirname = os.path.dirname(r_path)
@@ -51,11 +78,15 @@ class DownloadCommand(BaseCommand):
             raise IllegalArgumentException(f"Local directory `{local_path}` not found.")
         laboratory = cls._find_laboratory(connection, laboratory_name)
         r_parent_folder = cls._find_folder(connection, laboratory, r_dirname, password)
-        file = r_parent_folder.find_file(r_basename)
-        download_files: list[DownloadFileInfo] = []
+        r_parent_files = cls._find_files(connection, r_parent_folder.id)
+        file = find_file(r_parent_files, r_basename)
         if file is not None:
+            if cls.__check_excludes(excludes, laboratory, r_parent_folder, file):
+                return
+            context = DownloadContext(False, is_skip_if_exists, [])
             l_path = os.path.join(l_dirname, r_basename)
-            download_files.append(DownloadFileInfo(file, l_path))
+            context.files.append(DownloadFileInfo(file, l_path))
+            cls.__multiple_download(connection, context)
         else:
             folder = r_parent_folder.find_sub_folder(r_basename)
             if folder is None:
@@ -63,31 +94,68 @@ class DownloadCommand(BaseCommand):
             if not is_recursive:
                 raise IllegalArgumentException(f"Cannot download `{r_path}`: Is a folder.")
             folder_api = FoldersApi(connection)
-            cls.__multiple_download_pickup_recursive_files(folder_api, download_files, folder.id, l_dirname)
-        cls.__multiple_download(connection, download_files)
+            cls.__multiple_download_pickup_recursive_files(
+                connection, folder_api, laboratory, folder.id, l_dirname, excludes, is_skip_if_exists
+            )
 
     @classmethod
     def __multiple_download_pickup_recursive_files(
-        cls, folder_api: FoldersApi, infolist: list[DownloadFileInfo], folder_id: str, basedir: str
+        cls,
+        connection: MDRSConnection,
+        folder_api: FoldersApi,
+        laboratory: Laboratory,
+        folder_id: str,
+        basedir: str,
+        excludes: list[str],
+        is_skip_if_exists: bool,
     ) -> None:
+        context = DownloadContext(False, is_skip_if_exists, [])
         folder = folder_api.retrieve(folder_id)
+        files = cls._find_files(connection, folder.id)
         dirname = os.path.join(basedir, folder.name)
+        if cls.__check_excludes(excludes, laboratory, folder, None):
+            return
         if not os.path.exists(dirname):
             os.makedirs(dirname)
         print(dirname)
-        for file in folder.files:
+        for file in files:
+            if cls.__check_excludes(excludes, laboratory, folder, file):
+                continue
             path = os.path.join(dirname, file.name)
-            infolist.append(DownloadFileInfo(file, path))
+            context.files.append(DownloadFileInfo(file, path))
+        cls.__multiple_download(connection, context)
+        if context.hasError:
+            raise UnexpectedException("Some files failed to download.")
         for sub_folder in folder.sub_folders:
-            cls.__multiple_download_pickup_recursive_files(folder_api, infolist, sub_folder.id, dirname)
+            cls.__multiple_download_pickup_recursive_files(
+                connection, folder_api, laboratory, sub_folder.id, dirname, excludes, is_skip_if_exists
+            )
 
     @classmethod
-    def __multiple_download(cls, connection: MDRSConnection, infolist: list[DownloadFileInfo]) -> None:
+    def __multiple_download(cls, connection: MDRSConnection, context: DownloadContext) -> None:
         file_api = FilesApi(connection)
         with ThreadPoolExecutor(max_workers=CONCURRENT) as pool:
-            pool.map(lambda x: cls.__multiple_download_worker(file_api, x), infolist)
+            results = pool.map(
+                lambda x: cls.__multiple_download_worker(file_api, x, context.isSkipIfExists), context.files
+            )
+            hasError = next(filter(lambda x: x is False, results), None)
+            if hasError is not None:
+                context.hasError = True
 
     @classmethod
-    def __multiple_download_worker(cls, file_api: FilesApi, info: DownloadFileInfo) -> None:
+    def __multiple_download_worker(cls, file_api: FilesApi, info: DownloadFileInfo, is_skip_if_exists: bool) -> bool:
+        if not is_skip_if_exists or not os.path.exists(info.path) or info.file.size != os.path.getsize(info.path):
+            try:
                 file_api.download(info.file, info.path)
+            except Exception:
+                print(f"Failed: ${info.path}")
+                if os.path.isfile(info.path):
+                    os.remove(info.path)
+                return False
         print(info.path)
+        return True
+
+    @classmethod
+    def __check_excludes(cls, excludes: list[str], laboratory: Laboratory, folder: Folder, file: File | None) -> bool:
+        path = f"/{laboratory.name}{folder.path}{file.name if file is not None else ''}".rstrip("/").lower()
+        return path in excludes

mdrsclient/commands/file_metadata.py

@@ -6,6 +6,7 @@ from typing import Any
 from mdrsclient.api import FilesApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.exceptions import IllegalArgumentException
+from mdrsclient.models.file import find_file
 
 
 class FileMetadataCommand(BaseCommand):
@@ -31,7 +32,8 @@ class FileMetadataCommand(BaseCommand):
         connection = cls._create_connection(remote)
         laboratory = cls._find_laboratory(connection, laboratory_name)
         folder = cls._find_folder(connection, laboratory, r_dirname, password)
-        file = folder.find_file(r_basename)
+        files = cls._find_files(connection, folder.id)
+        file = find_file(files, r_basename)
         if file is None:
             raise IllegalArgumentException(f"File `{r_basename}` not found.")
         file_api = FilesApi(connection)

mdrsclient/commands/login.py

@@ -13,14 +13,16 @@ class LoginCommand(BaseCommand):
     @classmethod
     def register(cls, parsers: Any) -> None:
         login_parser = parsers.add_parser("login", help="login to remote host")
+        login_parser.add_argument("-u", "--username", help="login username")
+        login_parser.add_argument("-p", "--password", help="login password")
         login_parser.add_argument("remote", help="label of remote host")
         login_parser.set_defaults(func=cls.func)
 
     @classmethod
     def func(cls, args: Namespace) -> None:
         remote = str(args.remote)
-        username = input("Username: ").strip()
-        password = getpass.getpass("Password: ").strip()
+        username = str(args.username) if args.password else input("Username: ").strip()
+        password = str(args.password) if args.password else getpass.getpass("Password: ").strip()
         cls.login(remote, username, password)
 
     @classmethod

mdrsclient/commands/ls.py

@@ -4,7 +4,7 @@ from typing import Any
 
 from pydantic.dataclasses import dataclass
 
-from mdrsclient.api import FoldersApi
+from mdrsclient.api import FilesApi, FoldersApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.connection import MDRSConnection
 from mdrsclient.exceptions import UnauthorizedException
@@ -67,17 +67,18 @@ class LsCommand(BaseCommand):
             is_recursive,
         )
         folder = cls._find_folder(connection, laboratory, r_path, password)
+        files = cls._find_files(connection, folder.id)
         if context.is_json:
-            cls._ls_json(context, folder)
+            cls._ls_json(context, folder, files)
         else:
-            cls._ls_plain(context, folder)
+            cls._ls_plain(context, folder, files)
 
     @classmethod
-    def _ls_json(cls, context: LsCommandContext, folder: Folder) -> None:
-        print(json.dumps(cls._folder2dict(context, folder), ensure_ascii=False))
+    def _ls_json(cls, context: LsCommandContext, folder: Folder, files: list[File]) -> None:
+        print(json.dumps(cls._folder2dict(context, folder, files), ensure_ascii=False))
 
     @classmethod
-    def _ls_plain(cls, context: LsCommandContext, folder: Folder) -> None:
+    def _ls_plain(cls, context: LsCommandContext, folder: Folder, files: list[File]) -> None:
         label = {
             "type": "Type",
             "acl": "Access",
@@ -97,7 +98,7 @@ class LsCommand(BaseCommand):
             length["size"] = max(length["size"], len(str(folder.size)))
             length["date"] = max(length["date"], len(sub_folder.updated_at_name))
             length["name"] = max(length["name"], len(sub_folder.name))
-        for file in folder.files:
+        for file in files:
             length["size"] = max(length["size"], len(str(file.size)))
             length["date"] = max(length["date"], len(file.updated_at_name))
             length["name"] = max(length["name"], len(file.name))
@@ -111,7 +112,7 @@ class LsCommand(BaseCommand):
 
         if context.is_recursive:
             print(f"{context.prefix}{folder.path}:")
-            print(f"total {sum(f.size for f in folder.files)}")
+            print(f"total {sum(f.size for f in files)}")
 
         if not context.is_quick:
             print(header)
@@ -125,7 +126,7 @@ class LsCommand(BaseCommand):
                 f"{sub_laboratory_name:{length['laboratory']}}\t{sub_folder.size:{length['size']}}\t"
                 f"{sub_folder.updated_at_name:{length['date']}}\t{sub_folder.name:{length['name']}}"
             )
-        for file in sorted(folder.files, key=lambda x: x.name):
+        for file in sorted(files, key=lambda x: x.name):
             print(
                 f"{'[f]':{length['type']}}\t{folder.access_level_name:{length['acl']}}\t"
                 f"{context.laboratory.name:{length['laboratory']}}\t{file.size:{length['size']}}\t"
@@ -140,12 +141,15 @@ class LsCommand(BaseCommand):
                     if sub_folder.lock:
                         folder_api.auth(sub_folder.id, context.password)
                     folder = folder_api.retrieve(sub_folder.id)
-                    cls._ls_plain(context, folder)
+                    files = cls._find_files(context.connection, sub_folder.id)
+                    cls._ls_plain(context, folder, files)
                 except UnauthorizedException:
                     pass
 
     @classmethod
-    def _folder2dict(cls, context: LsCommandContext, folder: Folder | FolderSimple) -> dict[str, Any]:
+    def _folder2dict(
+        cls, context: LsCommandContext, folder: Folder | FolderSimple, files: list[File]
+    ) -> dict[str, Any]:
         data: dict[str, Any] = {
             "id": folder.id,
             "pid": folder.pid,
@@ -168,15 +172,16 @@ class LsCommand(BaseCommand):
                         if sub_folder.lock:
                             folder_api.auth(sub_folder.id, context.password)
                         folder2 = folder_api.retrieve(sub_folder.id)
-                        sub_folders.append(cls._folder2dict(context, folder2))
+                        files2 = cls._find_files(context.connection, sub_folder.id)
+                        sub_folders.append(cls._folder2dict(context, folder2, files2))
                     except UnauthorizedException:
                         pass
                 data["sub_folders"] = sub_folders
             else:
                 data["sub_folders"] = list(
-                    map(lambda x: cls._folder2dict(context, x), sorted(folder.sub_folders, key=lambda x: x.name))
+                    map(lambda x: cls._folder2dict(context, x, []), sorted(folder.sub_folders, key=lambda x: x.name))
                 )
-            data["files"] = list(map(lambda x: cls._file2dict(context, x), sorted(folder.files, key=lambda x: x.name)))
+            data["files"] = list(map(lambda x: cls._file2dict(context, x), sorted(files, key=lambda x: x.name)))
         return data
 
     @classmethod

mdrsclient/commands/mkdir.py

@@ -6,6 +6,7 @@ from unicodedata import normalize
 from mdrsclient.api import FoldersApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.exceptions import IllegalArgumentException
+from mdrsclient.models.file import find_file
 
 
 class MkdirCommand(BaseCommand):
@@ -29,7 +30,8 @@ class MkdirCommand(BaseCommand):
         connection = cls._create_connection(remote)
         laboratory = cls._find_laboratory(connection, laboratory_name)
         parent_folder = cls._find_folder(connection, laboratory, r_dirname)
-        if parent_folder.find_sub_folder(r_basename) is not None or parent_folder.find_file(r_basename) is not None:
+        files = cls._find_files(connection, parent_folder.id)
+        if parent_folder.find_sub_folder(r_basename) is not None or find_file(files, r_basename) is not None:
             raise IllegalArgumentException(f"Cannot create folder `{r_path}`: File exists.")
         folder_api = FoldersApi(connection)
         folder_api.create(normalize("NFC", r_basename), parent_folder.id)

mdrsclient/commands/mv.py

@@ -6,6 +6,7 @@ from unicodedata import normalize
 from mdrsclient.api import FilesApi, FoldersApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.exceptions import IllegalArgumentException
+from mdrsclient.models.file import find_file
 
 
 class MvCommand(BaseCommand):
@@ -42,11 +43,13 @@ class MvCommand(BaseCommand):
         connection = cls._create_connection(s_remote)
         laboratory = cls._find_laboratory(connection, s_laboratory_name)
         s_parent_folder = cls._find_folder(connection, laboratory, s_dirname)
+        s_parent_files = cls._find_files(connection, s_parent_folder.id)
         d_parent_folder = cls._find_folder(connection, laboratory, d_dirname)
-        s_file = s_parent_folder.find_file(s_basename)
+        d_parent_files = cls._find_files(connection, d_parent_folder.id)
+        s_file = find_file(s_parent_files, s_basename)
         if s_file is not None:
             # source is file
-            d_file = d_parent_folder.find_file(d_basename)
+            d_file = find_file(d_parent_files, d_basename)
             if d_file is not None:
                 raise IllegalArgumentException(f"File `{d_basename}` already exists.")
             d_sub_folder = d_parent_folder.find_sub_folder(d_basename)
@@ -60,7 +63,7 @@ class MvCommand(BaseCommand):
             if s_folder is None:
                 raise IllegalArgumentException(f"File or folder `{s_basename}` not found.")
             # source is folder
-            if d_parent_folder.find_file(d_basename) is not None:
+            if find_file(d_parent_files, d_basename) is not None:
                 raise IllegalArgumentException(f"Cannot overwrite non-folder `{d_basename}` with folder `{s_path}`.")
             d_folder = d_parent_folder.find_sub_folder(d_basename)
             if d_folder is not None:

mdrsclient/commands/rm.py

@@ -5,6 +5,7 @@ from typing import Any
 from mdrsclient.api import FilesApi, FoldersApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.exceptions import IllegalArgumentException
+from mdrsclient.models.file import find_file
 
 
 class RmCommand(BaseCommand):
@@ -32,7 +33,8 @@ class RmCommand(BaseCommand):
         connection = cls._create_connection(remote)
         laboratory = cls._find_laboratory(connection, laboratory_name)
         parent_folder = cls._find_folder(connection, laboratory, r_dirname)
-        file = parent_folder.find_file(r_basename)
+        parent_files = cls._find_files(connection, parent_folder.id)
+        file = find_file(parent_files, r_basename)
         if file is not None:
             file_api = FilesApi(connection)
             file_api.destroy(file)

mdrsclient/commands/upload.py

@@ -9,13 +9,15 @@ from mdrsclient.api import FilesApi, FoldersApi
 from mdrsclient.commands.base import BaseCommand
 from mdrsclient.connection import MDRSConnection
 from mdrsclient.exceptions import IllegalArgumentException, MDRSException
-from mdrsclient.models import Folder
+from mdrsclient.models import File, Folder
+from mdrsclient.models.file import find_file
 from mdrsclient.settings import CONCURRENT
 
 
 @dataclass(frozen=True)
 class UploadFileInfo:
     folder: Folder
+    files: list[File]
     path: str
 
 
@@ -26,6 +28,12 @@ class UploadCommand(BaseCommand):
         upload_parser.add_argument(
             "-r", "--recursive", help="upload directories and their contents recursive", action="store_true"
         )
+        upload_parser.add_argument(
+            "-s",
+            "--skip-if-exists",
+            help="skip the upload if file is already uploaded and file size is the same",
+            action="store_true",
+        )
         upload_parser.add_argument("local_path", help="local file path (/foo/bar/data.txt)")
         upload_parser.add_argument("remote_path", help="remote folder path (remote:/lab/path/)")
         upload_parser.set_defaults(func=cls.func)
@@ -35,17 +43,19 @@ class UploadCommand(BaseCommand):
         local_path = str(args.local_path)
         remote_path = str(args.remote_path)
         is_recursive = bool(args.recursive)
-        cls.upload(local_path, remote_path, is_recursive)
+        is_skip_if_exists = bool(args.skip_if_exists)
+        cls.upload(local_path, remote_path, is_recursive, is_skip_if_exists)
 
     @classmethod
-    def upload(cls, local_path: str, remote_path: str, is_recursive: bool) -> None:
+    def upload(cls, local_path: str, remote_path: str, is_recursive: bool, is_skip_if_exists: bool) -> None:
         (remote, laboratory_name, r_path) = cls._parse_remote_host_with_path(remote_path)
-        l_path = local_path
+        l_path = os.path.abspath(local_path)
         if not os.path.exists(l_path):
             raise IllegalArgumentException(f"File or directory `{local_path}` not found.")
         connection = cls._create_connection(remote)
         laboratory = cls._find_laboratory(connection, laboratory_name)
         folder = cls._find_folder(connection, laboratory, r_path)
+        files = cls._find_files(connection, folder.id)
         infos: list[UploadFileInfo] = []
         if os.path.isdir(l_path):
             if not is_recursive:
@@ -53,14 +63,20 @@ class UploadCommand(BaseCommand):
             folder_api = FoldersApi(connection)
             folder_map: dict[str, Folder] = {}
             folder_map[r_path] = folder
+            files_map: dict[str, list[File]] = {}
+            files_map[r_path] = files
             l_basename = os.path.basename(l_path)
-            for dirpath, _, filenames in os.walk(l_path):
-                d_dirname = os.path.join(r_path, l_basename)
+            for dirpath, _, filenames in os.walk(l_path, followlinks=True):
+                sub = l_basename if dirpath == l_path else os.path.join(l_basename, os.path.relpath(dirpath, l_path))
+                d_dirname = os.path.join(r_path, sub)
                 d_basename = os.path.basename(d_dirname)
                 # prepare destination parent path
                 d_parent_dirname = os.path.dirname(d_dirname)
                 if folder_map.get(d_parent_dirname) is None:
-                    folder_map[d_parent_dirname] = cls._find_folder(connection, laboratory, d_parent_dirname)
+                    parent_folder = cls._find_folder(connection, laboratory, d_parent_dirname)
+                    folder_map[d_parent_dirname] = parent_folder
+                    parent_files = cls._find_files(connection, parent_folder.id)
+                    files_map[d_parent_dirname] = parent_files
                 # prepare destination path
                 if folder_map.get(d_dirname) is None:
                     d_folder = folder_map[d_parent_dirname].find_sub_folder(d_basename)
@@ -70,30 +86,35 @@ class UploadCommand(BaseCommand):
                         d_folder_id = d_folder.id
                     print(d_dirname)
                     folder_map[d_dirname] = folder_api.retrieve(d_folder_id)
+                    files_map[d_dirname] = cls._find_files(connection, d_folder_id)
                     if d_folder is None:
                         folder_map[d_parent_dirname].sub_folders.append(folder_map[d_dirname])
                 # register upload file list
                 for filename in filenames:
-                    infos.append(UploadFileInfo(folder_map[d_dirname], os.path.join(dirpath, filename)))
+                    infos.append(
+                        UploadFileInfo(folder_map[d_dirname], files_map[d_dirname], os.path.join(dirpath, filename))
+                    )
         else:
-            infos.append(UploadFileInfo(folder, l_path))
-        cls.__multiple_upload(connection, infos)
+            infos.append(UploadFileInfo(folder, files, l_path))
+        cls.__multiple_upload(connection, infos, is_skip_if_exists)
 
     @classmethod
-    def __multiple_upload(cls, connection: MDRSConnection, infos: list[UploadFileInfo]) -> None:
+    def __multiple_upload(
+        cls, connection: MDRSConnection, infos: list[UploadFileInfo], is_skip_if_exists: bool
+    ) -> None:
         file_api = FilesApi(connection)
         with ThreadPoolExecutor(max_workers=CONCURRENT) as pool:
-            pool.map(lambda x: cls.__multiple_upload_worker(file_api, x), infos)
+            pool.map(lambda x: cls.__multiple_upload_worker(file_api, x, is_skip_if_exists), infos)
 
     @classmethod
-    def __multiple_upload_worker(cls, file_api: FilesApi, info: UploadFileInfo) -> None:
+    def __multiple_upload_worker(cls, file_api: FilesApi, info: UploadFileInfo, is_skip_if_exists: bool) -> None:
         basename = os.path.basename(info.path)
-        file = info.folder.find_file(basename)
+        file = find_file(info.files, basename)
         try:
             if file is None:
                 file_api.create(info.folder.id, info.path)
-            else:
+            elif not is_skip_if_exists or file.size != os.path.getsize(info.path):
                 file_api.update(file, info.path)
             print(os.path.join(info.folder.path, basename))
         except MDRSException as e:
-            print(f"API Error: {e}")
+            print(f"Error: {e}")

mdrsclient/config.py

@@ -2,7 +2,7 @@ import configparser
 import os
 from typing import Final
 
-import validators  # type: ignore
+import validators
 
 from mdrsclient.exceptions import IllegalArgumentException
 from mdrsclient.settings import CONFIG_DIRNAME
@@ -41,7 +41,7 @@ class ConfigFile:
 
     @url.setter
     def url(self, url: str) -> None:
-        if not validators.url(url):  # type: ignore
+        if not validators.url(url):
             raise IllegalArgumentException("malformed URI sequence")
         self.__load()
         if self.__config.has_section(self.remote):

mdrsclient/connection.py

@@ -1,9 +1,9 @@
 import platform
 import threading
-from io import BufferedReader
 from typing import TypedDict
 
 from requests import Response, Session
+from requests_toolbelt.multipart.encoder import MultipartEncoder
 
 # Unpack is new in 3.11
 from typing_extensions import Unpack
@@ -21,14 +21,14 @@ class _KwArgsMDRSConnectionGet(TypedDict, total=False):
 
 class _KwArgsMDRSConnectionPost(TypedDict, total=False):
     params: dict[str, str | int]
-    data: dict[str, str | int]
-    files: dict[str, BufferedReader]
+    data: dict[str, str | int] | MultipartEncoder
+    headers: dict[str, str]
 
 
 class _KwArgsMDRSConnectionPut(TypedDict, total=False):
     params: dict[str, str | int]
-    data: dict[str, str | int]
-    files: dict[str, BufferedReader]
+    data: dict[str, str | int] | MultipartEncoder
+    headers: dict[str, str]
 
 
 class _KwArgsMDRSConnectionDelete(TypedDict, total=False):

mdrsclient/models/file.py

@@ -1,4 +1,5 @@
 from typing import Any
+from unicodedata import normalize
 
 from pydantic.dataclasses import dataclass
 
@@ -25,3 +26,8 @@ class File:
     @property
     def updated_at_name(self) -> str:
         return iso8601_to_user_friendly(self.updated_at)
+
+
+def find_file(files: list[File], name: str) -> File | None:
+    _name = normalize("NFC", name).lower()
+    return next((x for x in files if x.name.lower() == _name), None)

mdrsclient/models/folder.py

@@ -3,7 +3,6 @@ from unicodedata import normalize
 
 from pydantic.dataclasses import dataclass
 
-from mdrsclient.models.file import File
 from mdrsclient.models.utils import iso8601_to_user_friendly
 
 
@@ -78,13 +77,8 @@ class FolderSimple:
 class Folder(FolderSimple):
     metadata: list[dict[str, Any]]
     sub_folders: list[FolderSimple]
-    files: list[File]
     path: str
 
     def find_sub_folder(self, name: str) -> FolderSimple | None:
         _name = normalize("NFC", name).lower()
         return next((x for x in self.sub_folders if x.name.lower() == _name), None)
-
-    def find_file(self, name: str) -> File | None:
-        _name = normalize("NFC", name).lower()
-        return next((x for x in self.files if x.name.lower() == _name), None)

mdrsclient/utils.py

@@ -1,5 +1,6 @@
 import os
 from typing import IO, Any
+from urllib.parse import parse_qs, urlparse
 
 if os.name == "nt":
     import msvcrt
@@ -21,3 +22,10 @@ class FileLock:
             msvcrt.locking(file.fileno(), msvcrt.LK_UNLCK, 1)
         elif os.name == "posix":
             fcntl.flock(file.fileno(), fcntl.LOCK_UN)
+
+
+def page_num_from_url(url: str) -> int | None:
+    parsed_url = urlparse(url)
+    params = parse_qs(parsed_url.query)
+    page = params.get("page", [None])[0]
+    return int(page) if page is not None else None

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mdrs-client-python"
-version = "1.3.0"
+version = "1.3.12"
 description = "The mdrs-client-python is python library and a command-line client for up- and downloading files to and from MDRS based repository."
 authors = ["Yoshihiro OKUMURA <yoshihiro.okumura@riken.jp>"]
 license = "MIT"
@@ -13,6 +13,7 @@ classifiers=[
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "OSI Approved :: MIT License",
     "Topic :: Utilities",
 ]
@@ -22,19 +23,20 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.10"
-requests = "^2.31.0"
-python-dotenv = "^1.0.0"
-pydantic = "^2.5.2"
-pydantic-settings = "^2.1.0"
-PyJWT = "^2.8.0"
-validators = "^0.22.0"
+requests = "^2.32.3"
+requests-toolbelt = "^1.0.0"
+python-dotenv = "^1.1.0"
+pydantic = "^2.11.4"
+pydantic-settings = "^2.9.1"
+PyJWT = "^2.10.1"
+validators = "^0.34.0"
 
 [tool.poetry.group.dev.dependencies]
-black = "^23.12.0"
-flake8 = "^6.1.0"
+black = "^24.10.0"
+flake8 = "^7.2.0"
 Flake8-pyproject = "^1.2.3"
-isort = "^5.13.0"
-pyright = "^1.1.339"
+isort = "^5.13.2"
+pyright = "^1.1.400"
 
 [tool.poetry.scripts]
 mdrs = 'mdrsclient.__main__:main'