def get_upload_link(self, file_path: Path, destination: str) -> str:
"""
Send initial request to get link for download a file.
Args:
file_path: local path of file that needs to be uploaded.
destination: directory on YandexDisk storage where to
save uploaded file. For example: '/path/bar'.
Returns:
URL for the file upload
Raises:
ApiResponseException: an error occurred accessing API.
"""
metadata = {
"name": file_path.name,
"mime_type": mimetypes.guess_type(file_path)[0],
}
r = requests.get(
"https://cloud-api.yandex.net/v1/disk/resources/upload",
params={
"path": destination,
"fields": json.dumps(metadata)
},
headers=self._auth_headers)
if r.status_code != 200:
raise ApiResponseException(r.status_code, r.json()["description"])
return r.json()["href"]
def list_files(self, sort="name", limit=20, offset=0) -> list:
"""
Make request to get list of limited size consists of files on
YandexDisk excluding directories.
Args:
sort: Sort key. Valid keys are: 'name', 'path', 'created',
'modified', 'size'. To sort in reversed order add a hyphen
to the parameter value: '-name'.
limit: The number of resources in the folder that should be
described in the list.
offset: The number of resources from the top of the list that
should be skipped in the response (used for paginated output).
Returns:
List of 'limit' size consists of YaDiskFileObjects represent each
file excluding directories.
"""
keys = {
"sort": sort,
"limit": limit,
"offset": offset,
}
r = requests.get(
"https://cloud-api.yandex.net/v1/disk/resources/files",
params=keys,
headers=self._auth_headers)
if r.status_code != 200:
raise ApiResponseException(r.status_code, r.json()["description"])
return [YaDiskFile(file) for file in r.json()["items"]]
def remove(self, path, permanently=False) -> None:
"""
Make a request for removing file on YandexDisk storage.
Args:
path: Path to folder which needs to be deleted.
Examples: 'disk:/path/foo.py', '/path/bar'.
permanently: Optional; whether to delete the file
permanently or move to the trash.
Raises:
ApiResponseException: an error occurred accessing API.
IncorrectPathException: if path has prohibited chars.
"""
flags = {
"path": path,
"permanently": permanently,
}
r = requests.request("DELETE",
"https://cloud-api.yandex.net/v1/disk/resources",
params=flags,
headers=self._auth_headers)
if r.status_code not in {202, 204}:
raise ApiResponseException(r.status_code, r.json()["description"])
def mkdir(self, destination: str) -> None:
"""
Make a request for making directory on YandexDisk storage.
Args:
destination: Path to folder which needs to be created.
Examples: 'disk:/path/foo.py', '/path/bar'.
Raises:
ApiResponseException: an error occurred accessing API.
"""
path = {"path": destination}
r = requests.put("https://cloud-api.yandex.net/v1/disk/resources",
params=path,
headers=self._auth_headers)
if r.status_code != 201:
raise ApiResponseException(r.status_code, r.json()["description"])
def get_file(self, path: str):
"""
Get file or directory meta-information by path. Includes only
name, type and path of target file.
Args:
path: directory or file to get meta-information about
Raises:
ApiResponseException: an error occurred accessing API.
"""
keys = {"path": path, "fields": "name, type, path"}
r = requests.get("https://cloud-api.yandex.net/v1/disk/resources/",
params=keys,
headers=self._auth_headers)
if r.status_code != 200:
raise ApiResponseException(r.status_code, r.json()["description"])
return YaDiskFile(r.json())
def upload_file(self, upload_link: str, file_data: bytes) -> None:
"""
Upload a entire file by one single request. Before use
this method call `get_upload_link` and provide upload
link this method.
Args:
upload_link: link for uploading file
file_data: raw binary file data
Raises:
ApiResponseException: an error occurred accessing API.
"""
r = requests.put(upload_link,
data=file_data,
headers=self._auth_headers)
if r.status_code not in {201, 202}:
raise ApiResponseException(r.status_code, r.json()["description"])
def download(self, download_link: str) -> bytes:
"""
Make a request for downloading file from YaDisk storage.
Args:
download_link: link from `get_download_link` method.
Returns:
Raw bytes of downloaded file.
Raises:
ApiResponseException: an error occurred accessing API.
FileIsNotDownloadable: an error occurred getting link for file with
provided `path` argument.
"""
r = requests.get(download_link, headers=self._auth_headers)
if r.status_code != 200:
raise ApiResponseException(r.status_code, r.json()["description"])
return r.content
def lsdir(self,
path: str = None,
sort: str = "modified",
limit: int = 20,
offset: int = 0) -> List[YaDiskFile]:
"""
Make request to get directory or file meta-information.
Args:
path: Directory to list. Examples: 'disk:/path/foo.py', '/path'.
sort: Optional; Sort key. Valid keys are: 'name', 'path', 'size',
'modified', 'created'. To sort in reversed order add a hyphen
to the parameter value: '-name'.
limit: Optional;The number of resources in the folder that should
be described in the list.
offset: Optional; The number of resources from the top of the list
that should be skipped in the response
(used for paginated output).
Returns:
List of YaDisk files.
Raises:
ApiResponseException: an error occurred accessing API.
"""
keys = {
"path": path,
"sort": sort,
"limit": limit,
"offset": offset,
}
r = requests.get("https://cloud-api.yandex.net/v1/disk/resources/",
params=keys,
headers=self._auth_headers)
if r.status_code != 200:
raise ApiResponseException(r.status_code, r.json()["description"])
try:
return [
YaDiskFile(file) for file in r.json()["_embedded"]["items"]
]
except KeyError:
return []
def get_download_link(self, path: str):
"""
Send request to YandexDisk API for getting link for file download.
Args:
path: the path to the file to download on YandexDisk storage.
Returns:
Download link as str.
Raises:
ApiResponseException: an error occurred accessing API
"""
r = requests.get(
"https://cloud-api.yandex.net/v1/disk/resources/download",
headers=self._auth_headers,
params={"path": path})
if r.status_code != 200:
raise ApiResponseException(r.status_code, r.json()["description"])
r = r.json()
if not r["href"]:
raise FileIsNotDownloadableException(path)
return r["href"]