Compare commits
8 Commits
Author | SHA1 | Date | |
---|---|---|---|
49cb411af4
|
|||
3e8ab8de3a
|
|||
d392379235
|
|||
c8b16939d7
|
|||
0d8deb02d7
|
|||
c2a67aa861
|
|||
4696b9799c
|
|||
020ef8835a
|
@ -1,7 +1,14 @@
|
|||||||
{
|
{
|
||||||
"version": "0.2",
|
"version": "0.2",
|
||||||
"language": "en,en-gb",
|
"language": "en,en-gb",
|
||||||
"ignoreWords": ["followlinks", "getframe", "pycache", "pydantic", "UNLCK"],
|
"ignoreWords": [
|
||||||
|
"followlinks",
|
||||||
|
"getframe",
|
||||||
|
"pycache",
|
||||||
|
"pydantic",
|
||||||
|
"toolbelt",
|
||||||
|
"UNLCK"
|
||||||
|
],
|
||||||
"words": [
|
"words": [
|
||||||
"chacl",
|
"chacl",
|
||||||
"kikan",
|
"kikan",
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
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
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
@ -80,6 +80,7 @@ Upload the file or directory
|
|||||||
```shell
|
```shell
|
||||||
mdrs upload ./sample.dat neurodata:/NIU/Repository/TEST/
|
mdrs upload ./sample.dat neurodata:/NIU/Repository/TEST/
|
||||||
mdrs upload -r ./dataset neurodata:/NIU/Repository/TEST/
|
mdrs upload -r ./dataset neurodata:/NIU/Repository/TEST/
|
||||||
|
mdrs upload -r -s ./dataset neurodata:/NIU/Repository/TEST/
|
||||||
```
|
```
|
||||||
|
|
||||||
### download
|
### download
|
||||||
@ -115,8 +116,8 @@ mdrs cp -r neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST
|
|||||||
Remove the file or folder
|
Remove the file or folder
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
mdrs rm neurodata:/NIU/Repository/TEST2/sample2.dat
|
mdrs rm neurodata:/NIU/Repository/TEST/sample.dat
|
||||||
mdrs rm -r neurodata:/NIU/Repository/TEST2/dataset
|
mdrs rm -r neurodata:/NIU/Repository/TEST/dataset
|
||||||
```
|
```
|
||||||
|
|
||||||
### chacl
|
### chacl
|
||||||
@ -126,7 +127,7 @@ Change the folder access level
|
|||||||
```shell
|
```shell
|
||||||
mdrs chacl private neurodata:/NIU/Repository/Private
|
mdrs chacl private neurodata:/NIU/Repository/Private
|
||||||
mdrs chacl cbs_open -r neurodata:/NIU/Repository/CBS_Open
|
mdrs chacl cbs_open -r neurodata:/NIU/Repository/CBS_Open
|
||||||
mdrs chacl pw_open -r -p FOLDER_PASSWORD neurodata:/NIU/Repository/PW_Open
|
mdrs chacl pw_open -r -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open
|
||||||
```
|
```
|
||||||
|
|
||||||
### metadata
|
### metadata
|
||||||
|
@ -1 +1 @@
|
|||||||
1.3.1
|
1.3.6
|
||||||
|
@ -1,8 +1,10 @@
|
|||||||
|
import mimetypes
|
||||||
import os
|
import os
|
||||||
from typing import Any, Final
|
from typing import Any, Final
|
||||||
|
|
||||||
from pydantic import TypeAdapter
|
from pydantic import TypeAdapter
|
||||||
from pydantic.dataclasses import dataclass
|
from pydantic.dataclasses import dataclass
|
||||||
|
from requests_toolbelt.multipart.encoder import MultipartEncoder
|
||||||
|
|
||||||
from mdrsclient.api.base import BaseApi
|
from mdrsclient.api.base import BaseApi
|
||||||
from mdrsclient.api.utils import token_check
|
from mdrsclient.api.utils import token_check
|
||||||
@ -17,6 +19,7 @@ class FilesApiCreateResponse:
|
|||||||
|
|
||||||
class FilesApi(BaseApi):
|
class FilesApi(BaseApi):
|
||||||
ENTRYPOINT: Final[str] = "v3/files/"
|
ENTRYPOINT: Final[str] = "v3/files/"
|
||||||
|
FALLBACK_MIMETYPE: Final[str] = "application/octet-stream"
|
||||||
|
|
||||||
def retrieve(self, id: str) -> File:
|
def retrieve(self, id: str) -> File:
|
||||||
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
||||||
@ -30,30 +33,43 @@ class FilesApi(BaseApi):
|
|||||||
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
||||||
url = self.ENTRYPOINT
|
url = self.ENTRYPOINT
|
||||||
token_check(self.connection)
|
token_check(self.connection)
|
||||||
data: dict[str, str | int] = {"folder_id": folder_id}
|
data: dict[str, str | int] | MultipartEncoder = {}
|
||||||
try:
|
try:
|
||||||
with open(os.path.realpath(path), mode="rb") as fp:
|
with open(os.path.realpath(path), mode="rb") as fp:
|
||||||
response = self.connection.post(url, data=data, files={"file": 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)
|
self._raise_response_error(response)
|
||||||
ret = TypeAdapter(FilesApiCreateResponse).validate_python(response.json())
|
ret = TypeAdapter(FilesApiCreateResponse).validate_python(response.json())
|
||||||
except OSError:
|
except OSError:
|
||||||
raise UnexpectedException(f"Could not open `{path}` file.")
|
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
|
return ret.id
|
||||||
|
|
||||||
def update(self, file: File, path: str | None) -> bool:
|
def update(self, file: File, path: str | None) -> bool:
|
||||||
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
||||||
url = self.ENTRYPOINT + file.id + "/"
|
url = self.ENTRYPOINT + file.id + "/"
|
||||||
token_check(self.connection)
|
token_check(self.connection)
|
||||||
|
data: dict[str, str | int] | MultipartEncoder = {}
|
||||||
if path is not None:
|
if path is not None:
|
||||||
# update file body
|
# update file body
|
||||||
try:
|
try:
|
||||||
with open(os.path.realpath(path), mode="rb") as fp:
|
with open(os.path.realpath(path), mode="rb") as fp:
|
||||||
response = self.connection.put(url, files={"file": 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:
|
except OSError:
|
||||||
raise UnexpectedException(f"Could not open `{path}` file.")
|
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:
|
else:
|
||||||
# update metadata
|
# 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)
|
response = self.connection.put(url, data=data)
|
||||||
self._raise_response_error(response)
|
self._raise_response_error(response)
|
||||||
return True
|
return True
|
||||||
@ -95,6 +111,7 @@ class FilesApi(BaseApi):
|
|||||||
def download(self, file: File, path: str) -> bool:
|
def download(self, file: File, path: str) -> bool:
|
||||||
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
# print(self.__class__.__name__ + "::" + sys._getframe().f_code.co_name)
|
||||||
url = file.download_url
|
url = file.download_url
|
||||||
|
token_check(self.connection)
|
||||||
response = self.connection.get(url, stream=True)
|
response = self.connection.get(url, stream=True)
|
||||||
self._raise_response_error(response)
|
self._raise_response_error(response)
|
||||||
try:
|
try:
|
||||||
@ -106,3 +123,9 @@ class FilesApi(BaseApi):
|
|||||||
except PermissionError:
|
except PermissionError:
|
||||||
print(f"Cannot create file `{path}`: Permission denied.")
|
print(f"Cannot create file `{path}`: Permission denied.")
|
||||||
return True
|
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
|
||||||
|
@ -25,11 +25,11 @@ class ConfigCommand(BaseCommand):
|
|||||||
update_parser.add_argument("url", help="API entrypoint url of remote host")
|
update_parser.add_argument("url", help="API entrypoint url of remote host")
|
||||||
update_parser.set_defaults(func=cls.func_update)
|
update_parser.set_defaults(func=cls.func_update)
|
||||||
# config list
|
# 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.add_argument("-l", "--long", help="show the api url", action="store_true")
|
||||||
list_parser.set_defaults(func=cls.func_list)
|
list_parser.set_defaults(func=cls.func_list)
|
||||||
# config delete
|
# 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.add_argument("remote", help="label of remote host")
|
||||||
delete_parser.set_defaults(func=cls.func_delete)
|
delete_parser.set_defaults(func=cls.func_delete)
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@ from pydantic.dataclasses import dataclass
|
|||||||
from mdrsclient.api import FilesApi, FoldersApi
|
from mdrsclient.api import FilesApi, FoldersApi
|
||||||
from mdrsclient.commands.base import BaseCommand
|
from mdrsclient.commands.base import BaseCommand
|
||||||
from mdrsclient.connection import MDRSConnection
|
from mdrsclient.connection import MDRSConnection
|
||||||
from mdrsclient.exceptions import IllegalArgumentException
|
from mdrsclient.exceptions import IllegalArgumentException, UnexpectedException
|
||||||
from mdrsclient.models import File
|
from mdrsclient.models import File
|
||||||
from mdrsclient.settings import CONCURRENT
|
from mdrsclient.settings import CONCURRENT
|
||||||
|
|
||||||
@ -19,6 +19,12 @@ class DownloadFileInfo:
|
|||||||
path: str
|
path: str
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class DownloadContext:
|
||||||
|
hasError: bool
|
||||||
|
files: list[DownloadFileInfo]
|
||||||
|
|
||||||
|
|
||||||
class DownloadCommand(BaseCommand):
|
class DownloadCommand(BaseCommand):
|
||||||
@classmethod
|
@classmethod
|
||||||
def register(cls, parsers: Any) -> None:
|
def register(cls, parsers: Any) -> None:
|
||||||
@ -52,10 +58,11 @@ class DownloadCommand(BaseCommand):
|
|||||||
laboratory = cls._find_laboratory(connection, laboratory_name)
|
laboratory = cls._find_laboratory(connection, laboratory_name)
|
||||||
r_parent_folder = cls._find_folder(connection, laboratory, r_dirname, password)
|
r_parent_folder = cls._find_folder(connection, laboratory, r_dirname, password)
|
||||||
file = r_parent_folder.find_file(r_basename)
|
file = r_parent_folder.find_file(r_basename)
|
||||||
download_files: list[DownloadFileInfo] = []
|
|
||||||
if file is not None:
|
if file is not None:
|
||||||
|
context = DownloadContext(False, [])
|
||||||
l_path = os.path.join(l_dirname, r_basename)
|
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:
|
else:
|
||||||
folder = r_parent_folder.find_sub_folder(r_basename)
|
folder = r_parent_folder.find_sub_folder(r_basename)
|
||||||
if folder is None:
|
if folder is None:
|
||||||
@ -63,13 +70,13 @@ class DownloadCommand(BaseCommand):
|
|||||||
if not is_recursive:
|
if not is_recursive:
|
||||||
raise IllegalArgumentException(f"Cannot download `{r_path}`: Is a folder.")
|
raise IllegalArgumentException(f"Cannot download `{r_path}`: Is a folder.")
|
||||||
folder_api = FoldersApi(connection)
|
folder_api = FoldersApi(connection)
|
||||||
cls.__multiple_download_pickup_recursive_files(folder_api, download_files, folder.id, l_dirname)
|
cls.__multiple_download_pickup_recursive_files(connection, folder_api, folder.id, l_dirname)
|
||||||
cls.__multiple_download(connection, download_files)
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def __multiple_download_pickup_recursive_files(
|
def __multiple_download_pickup_recursive_files(
|
||||||
cls, folder_api: FoldersApi, infolist: list[DownloadFileInfo], folder_id: str, basedir: str
|
cls, connection: MDRSConnection, folder_api: FoldersApi, folder_id: str, basedir: str
|
||||||
) -> None:
|
) -> None:
|
||||||
|
context = DownloadContext(False, [])
|
||||||
folder = folder_api.retrieve(folder_id)
|
folder = folder_api.retrieve(folder_id)
|
||||||
dirname = os.path.join(basedir, folder.name)
|
dirname = os.path.join(basedir, folder.name)
|
||||||
if not os.path.exists(dirname):
|
if not os.path.exists(dirname):
|
||||||
@ -77,17 +84,27 @@ class DownloadCommand(BaseCommand):
|
|||||||
print(dirname)
|
print(dirname)
|
||||||
for file in folder.files:
|
for file in folder.files:
|
||||||
path = os.path.join(dirname, file.name)
|
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:
|
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, sub_folder.id, dirname)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def __multiple_download(cls, connection: MDRSConnection, infolist: list[DownloadFileInfo]) -> None:
|
def __multiple_download(cls, connection: MDRSConnection, context: DownloadContext) -> None:
|
||||||
file_api = FilesApi(connection)
|
file_api = FilesApi(connection)
|
||||||
with ThreadPoolExecutor(max_workers=CONCURRENT) as pool:
|
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.files)
|
||||||
|
hasError = next(filter(lambda x: x is False, results), None)
|
||||||
|
if hasError is not None:
|
||||||
|
context.hasError = True
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def __multiple_download_worker(cls, file_api: FilesApi, info: DownloadFileInfo) -> None:
|
def __multiple_download_worker(cls, file_api: FilesApi, info: DownloadFileInfo) -> bool:
|
||||||
|
try:
|
||||||
file_api.download(info.file, info.path)
|
file_api.download(info.file, info.path)
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
print(info.path)
|
print(info.path)
|
||||||
|
return True
|
||||||
|
@ -106,4 +106,4 @@ class UploadCommand(BaseCommand):
|
|||||||
file_api.update(file, info.path)
|
file_api.update(file, info.path)
|
||||||
print(os.path.join(info.folder.path, basename))
|
print(os.path.join(info.folder.path, basename))
|
||||||
except MDRSException as e:
|
except MDRSException as e:
|
||||||
print(f"API Error: {e}")
|
print(f"Error: {e}")
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
import platform
|
import platform
|
||||||
import threading
|
import threading
|
||||||
from io import BufferedReader
|
|
||||||
from typing import TypedDict
|
from typing import TypedDict
|
||||||
|
|
||||||
from requests import Response, Session
|
from requests import Response, Session
|
||||||
|
from requests_toolbelt.multipart.encoder import MultipartEncoder
|
||||||
|
|
||||||
# Unpack is new in 3.11
|
# Unpack is new in 3.11
|
||||||
from typing_extensions import Unpack
|
from typing_extensions import Unpack
|
||||||
@ -21,14 +21,14 @@ class _KwArgsMDRSConnectionGet(TypedDict, total=False):
|
|||||||
|
|
||||||
class _KwArgsMDRSConnectionPost(TypedDict, total=False):
|
class _KwArgsMDRSConnectionPost(TypedDict, total=False):
|
||||||
params: dict[str, str | int]
|
params: dict[str, str | int]
|
||||||
data: dict[str, str | int]
|
data: dict[str, str | int] | MultipartEncoder
|
||||||
files: dict[str, BufferedReader]
|
headers: dict[str, str]
|
||||||
|
|
||||||
|
|
||||||
class _KwArgsMDRSConnectionPut(TypedDict, total=False):
|
class _KwArgsMDRSConnectionPut(TypedDict, total=False):
|
||||||
params: dict[str, str | int]
|
params: dict[str, str | int]
|
||||||
data: dict[str, str | int]
|
data: dict[str, str | int] | MultipartEncoder
|
||||||
files: dict[str, BufferedReader]
|
headers: dict[str, str]
|
||||||
|
|
||||||
|
|
||||||
class _KwArgsMDRSConnectionDelete(TypedDict, total=False):
|
class _KwArgsMDRSConnectionDelete(TypedDict, total=False):
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "mdrs-client-python"
|
name = "mdrs-client-python"
|
||||||
version = "1.3.3"
|
version = "1.3.6"
|
||||||
description = "The mdrs-client-python is python library and a command-line client for up- and downloading files to and from MDRS based repository."
|
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>"]
|
authors = ["Yoshihiro OKUMURA <yoshihiro.okumura@riken.jp>"]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
@ -22,19 +22,20 @@ packages = [
|
|||||||
|
|
||||||
[tool.poetry.dependencies]
|
[tool.poetry.dependencies]
|
||||||
python = "^3.10"
|
python = "^3.10"
|
||||||
requests = "^2.31.0"
|
requests = "^2.32.3"
|
||||||
|
requests-toolbelt = "^1.0.0"
|
||||||
python-dotenv = "^1.0.1"
|
python-dotenv = "^1.0.1"
|
||||||
pydantic = "^2.6.1"
|
pydantic = "^2.8.2"
|
||||||
pydantic-settings = "^2.1.0"
|
pydantic-settings = "^2.3.4"
|
||||||
PyJWT = "^2.8.0"
|
PyJWT = "^2.8.0"
|
||||||
validators = "^0.22.0"
|
validators = "^0.22.0"
|
||||||
|
|
||||||
[tool.poetry.group.dev.dependencies]
|
[tool.poetry.group.dev.dependencies]
|
||||||
black = "^24.2.0"
|
black = "^24.2.2"
|
||||||
flake8 = "^7.0.0"
|
flake8 = "^7.1.0"
|
||||||
Flake8-pyproject = "^1.2.3"
|
Flake8-pyproject = "^1.2.3"
|
||||||
isort = "^5.13.2"
|
isort = "^5.13.2"
|
||||||
pyright = "^1.1.350"
|
pyright = "^1.1.370"
|
||||||
|
|
||||||
[tool.poetry.scripts]
|
[tool.poetry.scripts]
|
||||||
mdrs = 'mdrsclient.__main__:main'
|
mdrs = 'mdrsclient.__main__:main'
|
||||||
|
Reference in New Issue
Block a user