# -*- coding: utf-8 -*-
from pathlib import PurePosixPath
from urllib.parse import urlencode
from .api import *
from .exceptions import (
WrongResourceTypeError, PathNotFoundError, UnauthorizedError,
OperationNotFoundError, InvalidResponseError
)
from .utils import auto_retry
from .objects import SyncResourceLinkObject, SyncPublicResourceLinkObject, SyncTrashResourceObject
from .session import Session
from .import_session import import_session
from . import settings
from .common import CaseInsensitiveDict
from typing import Any, Optional, Union, Literal, TYPE_CHECKING
from .compat import Callable, Generator, Dict
from .types import (
OpenFileCallback, FileOrPath, FileOrPathDestination, SessionFactory,
SessionName
)
from .client_common import (
_apply_default_args, _filter_request_kwargs,
_read_file_as_generator, _replace_authorization_header
)
if TYPE_CHECKING:
from .objects import (
SyncResourceObject, SyncOperationLinkObject, SyncTrashResourceObject,
SyncPublicResourceObject, SyncPublicResourcesListObject,
DiskInfoObject, TokenObject, TokenRevokeStatusObject,
DeviceCodeObject
)
__all__ = ["Client"]
ResourceType = Union["SyncResourceObject", "SyncPublicResourceObject", "SyncTrashResourceObject"]
def _exists(get_meta_function: Callable[..., ResourceType], /, *args, **kwargs) -> bool:
kwargs["limit"] = 0
try:
get_meta_function(*args, **kwargs)
return True
except PathNotFoundError:
return False
def _get_type(get_meta_function: Callable[..., ResourceType], /, *args, **kwargs) -> str:
kwargs["limit"] = 0
kwargs["fields"] = ["type"]
type = get_meta_function(*args, **kwargs).type
if type is None:
raise InvalidResponseError("Response did not contain the type field")
return type
def _listdir(get_meta_function: Callable[..., ResourceType], path: str, /, **kwargs) -> Generator[Any, None, None]:
kwargs.setdefault("limit", 10000)
if kwargs.get("fields") is None:
kwargs["fields"] = []
kwargs["fields"] = ["embedded.items.%s" % (k,) for k in kwargs["fields"]]
# Fields that are absolutely necessary
NECESSARY_FIELDS = ["type",
"embedded",
"embedded.offset",
"embedded.limit",
"embedded.total",
"embedded.items"]
kwargs["fields"].extend(NECESSARY_FIELDS)
result = get_meta_function(path, **kwargs)
if result.type == "file":
raise WrongResourceTypeError("%r is a file" % (path,))
if result.embedded is None:
raise InvalidResponseError("Response did not contain _embedded field")
if (result.type is None or result.embedded.items is None or
result.embedded.offset is None or result.embedded.limit is None or
result.embedded.total is None):
raise InvalidResponseError("Response did not contain key field")
yield from result.embedded.items
limit: int = result.embedded.limit
offset: int = result.embedded.offset
total: int = result.embedded.total
while offset + limit < total:
offset += limit
kwargs["offset"] = offset
result = get_meta_function(path, **kwargs)
if result.embedded is None:
raise InvalidResponseError("Response did not contain _embedded field")
if (result.type is None or result.embedded.items is None or
result.embedded.offset is None or result.embedded.limit is None or
result.embedded.total is None):
raise InvalidResponseError("Response did not contain key field")
yield from result.embedded.items
limit = result.embedded.limit
total = result.embedded.total
[docs]
class Client:
"""
Implements access to Yandex.Disk REST API (provides synchronous API).
HTTP client implementation can be specified using the :code:`session`
parameter. :any:`RequestsSession` is used by default. For other options,
see :doc:`/api_reference/sessions`.
Almost all methods of :any:`Client` (the ones that accept `**kwargs`)
accept some additional arguments:
* **n_retries** - `int`, maximum number of retries for a request
* **retry_interval** - `float`, delay between retries (in seconds)
* **headers** - `dict` or `None`, additional request headers
* **timeout** - `tuple` (:code:`(<connect timeout>, <read timeout>)`) or
`float` (specifies both connect and read timeout), request timeout
(in seconds)
Additional parameters, specific to a given HTTP client library can also
be passed, see documentation for specific :any:`Session` subclasses
(:doc:`/api_reference/sessions`).
:param id: application ID
:param secret: application secret password
:param token: application token
:param default_args: `dict` or `None`, default arguments for methods.
Can be used to set the default timeout, headers, etc.
:param session: `None`, `str` or an instance of :any:`Session`.
If :code:`session` is a string, the appropriate session
class will be imported, it must be one of the
following values:
* :code:`"httpx"` - :any:`HTTPXSession`
* :code:`"pycurl"` - :any:`PycURLSession`
* :code:`"requests"` - :any:`RequestsSession`
:param open_file: `None` or a function that opens a file for reading or
writing (:code:`open()` by default)
:param session_factory: kept for compatibility, callable that returns an
instance of :any:`Session`
:ivar id: `str`, application ID
:ivar secret: `str`, application secret password
:ivar token: `str`, application token
:ivar default_args: `dict`, default arguments for methods. Can be used to
set the default timeout, headers, etc.
:ivar session: current session (:any:`Session` instance)
:ivar open_file: function that opens a file for reading or writing
(:code:`open()` by default)
The following exceptions may be raised by most API requests:
:raises RequestError: HTTP client raised an exception while making a request
:raises BadRequestError: server returned HTTP code 400
:raises FieldValidationError: request contains fields with invalid data
:raises UnauthorizedError: server returned HTTP code 401
:raises ForbiddenError: server returned HTTP code 403
:raises NotAcceptableError: server returned HTTP code 406
:raises ConflictError: server returned HTTP code 409
:raises PayloadTooLargeError: server returned code 413
:raises UnsupportedMediaError: server returned HTTP code 415
:raises LockedError: server returned HTTP code 423
:raises TooManyRequestsError: server returned HTTP code 429
:raises InternalServerError: server returned HTTP code 500
:raises BadGatewayError: server returned HTTP code 502
:raises UnavailableError: server returned HTTP code 503
:raises GatewayTimeoutError: server returned HTTP code 504
:raises InsufficientStorageError: server returned HTTP code 509
:raises UnknownYaDiskError: other unknown error
"""
id: str
secret: str
default_args: Dict[str, Any]
session: Session
open_file: OpenFileCallback
synchronous = True
def __init__(self,
id: str = "",
secret: str = "",
token: str = "",
*,
default_args: Optional[Dict[str, Any]] = None,
session: Optional[Union[Session, SessionName]] = None,
open_file: Optional[OpenFileCallback] = None,
session_factory: Optional[SessionFactory] = None):
self.id = id
self.secret = secret
self._token = ""
self.default_args = {} if default_args is None else default_args
if open_file is None:
open_file = open
self.open_file = open_file
if session is None:
if session_factory is not None:
session = session_factory()
else:
try:
session = import_session("requests")()
except ImportError:
raise RuntimeError("requests is not installed. Either install requests or provide a custom session")
elif isinstance(session, str):
session = import_session(session)()
self.session = session
self.token = token
@property
def token(self) -> str:
return self._token
@token.setter
def token(self, value: str) -> None:
self._token = value
self.session.set_token(self._token)
def __enter__(self):
return self
def __exit__(self, *args, **kwargs) -> None:
self.close()
[docs]
def close(self) -> None:
"""
Closes the session.
Do not call this method while there are other active threads using this object.
This method can also be called implicitly by using the `with`
statement.
"""
self.session.close()
[docs]
def get_auth_url(
self,
type: Union[Literal["code"], Literal["token"]],
device_id: Optional[str] = None,
device_name: Optional[str] = None,
redirect_uri: Optional[str] = None,
login_hint: Optional[str] = None,
scope: Optional[str] = None,
optional_scope: Optional[str] = None,
force_confirm: bool = True,
state: Optional[str] = None,
code_challenge: Optional[str] = None,
code_challenge_method: Optional[Union[Literal["plain"], Literal["S256"]]] = None,
display: None = None
) -> str:
"""
Get authentication URL for the user to go to.
This method doesn't send any HTTP requests and merely constructs the URL.
:param type: response type ("code" to get the confirmation code or "token" to get the token automatically)
:param device_id: unique device ID, must be between 6 and 50 characters
:param device_name: device name, should not be longer than 100 characters
:param redirect_uri: the URL to redirect the user to after they allow access to the app,
by default, the first redirect URI specified in the app settings
is used
:param display: doesn't do anything, kept for compatibility
:param login_hint: username or email for the account the token is being requested for
:param scope: `str`, list of permissions for the application
:param optional_scope: `str`, list of optional permissions for the application
:param force_confirm: if True, user will be required to confirm access to the account
even if the user has already granted access for the application
:param state: The state string, which Yandex.OAuth returns without any changes (<= 1024 characters)
:param code_challenge: string derived from the generated :code:`code_verifier` value
using one of the two possible transformations (plain or S256)
:param code_challenge_method: specifies what function was used to transform
the :code:`code_verifier` value to :code:`code_challenge`,
allowed values are :code:`"plain"` and :code:`"S256"` (recommended).
If :code:`"S256"` is used, :code:`code_challenge` must be produced
by hashing the :code:`code_verifier` value and encoding it to base64
:raises ValueError: invalid arguments were passed
:returns: authentication URL
"""
if type not in ("code", "token"):
raise ValueError("type must be either 'code' or 'token'")
if code_challenge_method not in (None, "plain", "S256"):
raise ValueError("code_challenge_method must be either 'plain' or 'S256'")
params = {"response_type": type,
"client_id": self.id,
"force_confirm": "yes" if force_confirm else "no"}
if device_id is not None:
params["device_id"] = device_id
if device_name is not None:
params["device_name"] = device_name
if redirect_uri is not None:
params["redirect_uri"] = redirect_uri
if login_hint is not None:
params["login_hint"] = login_hint
if scope is not None:
params["scope"] = " ".join(scope)
if optional_scope is not None:
params["optional_scope"] = " ".join(optional_scope)
if state is not None:
params["state"] = state
if code_challenge is not None:
params["code_challenge"] = code_challenge
if code_challenge_method is not None:
params["code_challenge_method"] = code_challenge_method
return "https://oauth.yandex.ru/authorize?" + urlencode(params)
[docs]
def get_code_url(
self,
device_id: Optional[str] = None,
device_name: Optional[str] = None,
redirect_uri: Optional[str] = None,
login_hint: Optional[str] = None,
scope: Optional[str] = None,
optional_scope: Optional[str] = None,
force_confirm: bool = True,
state: Optional[str] = None,
code_challenge: Optional[str] = None,
code_challenge_method: Optional[Union[Literal["plain"], Literal["S256"]]] = None,
display: None = None
) -> str:
"""
Get the URL for the user to get the confirmation code.
The confirmation code can later be used to get the token.
This method doesn't send any HTTP requests and merely constructs the URL.
:param device_id: unique device ID, must be between 6 and 50 characters
:param device_name: device name, should not be longer than 100 characters
:param redirect_uri: the URL to redirect the user to after they allow access to the app,
by default, the first redirect URI specified in the app settings
is used
:param display: doesn't do anything, kept for compatibility
:param login_hint: username or email for the account the token is being requested for
:param scope: `str`, list of permissions for the application
:param optional_scope: `str`, list of optional permissions for the application
:param force_confirm: if True, user will be required to confirm access to the account
even if the user has already granted access for the application
:param state: The state string, which Yandex.OAuth returns without any changes (<= 1024 characters)
:param code_challenge: string derived from the generated :code:`code_verifier` value
using one of the two possible transformations (plain or S256)
:param code_challenge_method: specifies what function was used to transform
the :code:`code_verifier` value to :code:`code_challenge`,
allowed values are :code:`"plain"` and :code:`"S256"` (recommended).
If :code:`"S256"` is used, :code:`code_challenge` must be produced
by hashing the :code:`code_verifier` value and encoding it to base64
:raises ValueError: invalid arguments were passed
:returns: authentication URL
"""
return self.get_auth_url(
"code",
device_id=device_id,
device_name=device_name,
redirect_uri=redirect_uri,
display=display,
login_hint=login_hint,
scope=scope,
optional_scope=optional_scope,
force_confirm=force_confirm,
state=state,
code_challenge=code_challenge,
code_challenge_method=code_challenge_method
)
[docs]
def get_device_code(self, **kwargs) -> "DeviceCodeObject":
"""
This request is used for authorization using the Yandex OAuth page.
In this case the user must enter the verification code (:code:`user_code`)
in the browser on the Yandex OAuth page.
After the user has entered the code on the OAuth page, the application
can exchange the :code:`device_code` for the token using the :any:`Client.get_token_from_device_code()`.
:param device_id: unique device ID (between 6 and 50 characters)
:param device_name: device name, should not be longer than 100 characters
:param scope: `str`, list of permissions for the application
:param optional_scope: `str`, list of optional permissions for the application
:raises InvalidClientError: invalid client ID
:raises BadRequestError: invalid request parameters
:returns: :any:`DeviceCodeObject` containing :code:`user_code` and :code:`device_code`
"""
_apply_default_args(kwargs, self.default_args)
_replace_authorization_header(kwargs, "")
request = GetDeviceCodeRequest(self.session, self.id, **kwargs)
request.send()
return request.process()
[docs]
def get_token(self, code: str, /, **kwargs) -> "TokenObject":
"""
Get a new token.
:param code: confirmation code
:param device_id: unique device ID (between 6 and 50 characters)
:param device_name: device name, should not be longer than 100 characters
:param code_verifier: `str`, verifier code, used with the PKCE authorization flow
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises BadVerificationCodeError: confirmation code has invalid format
:raises InvalidGrantError: invalid or expired confirmation code
:raises InvalidClientError: invalid client ID or client secret
:raises BadRequestError: invalid request parameters
:returns: :any:`TokenObject`
"""
_apply_default_args(kwargs, self.default_args)
_replace_authorization_header(kwargs, "")
request = GetTokenRequest(
self.session,
"authorization_code",
client_id=self.id,
code=code,
client_secret=self.secret,
**kwargs
)
request.send()
return request.process()
[docs]
def get_token_from_device_code(self, device_code: str, /, **kwargs) -> "TokenObject":
"""
Get a new token from a device code, previously obtained with :any:`Client.get_device_code()`.
:param code: confirmation code
:param device_id: unique device ID (between 6 and 50 characters)
:param device_name: device name, should not be longer than 100 characters
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises AuthorizationPendingError: user has not authorized the application yet
:raises BadVerificationCodeError: :code:`device_code` has invalid format
:raises InvalidGrantError: invalid or expired :code:`device_code`
:raises InvalidClientError: invalid client ID or client secret
:raises BadRequestError: invalid request parameters
:returns: :any:`TokenObject`
"""
_apply_default_args(kwargs, self.default_args)
_replace_authorization_header(kwargs, "")
request = GetTokenRequest(
self.session,
"device_code",
client_id=self.id,
code=device_code,
client_secret=self.secret,
**kwargs
)
request.send()
return request.process()
[docs]
def refresh_token(self, refresh_token: str, /, **kwargs) -> "TokenObject":
"""
Refresh an existing token.
:param refresh_token: the refresh token that was received with the token
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises InvalidGrantError: invalid or expired refresh token or it
doesn't belong to this application
:raises InvalidClientError: invalid client ID or client secret
:raises BadRequestError: invalid request parameters
:returns: :any:`TokenObject`
"""
_apply_default_args(kwargs, self.default_args)
_replace_authorization_header(kwargs, "")
request = RefreshTokenRequest(
self.session,
refresh_token,
self.id,
self.secret,
**kwargs
)
request.send()
return request.process()
[docs]
def revoke_token(self,
token: Optional[str] = None, /, **kwargs) -> "TokenRevokeStatusObject":
"""
Revoke the token.
:param token: token to revoke
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises InvalidGrantError: specified token doesn't belong to this application
:raises InvalidClientError: invalid client ID or client secret
:raises UnsupportedTokenTypeError: token could not be revoked because
it doesn't have a :code:`device_id`
:raises BadRequestError: invalid request parameters
:returns: :any:`TokenRevokeStatusObject`
"""
_apply_default_args(kwargs, self.default_args)
_replace_authorization_header(kwargs, "")
if token is None:
token = self.token
request = RevokeTokenRequest(self.session, token, self.id, self.secret, **kwargs)
request.send()
return request.process()
[docs]
def check_token(self, token: Optional[str] = None, /, **kwargs) -> bool:
"""
Check whether the token is valid.
:param token: token to check, equivalent to `self.token` if `None`
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:returns: `bool`
"""
# Any ID will do, doesn't matter whether it exists or not
fake_operation_id = "0000"
if token is None:
token = self.token
if not token:
return False
_replace_authorization_header(kwargs, token)
try:
# get_operation_status() doesn't require any permissions, unlike most other requests
self.get_operation_status(fake_operation_id, **kwargs)
return True
except OperationNotFoundError:
return True
except UnauthorizedError:
return False
[docs]
def get_disk_info(self, **kwargs) -> "DiskInfoObject":
"""
Get disk information.
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: :any:`DiskInfoObject`
"""
_apply_default_args(kwargs, self.default_args)
request = DiskInfoRequest(self.session, **kwargs)
request.send()
return request.process()
[docs]
def exists(self, path: str, /, **kwargs) -> bool:
"""
Check whether `path` exists.
:param path: path to the resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `bool`
"""
_apply_default_args(kwargs, self.default_args)
return _exists(self.get_meta, path, **kwargs)
[docs]
def get_type(self, path: str, /, **kwargs) -> str:
"""
Get resource type.
:param path: path to the resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: "file" or "dir"
"""
_apply_default_args(kwargs, self.default_args)
return _get_type(self.get_meta, path, **kwargs)
[docs]
def is_file(self, path: str, /, **kwargs) -> bool:
"""
Check whether `path` is a file.
:param path: path to the resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `True` if `path` is a file, `False` otherwise (even if it doesn't exist)
"""
_apply_default_args(kwargs, self.default_args)
try:
return self.get_type(path, **kwargs) == "file"
except PathNotFoundError:
return False
[docs]
def is_dir(self, path: str, /, **kwargs) -> bool:
"""
Check whether `path` is a directory.
:param path: path to the resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `True` if `path` is a directory, `False` otherwise (even if it doesn't exist)
"""
_apply_default_args(kwargs, self.default_args)
try:
return self.get_type(path, **kwargs) == "dir"
except PathNotFoundError:
return False
[docs]
def listdir(self, path: str, /, **kwargs) -> Generator["SyncResourceObject", None, None]:
"""
Get contents of `path`.
:param path: path to the directory
:param limit: number of children resources to be included in the response
:param offset: number of children resources to be skipped in the response
:param preview_size: size of the file preview
:param preview_crop: `bool`, cut the preview to the size specified in the `preview_size`
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises WrongResourceTypeError: resource is not a directory
:returns: generator of :any:`ResourceObject`
"""
_apply_default_args(kwargs, self.default_args)
return _listdir(self.get_meta, path, **kwargs)
[docs]
def get_upload_link(self, path: str, /, **kwargs) -> str:
"""
Get a link to upload the file using the PUT request.
:param path: destination path
:param overwrite: `bool`, determines whether to overwrite the destination
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ParentNotFoundError: parent directory doesn't exist
:raises PathExistsError: destination path already exists
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:raises InsufficientStorageError: cannot upload file due to lack of storage space
:raises UploadTrafficLimitExceededError: upload limit has been exceeded
:returns: `str`
"""
_apply_default_args(kwargs, self.default_args)
request = GetUploadLinkRequest(self.session, path, **kwargs)
request.send()
return request.process().href
def _upload(self,
get_upload_link_function: Callable,
file_or_path: FileOrPath,
dst_path: str, /, **kwargs) -> None:
try:
timeout = kwargs["timeout"]
except KeyError:
timeout = settings.DEFAULT_UPLOAD_TIMEOUT
retry_interval = kwargs.get("retry_interval")
if retry_interval is None:
retry_interval = settings.DEFAULT_UPLOAD_RETRY_INTERVAL
n_retries = kwargs.get("n_retries")
if n_retries is None:
n_retries = settings.DEFAULT_N_RETRIES
# Number of retries for getting the upload link.
# It is set to 0, unless the file is not seekable, in which case
# we have to use a different retry scheme
n_retries_for_upload_link = 0
kwargs["timeout"] = timeout
# Make sure we don't get any inconsistent behavior with header names
kwargs["headers"] = CaseInsensitiveDict(kwargs.get("headers", {}))
file: Any = None
close_file = False
file_position = 0
iterator_factory = None
session = self.session
try:
if isinstance(file_or_path, (str, bytes)):
close_file = True
file = self.open_file(file_or_path, "rb")
elif callable(file_or_path):
close_file = False
iterator_factory = file_or_path
else:
close_file = False
file = file_or_path
if file is not None and file.seekable():
file_position = file.tell()
elif iterator_factory is None:
n_retries, n_retries_for_upload_link = 0, n_retries
def attempt():
temp_kwargs = dict(kwargs)
temp_kwargs["n_retries"] = n_retries_for_upload_link
temp_kwargs["retry_interval"] = 0.0
link = get_upload_link_function(dst_path, **temp_kwargs)
# session.put() doesn't accept some of the passed parameters
_filter_request_kwargs(temp_kwargs)
temp_kwargs.setdefault("stream", True)
# Disable keep-alive by default, since the upload server is random
try:
temp_kwargs["headers"].setdefault("Connection", "close")
except KeyError:
temp_kwargs["headers"] = {"Connection": "close"}
if iterator_factory is not None:
payload = iterator_factory()
elif file.seekable():
file.seek(file_position)
payload = file
else:
# requests will try to seek the file to determine the payload size
# regardless of whether it is seekable() or not.
# To bypass this problem we pass the file as a generator instead.
payload = _read_file_as_generator(file)
with session.send_request("PUT", link, data=payload, **temp_kwargs) as response:
if response.status != 201:
raise response.get_exception()
auto_retry(attempt, n_retries, retry_interval)
finally:
if close_file and file is not None:
file.close()
[docs]
def upload(self,
file_or_path: FileOrPath,
dst_path: str, /, **kwargs) -> SyncResourceLinkObject:
"""
Upload a file to disk.
:param file_or_path: path, file-like object to be uploaded or
a function that returns an iterator (or generator)
:param dst_path: destination path
:param overwrite: if `True`, the resource will be overwritten if it already exists,
an error will be raised otherwise
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ParentNotFoundError: parent directory doesn't exist
:raises PathExistsError: destination path already exists
:raises InsufficientStorageError: cannot upload file due to lack of storage space
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:raises UploadTrafficLimitExceededError: upload limit has been exceeded
:returns: :any:`SyncResourceLinkObject`, link to the destination resource
"""
_apply_default_args(kwargs, self.default_args)
self._upload(self.get_upload_link, file_or_path, dst_path, **kwargs)
return SyncResourceLinkObject.from_path(dst_path, yadisk=self)
[docs]
def upload_by_link(self,
file_or_path: FileOrPath,
link: str, /, **kwargs) -> None:
"""
Upload a file to disk using an upload link.
:param file_or_path: path, file-like object to be uploaded or
a function that returns an iterator (or generator)
:param link: upload link
:param overwrite: if `True`, the resource will be overwritten if it already exists,
an error will be raised otherwise
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises InsufficientStorageError: cannot upload file due to lack of storage space
"""
_apply_default_args(kwargs, self.default_args)
self._upload(lambda *args, **kwargs: link, file_or_path, "", **kwargs)
[docs]
def get_download_link(self, path: str, /, **kwargs) -> str:
"""
Get a download link for a file (or a directory).
:param path: path to the resource
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: `str`
"""
_apply_default_args(kwargs, self.default_args)
request = GetDownloadLinkRequest(self.session, path, **kwargs)
request.send()
return request.process().href
def _download(self,
get_download_link_function: Callable,
src_path: str,
file_or_path: FileOrPathDestination, /, **kwargs) -> None:
n_retries = kwargs.get("n_retries")
if n_retries is None:
n_retries = settings.DEFAULT_N_RETRIES
# Number of retries for getting the download link.
# It is set to 0, unless the file is not seekable, in which case
# we have to use a different retry scheme
n_retries_for_download_link = 0
retry_interval = kwargs.get("retry_interval")
if retry_interval is None:
retry_interval = settings.DEFAULT_RETRY_INTERVAL
try:
timeout = kwargs["timeout"]
except KeyError:
timeout = settings.DEFAULT_TIMEOUT
kwargs["timeout"] = timeout
# Make sure we don't get any inconsistent behavior with header names
kwargs["headers"] = CaseInsensitiveDict(kwargs.get("headers", {}))
file: Any = None
close_file = False
file_position = 0
session = self.session
try:
if isinstance(file_or_path, (str, bytes)):
close_file = True
file = self.open_file(file_or_path, "wb")
else:
close_file = False
file = file_or_path
if file.seekable():
file_position = file.tell()
else:
n_retries, n_retries_for_download_link = 0, n_retries
def attempt():
temp_kwargs = dict(kwargs)
temp_kwargs["n_retries"] = n_retries_for_download_link
temp_kwargs["retry_interval"] = 0.0
link = get_download_link_function(src_path, **temp_kwargs)
# session.get() doesn't accept some of the passed parameters
_filter_request_kwargs(temp_kwargs)
temp_kwargs.setdefault("stream", True)
# Disable keep-alive by default, since the download server is random
try:
temp_kwargs["headers"].setdefault("Connection", "close")
except KeyError:
temp_kwargs["headers"] = {"Connection": "close"}
if file.seekable():
file.seek(file_position)
with session.send_request("GET", link, **temp_kwargs) as response:
response.download(file.write)
if response.status != 200:
raise response.get_exception()
auto_retry(attempt, n_retries, retry_interval)
finally:
if close_file and file is not None:
file.close()
[docs]
def download(self,
src_path: str,
file_or_path: FileOrPathDestination, /, **kwargs) -> SyncResourceLinkObject:
"""
Download the file.
:param src_path: source path
:param file_or_path: destination path or file-like object
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncResourceLinkObject`, link to the source resource
"""
_apply_default_args(kwargs, self.default_args)
self._download(self.get_download_link, src_path, file_or_path, **kwargs)
return SyncResourceLinkObject.from_path(src_path, yadisk=self)
[docs]
def download_by_link(self,
link: str,
file_or_path: FileOrPathDestination, /, **kwargs) -> None:
"""
Download the file from the link.
:param link: download link
:param file_or_path: destination path or file-like object
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
"""
_apply_default_args(kwargs, self.default_args)
self._download(lambda *args, **kwargs: link, "", file_or_path, **kwargs)
[docs]
def remove(self, path: str, /, **kwargs) -> Optional["SyncOperationLinkObject"]:
"""
Remove the resource.
:param path: path to the resource to be removed
:param permanently: if `True`, the resource will be removed permanently,
otherwise, it will be just moved to the trash
:param md5: `str`, MD5 hash of the file to remove
:param force_async: forces the operation to be executed asynchronously
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises BadRequestError: MD5 check is only available for files
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncOperationLinkObject` if the operation is performed asynchronously, `None` otherwise
"""
_apply_default_args(kwargs, self.default_args)
request = DeleteRequest(self.session, path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def mkdir(self, path: str, /, **kwargs) -> SyncResourceLinkObject:
"""
Create a new directory.
:param path: path to the directory to be created
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ParentNotFoundError: parent directory doesn't exist
:raises DirectoryExistsError: destination path already exists
:raises InsufficientStorageError: cannot create directory due to lack of storage space
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncResourceLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
request = MkdirRequest(self.session, path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def trash_exists(self, path: str, /, **kwargs) -> bool:
"""
Check whether the trash resource at `path` exists.
:param path: path to the trash resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `bool`
"""
_apply_default_args(kwargs, self.default_args)
return _exists(self.get_trash_meta, path, **kwargs)
[docs]
def copy(self,
src_path: str,
dst_path: str, /, **kwargs) -> Union[SyncResourceLinkObject, "SyncOperationLinkObject"]:
"""
Copy `src_path` to `dst_path`.
If the operation is performed asynchronously, returns the link to the operation,
otherwise, returns the link to the newly created resource.
:param src_path: source path
:param dst_path: destination path
:param overwrite: if `True` the destination path can be overwritten,
otherwise, an error will be raised
:param force_async: forces the operation to be executed asynchronously
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises PathExistsError: destination path already exists
:raises ForbiddenError: application doesn't have enough rights for this request
:raises InsufficientStorageError: cannot complete request due to lack of storage space
:raises ResourceIsLockedError: resource is locked by another request
:raises UploadTrafficLimitExceededError: upload limit has been exceeded
:returns: :any:`SyncResourceLinkObject` or :any:`SyncOperationLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
request = CopyRequest(self.session, src_path, dst_path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def restore_trash(self,
path: str, /,
dst_path: Optional[str] = None, **kwargs) -> Union[SyncResourceLinkObject, "SyncOperationLinkObject"]:
"""
Restore a trash resource.
Returns a link to the newly created resource or a link to the asynchronous operation.
:param path: path to the trash resource to be restored
:param dst_path: destination path
:param overwrite: `bool`, determines whether the destination can be overwritten
:param force_async: forces the operation to be executed asynchronously
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises PathExistsError: destination path already exists
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncResourceLinkObject` or :any:`SyncOperationLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
kwargs["dst_path"] = dst_path
request = RestoreTrashRequest(self.session, path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def move(self,
src_path: str,
dst_path: str, /, **kwargs) -> Union[SyncResourceLinkObject, "SyncOperationLinkObject"]:
"""
Move `src_path` to `dst_path`.
:param src_path: source path to be moved
:param dst_path: destination path
:param overwrite: `bool`, determines whether to overwrite the destination
:param force_async: forces the operation to be executed asynchronously
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises PathExistsError: destination path already exists
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncResourceLinkObject` or :any:`SyncOperationLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
request = MoveRequest(self.session, src_path, dst_path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def rename(self, src_path: str, new_name: str, /, **kwargs) -> Union[SyncResourceLinkObject, "SyncOperationLinkObject"]:
"""
Rename `src_path` to have filename `new_name`.
Does the same as `move()` but changes only the filename.
:param src_path: source path to be moved
:param new_name: target filename to rename to
:param overwrite: `bool`, determines whether to overwrite the destination
:param force_async: forces the operation to be executed asynchronously
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises PathExistsError: destination path already exists
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:raises ValueError: `new_name` is not a valid filename
:returns: :any:`SyncResourceLinkObject` or :any:`SyncOperationLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
new_name = new_name.rstrip("/")
if "/" in new_name or new_name in (".", ".."):
raise ValueError(f"Invalid filename: {new_name}")
dst_path = str(PurePosixPath(src_path).parent / new_name)
return self.move(src_path, dst_path, **kwargs)
[docs]
def remove_trash(self, path: str, /, **kwargs) -> Optional["SyncOperationLinkObject"]:
"""
Remove a trash resource.
:param path: path to the trash resource to be deleted
:param force_async: forces the operation to be executed asynchronously
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncOperationLinkObject` if the operation is performed asynchronously, `None` otherwise
"""
_apply_default_args(kwargs, self.default_args)
request = DeleteTrashRequest(self.session, path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def publish(self, path: str, /, **kwargs) -> SyncResourceLinkObject:
"""
Make a resource public.
:param path: path to the resource to be published
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncResourceLinkObject`, link to the resource
"""
_apply_default_args(kwargs, self.default_args)
request = PublishRequest(self.session, path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def unpublish(self, path: str, /, **kwargs) -> SyncResourceLinkObject:
"""
Make a public resource private.
:param path: path to the resource to be unpublished
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncResourceLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
request = UnpublishRequest(self.session, path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def save_to_disk(self,
public_key: str, /, **kwargs) -> Union[SyncResourceLinkObject, "SyncOperationLinkObject"]:
"""
Saves a public resource to the disk.
Returns the link to the operation if it's performed asynchronously,
or a link to the resource otherwise.
:param public_key: public key or public URL of the public resource
:param name: filename of the saved resource
:param path: path to the copied resource in the public folder
:param save_path: path to the destination directory (downloads directory by default)
:param force_async: forces the operation to be executed asynchronously
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:raises InsufficientStorageError: cannot upload file due to lack of storage space
:raises UploadTrafficLimitExceededError: upload limit has been exceeded
:returns: :any:`SyncResourceLinkObject` or :any:`SyncOperationLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
request = SaveToDiskRequest(self.session, public_key, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def public_exists(self, public_key: str, /, **kwargs) -> bool:
"""
Check whether the public resource exists.
:param public_key: public key or public URL of the public resource
:param path: relative path to the resource within the public folder
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `bool`
"""
_apply_default_args(kwargs, self.default_args)
return _exists(self.get_public_meta, public_key, **kwargs)
[docs]
def public_listdir(self,
public_key: str, /, **kwargs) -> Generator["SyncPublicResourceObject", None, None]:
"""
Get contents of a public directory.
:param public_key: public key or public URL of the public resource
:param path: relative path to the resource in the public folder.
By specifying the key of the published folder in `public_key`,
you can request contents of any nested folder.
:param limit: number of children resources to be included in the response
:param offset: number of children resources to be skipped in the response
:param preview_size: size of the file preview
:param preview_crop: `bool`, cut the preview to the size specified in the `preview_size`
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises WrongResourceTypeError: resource is not a directory
:returns: generator of :any:`SyncPublicResourceObject`
"""
_apply_default_args(kwargs, self.default_args)
return _listdir(self.get_public_meta, public_key, **kwargs)
[docs]
def get_public_type(self, public_key: str, /, **kwargs) -> str:
"""
Get public resource type.
:param public_key: public key or public URL of the public resource
:param path: relative path to the resource within the public folder
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: "file" or "dir"
"""
_apply_default_args(kwargs, self.default_args)
return _get_type(self.get_public_meta, public_key, **kwargs)
[docs]
def is_public_dir(self, public_key: str, /, **kwargs) -> bool:
"""
Check whether the public resource is a public directory.
:param public_key: public key or public URL of the public resource
:param path: relative path to the resource within the public folder
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `True` if `public_key` is a directory, `False` otherwise (even if it doesn't exist)
"""
_apply_default_args(kwargs, self.default_args)
try:
return self.get_public_type(public_key, **kwargs) == "dir"
except PathNotFoundError:
return False
[docs]
def is_public_file(self, public_key: str, /, **kwargs) -> bool:
"""
Check whether the public resource is a public file.
:param public_key: public key or public URL of the public resource
:param path: relative path to the resource within the public folder
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `True` if `public_key` is a file, `False` otherwise (even if it doesn't exist)
"""
_apply_default_args(kwargs, self.default_args)
try:
return self.get_public_type(public_key, **kwargs) == "file"
except PathNotFoundError:
return False
[docs]
def trash_listdir(self,
path: str, /, **kwargs) -> Generator["SyncTrashResourceObject", None, None]:
"""
Get contents of a trash resource.
:param path: path to the directory in the trash bin
:param limit: number of children resources to be included in the response
:param offset: number of children resources to be skipped in the response
:param preview_size: size of the file preview
:param preview_crop: `bool`, cut the preview to the size specified in the `preview_size`
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises WrongResourceTypeError: resource is not a directory
:returns: generator of :any:`SyncTrashResourceObject`
"""
_apply_default_args(kwargs, self.default_args)
return _listdir(self.get_trash_meta, path, **kwargs)
[docs]
def get_trash_type(self, path: str, /, **kwargs) -> str:
"""
Get trash resource type.
:param path: path to the trash resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: "file" or "dir"
"""
_apply_default_args(kwargs, self.default_args)
return _get_type(self.get_trash_meta, path, **kwargs)
[docs]
def is_trash_dir(self, path: str, /, **kwargs) -> bool:
"""
Check whether `path` is a trash directory.
:param path: path to the trash resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `True` if `path` is a directory, `False` otherwise (even if it doesn't exist)
"""
_apply_default_args(kwargs, self.default_args)
try:
return self.get_trash_type(path, **kwargs) == "dir"
except PathNotFoundError:
return False
[docs]
def is_trash_file(self, path: str, /, **kwargs) -> bool:
"""
Check whether `path` is a trash file.
:param path: path to the trash resource
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: `True` if `path` is a file, `False` otherwise (even if it doesn't exist)
"""
_apply_default_args(kwargs, self.default_args)
try:
return self.get_trash_type(path, **kwargs) == "file"
except PathNotFoundError:
return False
[docs]
def get_public_resources(self, **kwargs) -> "SyncPublicResourcesListObject":
"""
Get a list of public resources.
:param offset: offset from the beginning of the list
:param limit: maximum number of elements in the list
:param preview_size: size of the file preview
:param preview_crop: `bool`, cut the preview to the size specified in the `preview_size`
:param type: filter based on type of resources ("file" or "dir")
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: :any:`SyncPublicResourcesListObject`
"""
_apply_default_args(kwargs, self.default_args)
request = GetPublicResourcesRequest(self.session, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def patch(self,
path: str,
properties: dict, /, **kwargs) -> "SyncResourceObject":
"""
Update custom properties of a resource.
:param path: path to the resource
:param properties: `dict`, custom properties to update
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`ResourceObject`
"""
_apply_default_args(kwargs, self.default_args)
request = PatchRequest(self.session, path, properties, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def get_files(self, **kwargs) -> Generator["SyncResourceObject", None, None]:
"""
Get a flat list of all files (that doesn't include directories).
:param offset: offset from the beginning of the list
:param limit: number of list elements to be included
:param media_type: type of files to include in the list
:param sort: `str`, field to be used as a key to sort children resources
:param preview_size: size of the file preview
:param preview_crop: `bool`, cut the preview to the size specified in the `preview_size`
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: generator of :any:`ResourceObject`
"""
_apply_default_args(kwargs, self.default_args)
if kwargs.get("limit") is not None:
request = FilesRequest(self.session, **kwargs)
request.send()
for i in request.process(yadisk=self).items:
yield i
return
kwargs.setdefault("offset", 0)
kwargs["limit"] = 1000
while True:
counter = 0
for i in self.get_files(**kwargs):
counter += 1
yield i
if counter < kwargs["limit"]:
break
kwargs["offset"] += kwargs["limit"]
[docs]
def get_last_uploaded(self, **kwargs) -> Generator["SyncResourceObject", None, None]:
"""
Get the list of latest uploaded files sorted by upload date.
:param limit: maximum number of elements in the list
:param media_type: type of files to include in the list
:param preview_size: size of the file preview
:param preview_crop: `bool`, cut the preview to the size specified in the `preview_size`
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ForbiddenError: application doesn't have enough rights for this request
:returns: generator of :any:`ResourceObject`
"""
_apply_default_args(kwargs, self.default_args)
request = LastUploadedRequest(self.session, **kwargs)
request.send()
for i in request.process(yadisk=self).items:
yield i
[docs]
def upload_url(self, url: str, path: str, /, **kwargs) -> "SyncOperationLinkObject":
"""
Upload a file from URL.
:param url: source URL
:param path: destination path
:param disable_redirects: `bool`, forbid redirects
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises ParentNotFoundError: parent directory doesn't exist
:raises PathExistsError: destination path already exists
:raises InsufficientStorageError: cannot upload file due to lack of storage space
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:raises UploadTrafficLimitExceededError: upload limit has been exceeded
:returns: :any:`SyncOperationLinkObject`, link to the asynchronous operation
"""
_apply_default_args(kwargs, self.default_args)
request = UploadURLRequest(self.session, url, path, **kwargs)
request.send()
return request.process(yadisk=self)
[docs]
def get_public_download_link(self, public_key: str, /, **kwargs) -> str:
"""
Get a download link for a public resource.
:param public_key: public key or public URL of the public resource
:param path: relative path to the resource within the public folder
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: `str`
"""
_apply_default_args(kwargs, self.default_args)
request = GetPublicDownloadLinkRequest(self.session, public_key, **kwargs)
request.send()
return request.process().href
[docs]
def download_public(self,
public_key: str,
file_or_path: FileOrPathDestination, /, **kwargs) -> SyncPublicResourceLinkObject:
"""
Download the public resource.
:param public_key: public key or public URL of the public resource
:param file_or_path: destination path or file-like object
:param path: relative path to the resource within the public folder
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises PathNotFoundError: resource was not found on Disk
:raises ForbiddenError: application doesn't have enough rights for this request
:raises ResourceIsLockedError: resource is locked by another request
:returns: :any:`SyncPublicResourceLinkObject`
"""
_apply_default_args(kwargs, self.default_args)
self._download(
lambda *args, **kwargs: self.get_public_download_link(public_key, **kwargs),
"", file_or_path, **kwargs)
return SyncPublicResourceLinkObject.from_public_key(public_key, yadisk=self)
[docs]
def get_operation_status(self, operation_id: str, /, **kwargs) -> str:
"""
Get operation status.
:param operation_id: ID of the operation or a link
:param fields: list of keys to be included in the response
:param timeout: `float` or `tuple`, request timeout
:param headers: `dict` or `None`, additional request headers
:param n_retries: `int`, maximum number of retries
:param retry_interval: delay between retries in seconds
:raises OperationNotFoundError: requested operation was not found
:returns: `str`, :code:`"in-progress"` indicates that the operation
is currently running, :code:`"success"` indicates that
the operation was successful, :code:`"failed"` means that
the operation failed
"""
_apply_default_args(kwargs, self.default_args)
request = GetOperationStatusRequest(self.session, operation_id, **kwargs)
request.send()
return request.process().status