mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-12 15:28:21 +01:00
135 lines
4.1 KiB
Python
135 lines
4.1 KiB
Python
import logging
|
|
import os
|
|
import posixpath
|
|
import threading
|
|
|
|
from funcy import cached_property, wrap_prop
|
|
|
|
from dvc.path_info import CloudURLInfo
|
|
from dvc.progress import Tqdm
|
|
from dvc.remote.base import BaseRemote
|
|
from dvc.scheme import Schemes
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class OSSRemote(BaseRemote):
|
|
"""
|
|
oss2 document:
|
|
https://www.alibabacloud.com/help/doc-detail/32026.htm
|
|
|
|
|
|
Examples
|
|
----------
|
|
$ dvc remote add myremote oss://my-bucket/path
|
|
Set key id, key secret and endpoint using modify command
|
|
$ dvc remote modify myremote oss_key_id my-key-id
|
|
$ dvc remote modify myremote oss_key_secret my-key-secret
|
|
$ dvc remote modify myremote oss_endpoint endpoint
|
|
or environment variables
|
|
$ export OSS_ACCESS_KEY_ID="my-key-id"
|
|
$ export OSS_ACCESS_KEY_SECRET="my-key-secret"
|
|
$ export OSS_ENDPOINT="endpoint"
|
|
"""
|
|
|
|
scheme = Schemes.OSS
|
|
path_cls = CloudURLInfo
|
|
REQUIRES = {"oss2": "oss2"}
|
|
PARAM_CHECKSUM = "etag"
|
|
COPY_POLL_SECONDS = 5
|
|
LIST_OBJECT_PAGE_SIZE = 100
|
|
|
|
def __init__(self, repo, config):
|
|
super().__init__(repo, config)
|
|
|
|
url = config.get("url")
|
|
self.path_info = self.path_cls(url) if url else None
|
|
|
|
self.endpoint = config.get("oss_endpoint") or os.getenv("OSS_ENDPOINT")
|
|
|
|
self.key_id = (
|
|
config.get("oss_key_id")
|
|
or os.getenv("OSS_ACCESS_KEY_ID")
|
|
or "defaultId"
|
|
)
|
|
|
|
self.key_secret = (
|
|
config.get("oss_key_secret")
|
|
or os.getenv("OSS_ACCESS_KEY_SECRET")
|
|
or "defaultSecret"
|
|
)
|
|
|
|
@wrap_prop(threading.Lock())
|
|
@cached_property
|
|
def oss_service(self):
|
|
import oss2
|
|
|
|
logger.debug("URL: {}".format(self.path_info))
|
|
logger.debug("key id: {}".format(self.key_id))
|
|
logger.debug("key secret: {}".format(self.key_secret))
|
|
|
|
auth = oss2.Auth(self.key_id, self.key_secret)
|
|
bucket = oss2.Bucket(auth, self.endpoint, self.path_info.bucket)
|
|
|
|
# Ensure bucket exists
|
|
try:
|
|
bucket.get_bucket_info()
|
|
except oss2.exceptions.NoSuchBucket:
|
|
bucket.create_bucket(
|
|
oss2.BUCKET_ACL_PUBLIC_READ,
|
|
oss2.models.BucketCreateConfig(
|
|
oss2.BUCKET_STORAGE_CLASS_STANDARD
|
|
),
|
|
)
|
|
return bucket
|
|
|
|
def remove(self, path_info):
|
|
if path_info.scheme != self.scheme:
|
|
raise NotImplementedError
|
|
|
|
logger.debug("Removing oss://{}".format(path_info))
|
|
self.oss_service.delete_object(path_info.path)
|
|
|
|
def _list_paths(self, prefix, progress_callback=None):
|
|
import oss2
|
|
|
|
for blob in oss2.ObjectIterator(self.oss_service, prefix=prefix):
|
|
if progress_callback:
|
|
progress_callback()
|
|
yield blob.key
|
|
|
|
def list_cache_paths(self, prefix=None, progress_callback=None):
|
|
if prefix:
|
|
prefix = posixpath.join(
|
|
self.path_info.path, prefix[:2], prefix[2:]
|
|
)
|
|
else:
|
|
prefix = self.path_info.path
|
|
return self._list_paths(prefix, progress_callback)
|
|
|
|
def _upload(
|
|
self, from_file, to_info, name=None, no_progress_bar=False, **_kwargs
|
|
):
|
|
with Tqdm(desc=name, disable=no_progress_bar, bytes=True) as pbar:
|
|
self.oss_service.put_object_from_file(
|
|
to_info.path, from_file, progress_callback=pbar.update_to
|
|
)
|
|
|
|
def _download(
|
|
self, from_info, to_file, name=None, no_progress_bar=False, **_kwargs
|
|
):
|
|
with Tqdm(desc=name, disable=no_progress_bar, bytes=True) as pbar:
|
|
self.oss_service.get_object_to_file(
|
|
from_info.path, to_file, progress_callback=pbar.update_to
|
|
)
|
|
|
|
def _generate_download_url(self, path_info, expires=3600):
|
|
assert path_info.bucket == self.path_info.bucket
|
|
|
|
return self.oss_service.sign_url("GET", path_info.path, expires)
|
|
|
|
def exists(self, path_info):
|
|
paths = self._list_paths(path_info.path)
|
|
return any(path_info.path == path for path in paths)
|