Compare commits
9 Commits
Author | SHA1 | Date | |
---|---|---|---|
7b3f1f2d09 | |||
8a5e1b68b7 | |||
dd00973bea | |||
0e5685d5ea | |||
6a2810f603 | |||
d5ac5cd427 | |||
ab7cd1b885 | |||
f2f898c263 | |||
24172dc65c |
@ -16,7 +16,11 @@
|
|||||||
"mdrsclient",
|
"mdrsclient",
|
||||||
"neurodata",
|
"neurodata",
|
||||||
"Neuroinformatics",
|
"Neuroinformatics",
|
||||||
|
"orcid",
|
||||||
"RIKEN"
|
"RIKEN"
|
||||||
],
|
],
|
||||||
"ignorePaths": [".env", "__pycache__"]
|
"ignorePaths": [
|
||||||
|
".env",
|
||||||
|
"__pycache__"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -160,4 +160,5 @@ cython_debug/
|
|||||||
.idea/
|
.idea/
|
||||||
|
|
||||||
# mdrs-cli
|
# mdrs-cli
|
||||||
.neurodatacli.config
|
.neurodatacli.config
|
||||||
|
poetry.toml
|
15
README.md
15
README.md
@ -60,7 +60,7 @@ List the folder contents
|
|||||||
|
|
||||||
```shell
|
```shell
|
||||||
mdrs ls neurodata:/NIU/Repository/
|
mdrs ls neurodata:/NIU/Repository/
|
||||||
mdrs ls -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
mdrs ls -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
||||||
mdrs ls -r neurodata:/NIU/Repository/Dataset1/
|
mdrs ls -r neurodata:/NIU/Repository/Dataset1/
|
||||||
mdrs ls -J -r neurodata:/NIU/Repository/Dataset1/
|
mdrs ls -J -r neurodata:/NIU/Repository/Dataset1/
|
||||||
```
|
```
|
||||||
@ -80,7 +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/
|
mdrs upload -r --skip-if-exists ./dataset neurodata:/NIU/Repository/TEST/
|
||||||
```
|
```
|
||||||
|
|
||||||
### download
|
### download
|
||||||
@ -90,8 +90,9 @@ Download the file or folder
|
|||||||
```shell
|
```shell
|
||||||
mdrs download neurodata:/NIU/Repository/TEST/sample.dat ./
|
mdrs download neurodata:/NIU/Repository/TEST/sample.dat ./
|
||||||
mdrs download -r neurodata:/NIU/Repository/TEST/dataset/ ./
|
mdrs download -r neurodata:/NIU/Repository/TEST/dataset/ ./
|
||||||
mdrs download -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.dat ./
|
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 --exclude /NIU/Repository/TEST/dataset/skip neurodata:/NIU/Repository/TEST/dataset/ ./
|
||||||
|
mdrs download -r --skip-if-exists neurodata:/NIU/Repository/TEST/dataset/ ./
|
||||||
```
|
```
|
||||||
|
|
||||||
### mv
|
### mv
|
||||||
@ -128,7 +129,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 PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open
|
mdrs chacl pw_open -r -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open
|
||||||
```
|
```
|
||||||
|
|
||||||
### metadata
|
### metadata
|
||||||
@ -137,7 +138,7 @@ Get a folder metadata
|
|||||||
|
|
||||||
```shell
|
```shell
|
||||||
mdrs metadata neurodata:/NIU/Repository/TEST/
|
mdrs metadata neurodata:/NIU/Repository/TEST/
|
||||||
mdrs metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
mdrs metadata -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
||||||
```
|
```
|
||||||
|
|
||||||
### file-metadata
|
### file-metadata
|
||||||
@ -146,7 +147,7 @@ Get the file metadata
|
|||||||
|
|
||||||
```shell
|
```shell
|
||||||
mdrs file-metadata neurodata:/NIU/Repository/TEST/dataset/sample.dat
|
mdrs file-metadata neurodata:/NIU/Repository/TEST/dataset/sample.dat
|
||||||
mdrs file-metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.txt
|
mdrs file-metadata -p SHARING_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
### help
|
### help
|
||||||
|
@ -1 +1 @@
|
|||||||
1.3.7
|
1.3.11
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
import argparse
|
import argparse
|
||||||
import sys
|
import sys
|
||||||
|
from json import JSONDecodeError
|
||||||
|
|
||||||
from mdrsclient.commands import (
|
from mdrsclient.commands import (
|
||||||
ChaclCommand,
|
ChaclCommand,
|
||||||
@ -52,6 +53,9 @@ def main() -> None:
|
|||||||
except MDRSException as e:
|
except MDRSException as e:
|
||||||
print(f"Error: {e}")
|
print(f"Error: {e}")
|
||||||
sys.exit(2)
|
sys.exit(2)
|
||||||
|
except JSONDecodeError:
|
||||||
|
print("Unexpected response returned. Please check the configuration or the server's operational status.")
|
||||||
|
sys.exit(2)
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
sys.exit(130)
|
sys.exit(130)
|
||||||
|
|
||||||
|
@ -20,8 +20,10 @@ class UsersCurrentResponseLaboratory:
|
|||||||
class UsersApiCurrentResponse:
|
class UsersApiCurrentResponse:
|
||||||
id: int
|
id: int
|
||||||
username: str
|
username: str
|
||||||
full_name: str
|
first_name: str
|
||||||
|
last_name: str
|
||||||
email: str
|
email: str
|
||||||
|
orcid_id: str
|
||||||
laboratories: list[UsersCurrentResponseLaboratory]
|
laboratories: list[UsersCurrentResponseLaboratory]
|
||||||
is_staff: bool
|
is_staff: bool
|
||||||
is_active: bool
|
is_active: bool
|
||||||
|
@ -22,6 +22,7 @@ class DownloadFileInfo:
|
|||||||
@dataclass
|
@dataclass
|
||||||
class DownloadContext:
|
class DownloadContext:
|
||||||
hasError: bool
|
hasError: bool
|
||||||
|
isSkipIfExists: bool
|
||||||
files: list[DownloadFileInfo]
|
files: list[DownloadFileInfo]
|
||||||
|
|
||||||
|
|
||||||
@ -32,6 +33,12 @@ class DownloadCommand(BaseCommand):
|
|||||||
download_parser.add_argument(
|
download_parser.add_argument(
|
||||||
"-r", "--recursive", help="download folders and their contents recursive", action="store_true"
|
"-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(
|
download_parser.add_argument(
|
||||||
"-e", "--exclude", help="exclude to download path matched file or folders", action="append"
|
"-e", "--exclude", help="exclude to download path matched file or folders", action="append"
|
||||||
)
|
)
|
||||||
@ -45,13 +52,20 @@ class DownloadCommand(BaseCommand):
|
|||||||
remote_path = str(args.remote_path)
|
remote_path = str(args.remote_path)
|
||||||
local_path = str(args.local_path)
|
local_path = str(args.local_path)
|
||||||
is_recursive = bool(args.recursive)
|
is_recursive = bool(args.recursive)
|
||||||
|
is_skip_if_exists = bool(args.skip_if_exists)
|
||||||
password = str(args.password) if args.password else None
|
password = str(args.password) if args.password else None
|
||||||
excludes = list(map(lambda x: str(x).rstrip("/").lower(), args.exclude)) if args.exclude is not None else []
|
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, password, excludes)
|
cls.download(remote_path, local_path, is_recursive, is_skip_if_exists, password, excludes)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def download(
|
def download(
|
||||||
cls, remote_path: str, local_path: str, is_recursive: bool, password: str | None, excludes: list[str]
|
cls,
|
||||||
|
remote_path: str,
|
||||||
|
local_path: str,
|
||||||
|
is_recursive: bool,
|
||||||
|
is_skip_if_exists: bool,
|
||||||
|
password: str | None,
|
||||||
|
excludes: list[str],
|
||||||
) -> None:
|
) -> None:
|
||||||
(remote, laboratory_name, r_path) = cls._parse_remote_host_with_path(remote_path)
|
(remote, laboratory_name, r_path) = cls._parse_remote_host_with_path(remote_path)
|
||||||
r_path = r_path.rstrip("/")
|
r_path = r_path.rstrip("/")
|
||||||
@ -67,7 +81,7 @@ class DownloadCommand(BaseCommand):
|
|||||||
if file is not None:
|
if file is not None:
|
||||||
if cls.__check_excludes(excludes, laboratory, r_parent_folder, file):
|
if cls.__check_excludes(excludes, laboratory, r_parent_folder, file):
|
||||||
return
|
return
|
||||||
context = DownloadContext(False, [])
|
context = DownloadContext(False, is_skip_if_exists, [])
|
||||||
l_path = os.path.join(l_dirname, r_basename)
|
l_path = os.path.join(l_dirname, r_basename)
|
||||||
context.files.append(DownloadFileInfo(file, l_path))
|
context.files.append(DownloadFileInfo(file, l_path))
|
||||||
cls.__multiple_download(connection, context)
|
cls.__multiple_download(connection, context)
|
||||||
@ -79,7 +93,7 @@ class DownloadCommand(BaseCommand):
|
|||||||
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(
|
cls.__multiple_download_pickup_recursive_files(
|
||||||
connection, folder_api, laboratory, folder.id, l_dirname, excludes
|
connection, folder_api, laboratory, folder.id, l_dirname, excludes, is_skip_if_exists
|
||||||
)
|
)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
@ -91,8 +105,9 @@ class DownloadCommand(BaseCommand):
|
|||||||
folder_id: str,
|
folder_id: str,
|
||||||
basedir: str,
|
basedir: str,
|
||||||
excludes: list[str],
|
excludes: list[str],
|
||||||
|
is_skip_if_exists: bool,
|
||||||
) -> None:
|
) -> None:
|
||||||
context = DownloadContext(False, [])
|
context = DownloadContext(False, is_skip_if_exists, [])
|
||||||
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 cls.__check_excludes(excludes, laboratory, folder, None):
|
if cls.__check_excludes(excludes, laboratory, folder, None):
|
||||||
@ -110,28 +125,34 @@ class DownloadCommand(BaseCommand):
|
|||||||
raise UnexpectedException("Some files failed to download.")
|
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(
|
cls.__multiple_download_pickup_recursive_files(
|
||||||
connection, folder_api, laboratory, sub_folder.id, dirname, excludes
|
connection, folder_api, laboratory, sub_folder.id, dirname, excludes, is_skip_if_exists
|
||||||
)
|
)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def __multiple_download(cls, connection: MDRSConnection, context: DownloadContext) -> 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:
|
||||||
results = pool.map(lambda x: cls.__multiple_download_worker(file_api, x), context.files)
|
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)
|
hasError = next(filter(lambda x: x is False, results), None)
|
||||||
if hasError is not None:
|
if hasError is not None:
|
||||||
context.hasError = True
|
context.hasError = True
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def __multiple_download_worker(cls, file_api: FilesApi, info: DownloadFileInfo) -> bool:
|
def __multiple_download_worker(cls, file_api: FilesApi, info: DownloadFileInfo, is_skip_if_exists: bool) -> bool:
|
||||||
try:
|
if not is_skip_if_exists or os.path.exists(info.path) and info.file.size != os.path.getsize(info.path):
|
||||||
file_api.download(info.file, info.path)
|
try:
|
||||||
except Exception:
|
file_api.download(info.file, info.path)
|
||||||
return False
|
except Exception:
|
||||||
|
print(f"Failed: ${info.path}")
|
||||||
|
if os.path.isfile(info.path):
|
||||||
|
os.remove(info.path)
|
||||||
|
return False
|
||||||
print(info.path)
|
print(info.path)
|
||||||
return True
|
return True
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def __check_excludes(cls, excludes: list[str], laboratory: Laboratory, folder: Folder, file: File | None) -> bool:
|
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()
|
path = f"/{laboratory.name}{folder.path}{file.name if file is not None else ''}".rstrip("/").lower()
|
||||||
return path in excludes
|
return path in excludes
|
||||||
|
@ -2,7 +2,7 @@ import configparser
|
|||||||
import os
|
import os
|
||||||
from typing import Final
|
from typing import Final
|
||||||
|
|
||||||
import validators # type: ignore
|
import validators
|
||||||
|
|
||||||
from mdrsclient.exceptions import IllegalArgumentException
|
from mdrsclient.exceptions import IllegalArgumentException
|
||||||
from mdrsclient.settings import CONFIG_DIRNAME
|
from mdrsclient.settings import CONFIG_DIRNAME
|
||||||
@ -41,7 +41,7 @@ class ConfigFile:
|
|||||||
|
|
||||||
@url.setter
|
@url.setter
|
||||||
def url(self, url: str) -> None:
|
def url(self, url: str) -> None:
|
||||||
if not validators.url(url): # type: ignore
|
if not validators.url(url):
|
||||||
raise IllegalArgumentException("malformed URI sequence")
|
raise IllegalArgumentException("malformed URI sequence")
|
||||||
self.__load()
|
self.__load()
|
||||||
if self.__config.has_section(self.remote):
|
if self.__config.has_section(self.remote):
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "mdrs-client-python"
|
name = "mdrs-client-python"
|
||||||
version = "1.3.7"
|
version = "1.3.11"
|
||||||
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"
|
||||||
@ -13,6 +13,7 @@ classifiers=[
|
|||||||
"Programming Language :: Python :: 3.10",
|
"Programming Language :: Python :: 3.10",
|
||||||
"Programming Language :: Python :: 3.11",
|
"Programming Language :: Python :: 3.11",
|
||||||
"Programming Language :: Python :: 3.12",
|
"Programming Language :: Python :: 3.12",
|
||||||
|
"Programming Language :: Python :: 3.13",
|
||||||
"OSI Approved :: MIT License",
|
"OSI Approved :: MIT License",
|
||||||
"Topic :: Utilities",
|
"Topic :: Utilities",
|
||||||
]
|
]
|
||||||
@ -25,17 +26,17 @@ python = "^3.10"
|
|||||||
requests = "^2.32.3"
|
requests = "^2.32.3"
|
||||||
requests-toolbelt = "^1.0.0"
|
requests-toolbelt = "^1.0.0"
|
||||||
python-dotenv = "^1.0.1"
|
python-dotenv = "^1.0.1"
|
||||||
pydantic = "^2.8.2"
|
pydantic = "^2.10.5"
|
||||||
pydantic-settings = "^2.3.4"
|
pydantic-settings = "^2.7.1"
|
||||||
PyJWT = "^2.8.0"
|
PyJWT = "^2.10.1"
|
||||||
validators = "^0.33.0"
|
validators = "^0.34.0"
|
||||||
|
|
||||||
[tool.poetry.group.dev.dependencies]
|
[tool.poetry.group.dev.dependencies]
|
||||||
black = "^24.2.2"
|
black = "^24.10.0"
|
||||||
flake8 = "^7.1.0"
|
flake8 = "^7.1.1"
|
||||||
Flake8-pyproject = "^1.2.3"
|
Flake8-pyproject = "^1.2.3"
|
||||||
isort = "^5.13.2"
|
isort = "^5.13.2"
|
||||||
pyright = "^1.1.372"
|
pyright = "^1.1.391"
|
||||||
|
|
||||||
[tool.poetry.scripts]
|
[tool.poetry.scripts]
|
||||||
mdrs = 'mdrsclient.__main__:main'
|
mdrs = 'mdrsclient.__main__:main'
|
||||||
|
Loading…
x
Reference in New Issue
Block a user