Документация
Объект YaDisk
- class yadisk_async.YaDisk(id: str = '', secret: str = '', token: str = '', default_args: dict[str, Any] | None = None)[исходный код]
Реализует доступ к REST API Яндекс.Диска.
Примечание
Не забывайте вызывать
YaDisk.close
или используйте async with, чтобы закрыть все соединения. Иначе, вы можете получить предупреждение.В оригинальной библиотеке это делалось в деструкторе, но т.к.
aiohttp.ClientSession.close
- сопрограмма, здесь этого сделать нельзя, поэтому приходится делать это явно.- Параметры:
id – идентификатор приложения
secret – пароль приложения
token – токен
default_args – dict или None, аргументы по умолчанию для методов. Можно использовать, чтобы задать стандартный таймаут, заголовки и т.д.
- Переменные:
id – str, идентификатор приложения
secret – str, пароль приложения
token – str, токен
default_args – dict, аргументы по умолчанию для методов. Можно использовать, чтобы задать стандартный таймаут, заголовки и т.д.
Большинство запросов к API могут вызвать следующие исключения:
- Исключение:
BadRequestError – сервер вернул код 400.
FieldValidationError – запрос содежит поля с некорректными данными.
UnauthorizedError – сервер вернул код 401.
ForbiddenError – сервер вернул код 403.
NotAcceptableError – сервер вернул код 406.
ConflictError – сервер вернул код 409.
PayloadTooLargeError – сервер вернул код 413.
UnsupportedMediaError – сервер вернул код 415.
LockedError – сервер вернул код 423.
TooManyRequestsError – сервер вернул код 429.
InternalServerError – сервер вернул код 500.
BadGatewayError – сервер вернул код 502.
UnavailableError – сервер вернул код 503.
GatewayTimeoutError – сервер вернул код 504.
InsufficientStorageError – сервер вернул код 509.
UnknownYaDiskError – другая неизвестная ошибка
- async check_token(token: str | None = None, /, **kwargs) bool [исходный код]
Проверяет, действителен ли токен.
- Параметры:
token – токен, подлежащий проверке, то же самое, что self.token при None
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Результат:
bool
- clear_session_cache() None [исходный код]
Очищает кэш сессий. Неиспользуемые сессии НЕ будут закрыты.
- async close() None [исходный код]
Закрывет все сессии и очищает кэш сессий. Не вызывайте этот метод, пока другие потоки используют этот объект.
Этот метод неявно вызывается конструкцией async with.
- async copy(src_path: str, dst_path: str, /, **kwargs) ResourceLinkObject | OperationLinkObject [исходный код]
Копирует src_path в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.
- Параметры:
src_path – исходный путь
dst_path – путь назначения
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
- async download(src_path: str, path_or_file: str | bytes | IO[bytes] | BinaryAsyncFileLike, /, **kwargs) ResourceLinkObject [исходный код]
Скачивает файл.
- Параметры:
src_path – исходный путь
path_or_file – путь назначения или файл-подобный объект
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на исходный ресурс
- async download_by_link(link: str, file_or_path: str | bytes | IO[bytes] | BinaryAsyncFileLike, /, **kwargs) None [исходный код]
Скачивает файл по уже полученной ссылке.
- Параметры:
link – ссылка для скачивания
file_or_path – путь назначения или файл-подобный объект
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- async download_public(public_key: str, file_or_path: str | bytes | IO, /, **kwargs) PublicResourceLinkObject [исходный код]
Скачивает публичный ресурс.
- Параметры:
public_key – публичный ключ или URL к ресурсу
file_or_path – путь назначения или файл-подобный объект
path – относительный путь к ресурсу внутри публичной папки
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async exists(path: str, /, **kwargs) bool [исходный код]
Проверяет, существует ли path.
- Параметры:
path – путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- get_auth_url(**kwargs) str [исходный код]
Получает URL для аутентификации для пользователя.
- Параметры:
type – тип ответа («code», чтобы получить код подтверждения или «token», чтобы получить токен автоматически)
device_id – уникальный идентификатор устройства, от 6 до 50 символов
device_name – имя устройства, не более 100 символов
display – указывает использовать облегчённую вёрстку, обрабатывает только «popup», остальные значения игнорируются
login_hint – username или email аккаунта, для которого будет получен токен
scope – список разрешений для приложения
optional_scope – список опциональных разрешений для приложения
force_confirm – Если True, пользователь должен будет разрешить доступ к аккаунту, даже если он уже это сделал до этого
state – Строка состояния, которую Яндекс.OAuth возвращает без изменений (<= 1024 символов)
- Результат:
URL для аутентификации
- get_code_url(**kwargs) str [исходный код]
Получает URL для получения пользователем кода подтверждения. Он может быть использован для получения токена.
- Параметры:
device_id – уникальный идентификатор устройства, от 6 до 50 символов
device_name – имя устройства, не более 100 символов
display – указывает использовать облегчённую вёрстку, обрабатывает только «popup», остальные значения игнорируются
login_hint – username или email аккаунта, для которого будет получен токен
scope – список разрешений для приложения
optional_scope – список опциональных разрешений для приложения
force_confirm – Если True, пользователь должен будет разрешить доступ к аккаунту, даже если он уже это сделал до этого
state – Строка состояния, которую Яндекс.OAuth возвращает без изменений (<= 1024 символов)
- Результат:
URL для аутентификации
- async get_disk_info(**kwargs) DiskInfoObject [исходный код]
Получает информацию о диске.
- Параметры:
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_download_link(path: str, /, **kwargs) str [исходный код]
Получает ссылку на скачивание файла (или папки).
- Параметры:
path – путь к ресурсу
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
str
- async get_files(**kwargs) AsyncGenerator[ResourceObject, None] [исходный код]
Получить плоский список всех файлов (без папок).
- Параметры:
offset – отступ от начала списка
limit – максимальное количество элементов списка
media_type – тип файлов, которые будут включены в список
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
генератор
ResourceObject
- async get_last_uploaded(**kwargs) AsyncGenerator[ResourceObject, None] [исходный код]
Получает список последних загруженных файлов, отсортированный по дате загрузки.
- Параметры:
limit – максимальное число элементов в списке
media_type – тип файлов, которые будут включены в список
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
генератор
ResourceObject
- async get_meta(path: str, /, **kwargs) ResourceObject [исходный код]
Получает мета-информацию о ресурсе.
- Параметры:
path – путь к ресурсу
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_operation_status(operation_id, **kwargs)[исходный код]
Получает статус операции.
- Параметры:
operation_id – идентификатор операции или ссылка на нее
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
OperationNotFoundError – указанная операция не найдена
- Результат:
str
- async get_public_download_link(public_key: str, /, **kwargs) str [исходный код]
Получает ссылку на скачивание публичного ресурса.
- Параметры:
public_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
str
- async get_public_meta(public_key: str, /, **kwargs) PublicResourceObject [исходный код]
Получает мета-информацию о публичном ресурсе.
- Параметры:
public_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки. Указывая ключ опубликованной папки через public_key, вы можете запросить метаинформацию любого ресурса внутри неё.
offset – отступ от начала списка вложенных ресурсов
limit – максимальное количество элементов списка вложенных ресурсов
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, разрешить обрезку превью
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_public_resources(**kwargs) PublicResourcesListObject [исходный код]
Получает список публичных ресурсов.
- Параметры:
offset – отступ от начала списка
limit – максимальное число элементов в списке
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
type – фильтр по типу ресурса («file» или «dir»)
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_public_type(public_key: str, /, **kwargs) str [исходный код]
Получает тип публичного ресурса.
- Параметры:
public_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- get_session(token: str | None = None) SessionWithHeaders [исходный код]
То же, что и
YaDisk.make_session
, использует кэш.- Результат:
aiohttp.ClientSession
, отдельные объекты для разных потоков
- async get_token(code: str, /, **kwargs) TokenObject [исходный код]
Получает новый токен.
- Параметры:
code – код подтверждения
device_id – уникальный идентификатор устройства (между 6 и 50 символами)
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
BadRequestError – неправильный или истекший код, идентификатор или пароль приложения
- Результат:
- async get_trash_meta(path: str, /, **kwargs) TrashResourceObject [исходный код]
Получает мета-информацию о ресурсе корзины.
- Параметры:
path – путь к ресурсу корзины
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_trash_type(path: str, /, **kwargs) str [исходный код]
Получает тип ресурса корзины.
- Параметры:
path – путь к ресурсу корзины
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- async get_type(path: str, /, **kwargs) str [исходный код]
Получает тип ресурса
- Параметры:
path – путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- async get_upload_link(path: str, /, **kwargs) str [исходный код]
Получает ссылку для загрузки файла на диск при помощи PUT запроса.
- Параметры:
path – путь назначения
overwrite – bool, определяет, перезаписывать путь назначения или нет
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
str
- async is_dir(path: str, /, **kwargs) bool [исходный код]
Проверяет, является ли path папкой.
- Параметры:
path – путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_file(path: str, /, **kwargs) bool [исходный код]
Проверяет, является ли path файлом.
- Параметры:
path – путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)
- async is_public_dir(public_key: str, /, **kwargs) bool [исходный код]
Проверяет, является ли public_key публичной папкой.
- Параметры:
public_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если public_key является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_public_file(public_key: str, /, **kwargs) bool [исходный код]
Проверяет, является ли public_key публичным файлом.
- Параметры:
public_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если public_key является файлом, False, в остальных случаях (даже если ресурс не существует)
- async is_trash_dir(path: str, /, **kwargs) bool [исходный код]
Проверяет, является ли path папкой в корзине.
- Параметры:
path – путь к ресурсу корзины
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_trash_file(path: str, /, **kwargs) bool [исходный код]
Проверяет, является ли path файлом в корзине.
- Параметры:
path – путь к ресурсу корзины
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async listdir(path: str, /, **kwargs) AsyncGenerator[ResourceObject, None] [исходный код]
Получает содержимое path.
- Параметры:
path – путь к папке
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
ResourceObject
- make_session(token: str | None = None) SessionWithHeaders [исходный код]
Готовит объект
aiohttp.ClientSession
с заголовками, необходимыми для API.- Параметры:
token – токен, то же самое, что self.token, если None
- Результат:
aiohttp.ClientSession
- async mkdir(path: str, /, **kwargs) ResourceLinkObject [исходный код]
Создаёт новую папку.
- Параметры:
path – путь к папке, подлежащей созданию
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
DirectoryExistsError – путь назначения уже существует
InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async move(src_path: str, dst_path: str, /, **kwargs) OperationLinkObject | ResourceLinkObject [исходный код]
Перемещает src_path в dst_path.
- Параметры:
src_path – исходный путь, подлежащий перемещению
dst_path – путь назначения
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async patch(path: str, properties: dict, /, **kwargs) ResourceObject [исходный код]
Обновляет пользовательские свойства ресурса.
- Параметры:
path – путь к ресурсу
properties – dict, новые пользовательские свойства ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async public_exists(public_key: str, /, **kwargs) bool [исходный код]
Проверяет, существует ли публичный ресурс.
- Параметры:
public_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- async public_listdir(public_key: str, /, **kwargs) AsyncGenerator[PublicResourceObject, None] [исходный код]
Получает содержимое публичной папки.
- Параметры:
public_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу в публичной папке. Указывая ключ опубликованной папки через public_key, вы можете запросить содержимое любой вложенной папки.
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
PublicResourceObject
- async publish(path: str, /, **kwargs) ResourceLinkObject [исходный код]
Делает ресурс публичным.
- Параметры:
path – путь к публикуемому ресурсу
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на ресурс
- async refresh_token(refresh_token: str, /, **kwargs) TokenObject [исходный код]
Обновляет существующий токен.
- Параметры:
refresh_token – refresh-токен, полученный вместе с токеном
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
BadRequestError – неправильный или истекший refresh-токен, идентификатор или пароль приложения
- Результат:
- async remove(path: str, /, **kwargs) OperationLinkObject | None [исходный код]
Удаляет ресурс.
- Параметры:
path – путь к удаляемому ресурсу
permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
md5 – str, MD5 хэш файла, подлежащего удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
BadRequestError – проверка MD5 доступна только для файлов
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
OperationLinkObject
, если операция выполняется асинхронно, иначе None
- async remove_trash(path: str, /, **kwargs) OperationLinkObject | None [исходный код]
Удаляет ресурс корзины.
- Параметры:
path – путь к ресурсу корзины, подлежащий удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
OperationLinkObject
, если операция выполняется асинхронно, иначе None
- async rename(src_path: str, new_name: str, /, **kwargs) ResourceLinkObject | OperationLinkObject [исходный код]
Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.
- Параметры:
src_path – исходный путь, подлежащий перемещению
new_name – новое имя файла, в которое следует переименовать ресурс
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
ValueError – new_name не является допустимым именем файла
- Результат:
- async restore_trash(path: str, dst_path: str | None = None, /, **kwargs) ResourceLinkObject | OperationLinkObject [исходный код]
Восстанавливает ресурс корзины. Возвращает ссылку на новый ресурс или ссылку на асинхронную операцию.
- Параметры:
path – путь к восстанавливаему ресурсу
dst_path – путь назначения
overwrite – bool, определяет может ли путь назначения быть перезаписан
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async revoke_token(token: str | None = None, /, **kwargs) TokenRevokeStatusObject [исходный код]
Отзывает токен.
- Параметры:
token – токен, подлежащий отзыву, то же самое, что self.token, если None
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
BadRequestError – токен не может быть отозван (например, если не привязан к данному приложению)
- Результат:
- async save_to_disk(public_key: str, /, **kwargs) ResourceLinkObject | OperationLinkObject [исходный код]
Сохраняет публичный ресурс на диск. Возвращает ссылку на операцию, если сохранение выполняется асинхронно, или возвращает ссылку на ресурс.
- Параметры:
public_key – публичный ключ или URL к ресурсу
name – имя файла/папки, под которым будет сохранён ресурс
path – путь к копируемому ресурсу в публичной папке
save_path – путь к папке назначения (загрузки по умолчанию)
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
- async trash_exists(path: str, /, **kwargs) bool [исходный код]
Проверяет, существует ли path в корзине.
- Параметры:
path – путь к ресурсу корзины
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- async trash_listdir(path: str, /, **kwargs) AsyncGenerator[TrashResourceObject, None] [исходный код]
Получает содержимое папки в корзине.
- Параметры:
path – путь к папке в корзине
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
TrashResourceObject
- async unpublish(path: str, /, **kwargs) ResourceLinkObject [исходный код]
Делает публичный ресурс приватным.
- Параметры:
path – путь к ресурсу, подлежащему депубликации
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async upload(path_or_file: str | bytes | IO | AsyncFileLike | Callable[[], AsyncIterable[bytes]], dst_path: str, /, **kwargs) ResourceLinkObject [исходный код]
Загружает файл на диск.
- Параметры:
path_or_file – путь к файлу, файл-подобный объект или функция, возвращающая асинхронный генератор для загрузки
dst_path – путь назначения
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
ResourceLinkObject
, ссылка на загруженный ресурс
- async upload_by_link(file_or_path: str | bytes | IO | AsyncFileLike | Callable[[], AsyncIterable[bytes]], link: str, /, **kwargs) None [исходный код]
Загружает файл на диск по уже полученной ссылке.
- Параметры:
file_or_path – путь к файлу, файл-подобный объект или функция, возвращающая асинхронный генератор для загрузки
link – ссылка для загрузки файла
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
- async upload_url(url: str, path: str, /, **kwargs) OperationLinkObject [исходный код]
Загружает файл на диск по URL.
- Параметры:
url – исходный URL
path – путь назначения
disable_redirects – bool, запретить делать перенаправления
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
OperationLinkObject
, ссылка на асинхронную операцию
Общие параметры
Почти все методы YaDisk (те, которые принимают **kwargs) принимают некоторые дополнительные параметры:
n_retries - int, максимальное число повторных попыток запроса
retry_interval - float, задержка между повторными попытками (в секундах)
headers - dict или None, дополнительные заголовки запроса
Параметры aiohttp, такие как timeout, proxies и подобные так же принимаются (см. aiohttp.client.request()
).
Это так же применяется для низкоуровневых функций и объектов запросов API.
Настройки
Следующие настройки в модуле yadisk_async.settings могут быть получены и изменены:
DEFAULT_TIMEOUT -
aiohttp.ClientTimeout
, таймаут для запросов по умолчанию.DEFAULT_N_RETRIES - int, максимальное число повторных попыток запроса по умолчанию
DEFAULT_RETRY_INTERVAL - float, стандартная задержка между повторными попытками
DEFAULT_UPLOAD_TIMEOUT - аналогично DEFAULT_TIMEOUT, но для функции upload
DEFAULT_UPLOAD_RETRY_INTERVAL - аналогично DEFAULT_RETRY_INTERVAL, но для функции upload
Исключения
Кроме исключений, перечисленных ниже, запросы к API могут также вызвать исключения aiohttp.
- exception yadisk_async.exceptions.BadGatewayError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
RetriableYaDiskError
Вызывается, когда сервер вернул код 502.
- exception yadisk_async.exceptions.BadRequestError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 400.
- exception yadisk_async.exceptions.ConflictError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 409.
- exception yadisk_async.exceptions.DirectoryExistsError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
PathExistsError
Вызывается, когда папка уже существует.
- exception yadisk_async.exceptions.FieldValidationError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
BadRequestError
Вызывается, когда запрос содежит поля с некорректными данными.
- exception yadisk_async.exceptions.ForbiddenError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 403.
- exception yadisk_async.exceptions.GatewayTimeoutError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
RetriableYaDiskError
Вызывается, когда сервер вернул код 504.
- exception yadisk_async.exceptions.InsufficientStorageError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 507.
- exception yadisk_async.exceptions.InternalServerError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
RetriableYaDiskError
Вызывается, когда сервер вернул код 500.
- exception yadisk_async.exceptions.InvalidResponseError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда Яндекс.Диск не вернул JSON ответ или он неправильный.
- exception yadisk_async.exceptions.LockedError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 423.
- exception yadisk_async.exceptions.MD5DifferError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
ConflictError
Вызывается, когда MD5 хэш удаляемого ресурса не совпадает с указанным.
- exception yadisk_async.exceptions.NotAcceptableError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 406.
- exception yadisk_async.exceptions.NotFoundError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 404.
- exception yadisk_async.exceptions.OperationNotFoundError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
NotFoundError
Вызывается, когда операция, переденная get_operation_status() не существует.
- exception yadisk_async.exceptions.ParentNotFoundError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
ConflictError
Вызывается mkdir, upload и т.д. когда родительская папка не существует.
- exception yadisk_async.exceptions.PathExistsError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
ConflictError
Вызывается, когда запрашиваемый путь уже существует.
- exception yadisk_async.exceptions.PathNotFoundError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
NotFoundError
Вызывается, когда запрашиваемый путь не существует.
- exception yadisk_async.exceptions.PayloadTooLargeError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 413.
- exception yadisk_async.exceptions.ResourceIsLockedError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
LockedError
Вызывается, когда запрашиваемый ресурс заблокирован другой операцией.
- exception yadisk_async.exceptions.RetriableYaDiskError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается в случае, если произошла ошибка, но имеет смысл повторить запрос.
- exception yadisk_async.exceptions.TooManyRequestsError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 429.
- exception yadisk_async.exceptions.UnauthorizedError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 401.
Базовые классы:
RetriableYaDiskError
Вызывается, когда сервер вернул код 503.
- exception yadisk_async.exceptions.UnknownYaDiskError(msg='', response=None)[исходный код]
Базовые классы:
RetriableYaDiskError
Вызывается, когда запрос не удался, но не содержит информации об ошибке.
- exception yadisk_async.exceptions.UnsupportedMediaError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда сервер вернул код 415.
- exception yadisk_async.exceptions.UploadTrafficLimitExceededError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
LockedError
Вызывается, когда превышен лимит на загрузку файлов.
- exception yadisk_async.exceptions.WrongResourceTypeError(msg='')[исходный код]
Базовые классы:
YaDiskError
Вызывается, когда ожидался ресурс другого типа (например, файл вместо папки).
- exception yadisk_async.exceptions.YaDiskError(error_type=None, msg='', response=None)[исходный код]
Базовые классы:
Exception
Базовый класс для всех исключений в этой библиотеке.
- Переменные:
error_type – str, уникальный код ошибки, полученный от API
response – объект
aiohttp.ClientResponse
- Параметры:
error_type – str, уникальный код ошибки, полученный от API
msg – str, сообщение исключения
response – объект
aiohttp.ClientResponse
Объекты
- class yadisk_async.objects.YaDiskObject(field_types: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовый класс для всех объектов, реализующий объекты, возвращаемые REST API Яндекс.Диска. У наследующего объекта фиксированное количество полей, каждое со своим типом. Поддерживает доступ по индексу и через точку.
- Параметры:
field_types – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- import_fields(source_dict: dict | None) None [исходный код]
Задаёт значения всех полей объекта из source_dict. Все остальные ключи игнорируются.
- Параметры:
source_dict – dict или None (тогда ничего не будет сделано)
- remove_alias(alias: str) None [исходный код]
Удаляет псевдоним.
- Параметры:
alias – str
- remove_field(field: str) None [исходный код]
Удаляет поле.
- Параметры:
field – str
- set_alias(alias: str, name: str) None [исходный код]
Задаёт псевдоним.
- Параметры:
alias – str, псевдоним
name – str, имя поля
- set_field_type(field: str, type: Callable) None [исходный код]
Задаёт тип поля.
- Параметры:
field – str
type – тип данных или factory
- set_field_types(field_types: dict) None [исходный код]
Задаёт типы полей объекта
- Параметры:
field_types – dict, где ключи - это наименования полей, а значения - это типы
- class yadisk_async.objects.ErrorObject(error=None)[исходный код]
Базовые классы:
YaDiskObject
Реализует объект ошибки REST API Яндекс.Диска.
- Параметры:
error – dict или None
- Переменные:
message – str, человеко-читаемое сообщение ошибки
description – str, техническое описание ошибки
error – str, уникальный код ошибки
- class yadisk_async.objects.auth.TokenObject(token: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Объект токена.
- Параметры:
token – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
access_token – str, строка токена
refresh_token – str, refresh-токен
token_type – str, тип токена
expires_in – int, количество времени, на которое выдаётся токен
- class yadisk_async.objects.auth.TokenRevokeStatusObject(token_revoke_status: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Результат запроса по отзыву токена.
- Параметры:
token_revoke_status – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
status – str, статус операции
- class yadisk_async.objects.disk.DiskInfoObject(disk_info: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Объект информации о диске.
- Параметры:
disk_info – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
max_file_size – int, максимальный поддерживаемый размер файла (в байтах)
paid_max_file_size – int, максимальный поддерживаемый размер файла для платного аккаунта (в байтах)
unlimited_autoupload_enabled – bool, признак включенной безлимитной автозагрузки с мобильных устройств
total_space – int, общий размер диска (в байтах)
trash_size – int, размер, занятый мусором (в байтах), чась used_space
is_paid – bool, признак платного аккаунта
used_space – int, количество занятого места (в байтах)
system_folders –
SystemFoldersObject
, пути к системным папкамuser –
UserObject
, владелец дискаrevision – int, текущая ревизия Яндекс.Диска
- class yadisk_async.objects.disk.SystemFoldersObject(system_folders: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Объект, содержащий пути к системным папкам.
- Параметры:
system_folders – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
odnoklassniki – str, путь к папке Одноклассников
google – str, путь к папке Google+
instagram – str, путь к папке Instagram
vkontakte – str, путь к папке ВКонтакте
attach – str, путь к папке «Почтовые вложения»
mailru – str, путь к папке Моего Мира
downloads – str, путь к папке «Загрузки»
applications – str, путь к папке «Приложения»
facebook – str, путь к папке Facebook
social – str, путь к папке социальных сетей
messenger – str, путь к папке «Файлы Мессенджера»
calendar – str, путь к папке «Материалы встреч»
photostream – str, путь к папке фотокамеры
screenshots – str, путь к папке скриншотов
scans – str, путь к папке «Сканы»
- class yadisk_async.objects.disk.UserObject(user: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Объект пользователя.
- Параметры:
user – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
country – str, страна пользователя
login – str, логин пользователя
display_name – str, отображаемое имя пользователя
uid – str, уникальный идентификатор пользователя
- class yadisk_async.objects.disk.UserPublicInfoObject(public_user_info: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
UserObject
Публичная информация о пользователе. Наследуется от
UserObject
для совместимости.- Параметры:
public_user_info – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
login – str, логин пользователя
display_name – str, отображаемое имя пользователя
uid – str, уникальный идентификатор пользователя
- class yadisk_async.objects.resources.CommentIDsObject(comment_ids: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Список идентификаторов комментариев.
- Параметры:
comment_ids – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
private_resource – str, идентификатор комментария для приватных ресурсов
public_resource – str, идентификатор комментария для публичных ресурсов
- class yadisk_async.objects.resources.EXIFObject(exif: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Объект метаданных EXIF.
- Параметры:
exif – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
date_time –
datetime.datetime
, дата съёмки
- class yadisk_async.objects.resources.FilesResourceListObject(files_resource_list: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Плоский список файлов.
- Параметры:
files_resource_list – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
items – list, плоский список файлов (
ResourceObject
)limit – int, максимальное число элементов в списке
offset – int, отступ от начала списка
- class yadisk_async.objects.resources.LastUploadedResourceListObject(last_uploaded_resources_list: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Список последних загруженных файлов.
- Параметры:
last_uploaded_resources_list – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
items – list, список ресурсов (
ResourceObject
)limit – int, максимальное число элементов в списке
- class yadisk_async.objects.resources.LinkObject(link: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Объект ссылки.
- Параметры:
link – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
href – str, URL ссылки
method – str, HTTP метод
templated – bool, признак шаблонизированного URL
- class yadisk_async.objects.resources.OperationLinkObject(link: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
LinkObject
Объект ссылки на операцию.
- Параметры:
link – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
href – str, URL ссылки
method – str, HTTP метод
templated – bool, признак шаблонизированного URL
- async get_status(**kwargs) str [исходный код]
Получает статус операции.
- Параметры:
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
OperationNotFoundError – указанная операция не найдена
- Результат:
str
- class yadisk_async.objects.resources.PublicResourceLinkObject(link: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
LinkObject
,ResourceObjectMethodsMixin
Объект ссылки на публичный ресурс.
- Параметры:
link – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
href – str, URL ссылки
method – str, HTTP метод
templated – bool, признак шаблонизированного URL
public_key – str, публичный ключ к ресурсу
public_url – str, публичный URL ресурса
- async copy(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.
Данный метод принимает 1 или 2 позиционных аргумента:
copy(dst_path, /, **kwargs)
copy(relative_path, dst_path, /, **kwargs)
- Параметры:
src_path – str or None, исходный путь, относительно ресурса
dst_path – путь назначения
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
- async download(*args, **kwargs) ResourceLinkObject
Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:
download(dst_path_or_file, /, **kwargs)
download(relative_path, dst_path_or_file, /, **kwargs)
Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.
- Параметры:
relative_path – str or None, исходный путь, относительно ресурса
dst_path_or_file – путь назначения или файл-подобный объект
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на исходный ресурс
- async exists(relative_path: str | None = None, /, **kwargs) bool
Проверяет, существует ли ресурс.
- Параметры:
relative_path – str или None, относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- async get_download_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку на скачивание файла (или папки).
- Параметры:
relative_path – str или None, относительный путь от ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
str
- async get_meta(relative_path: str | None = None, /, **kwargs) ResourceObject
Получает мета-информацию о ресурсе.
- Параметры:
relative_path – str или None, относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_public_meta(**kwargs) PublicResourceObject
Получает мета-информацию о публичном ресурсе.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки.
offset – отступ от начала списка вложенных ресурсов
limit – максимальное количество элементов списка вложенных ресурсов
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, разрешить обрезку превью
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_type(relative_path: str | None = None, /, **kwargs) str
Получает тип ресурса
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- async get_upload_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку для загрузки файла на диск при помощи PUT запроса.
- Параметры:
relative_path – str или None, относительный путь от ресурса
overwrite – bool, определяет, перезаписывать путь назначения или нет
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
str
- async is_dir(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс папкой.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_file(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс файлом.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)
- async listdir(relative_path: str | None = None, /, **kwargs) AsyncGenerator[ResourceObject, None]
Получает содержимое папки.
- Параметры:
relative_path – относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
ResourceObject
- async mkdir(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Создаёт новую папку.
- Параметры:
relative_path – str или None, относительный путь к папке, подлежащей созданию
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
DirectoryExistsError – путь назначения уже существует
InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async move(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:
move(dst_path, /, **kwargs)
move(relative_path, dst_path, /, **kwargs)
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению
dst_path – путь назначения
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async patch(*args, **kwargs) ResourceObject
Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:
patch(properties, /, **kwargs)
patch(relative_path, properties, /, **kwargs)
- Параметры:
relative_path – str или None, относительный путь от ресурса
properties – dict, новые пользовательские свойства ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async public_listdir(**kwargs) AsyncGenerator[PublicResourceObject, None]
Получает содержимое публичной папки.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
PublicResourceObject
- async publish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает ресурс публичным.
- Параметры:
relative_path – str или None, относительный путь к публикуемому ресурсу
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на ресурс
- async remove(relative_path: str | None = None, /, **kwargs) OperationLinkObject | None
Удаляет ресурс.
- Параметры:
relative_path – str или None, относительный путь к удаляемому ресурсу
permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
md5 – str, MD5 хэш файла, подлежащего удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
BadRequestError – проверка MD5 доступна только для файлов
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
OperationLinkObject
, если операция выполняется асинхронно, иначе None
- async rename(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию
new_name – новое имя файла, в которое следует переименовать ресурс
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
ValueError – new_name не является допустимым именем файла
- Результат:
- async unpublish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает публичный ресурс приватным.
- Параметры:
relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async upload(path_or_file: str | bytes | IO | AsyncFileLike | Callable[[], AsyncIterable[bytes]], relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Загружает файл на диск.
- Параметры:
path_or_file – путь к файлу, файл-подобный объект или функция, возвращающая асинхронный генератор для загрузки
relative_path – str или None, путь назначения относительно ресурса
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
ResourceLinkObject
, ссылка на загруженный ресурс
- async upload_url(url: str, relative_path: str | None = None, /, **kwargs) OperationLinkObject
Загружает файл на диск по URL.
- Параметры:
url – исходный URL
relative_path – str или None, путь назначения относительно ресурса
disable_redirects – bool, запретить делать перенаправления
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
OperationLinkObject
, ссылка на асинхронную операцию
- class yadisk_async.objects.resources.PublicResourceListObject(public_resource_list: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
ResourceListObject
Список публичных ресурсов.
- Параметры:
public_resource_list – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
sort – str, тип сортировки
items – list, список ресурсов (
ResourceObject
)limit – int, максимальное число элементов в списке
offset – int, отступ от начала списка
path – str, путь к папке, содержащей элементы списка
total – int, количество элементов списка
public_key – str, публичный ключ к ресурсу
- class yadisk_async.objects.resources.PublicResourceObject(public_resource=None, yadisk=None)[исходный код]
Базовые классы:
ResourceObject
Объект публичного ресурса.
- Параметры:
resource – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
antivirus_status – str, статус проверки антивирусом
file – str, URL для скачивания файла
size – int, размер файла
public_key – str, публичный ключ
sha256 – str, SHA256 хэш
md5 – str, MD5 хэш
embedded –
PublicResourceObject
, список вложенных ресурсовname – str, имя файла
exif –
EXIFObject
, метаданные EXIFresource_id – str, идентификатор ресурса
custom_properties – dict, пользовательские свойства ресурса
public_url – str, публичный URL
share –
ShareInfoObject
, информация об общей папкеmodified –
datetime.datetime
, дата последнего измененияcreated –
datetime.datetime
, дата созданияphotoslice_time –
datetime.datetime
, дата создания фото/видеоmime_type – str, MIME-тип
path – str, путь к ресурсу
preview – str, URL превью файла
comment_ids –
CommentIDsObject
, идентификаторы комментариевtype – str, тип («file» или «dir»)
media_type – str, тип файла, согласно Яндекс.Диску
revision – int, ревизия Яндекс.Диска на момент последнего изменения
view_count – int, количество просмотров публичного ресурса
owner –
UserPublicInfoObject
, владелец публичного ресурса
- async copy(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.
Данный метод принимает 1 или 2 позиционных аргумента:
copy(dst_path, /, **kwargs)
copy(relative_path, dst_path, /, **kwargs)
- Параметры:
src_path – str or None, исходный путь, относительно ресурса
dst_path – путь назначения
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
- async download(*args, **kwargs) ResourceLinkObject
Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:
download(dst_path_or_file, /, **kwargs)
download(relative_path, dst_path_or_file, /, **kwargs)
Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.
- Параметры:
relative_path – str or None, исходный путь, относительно ресурса
dst_path_or_file – путь назначения или файл-подобный объект
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на исходный ресурс
- async exists(relative_path: str | None = None, /, **kwargs) bool
Проверяет, существует ли ресурс.
- Параметры:
relative_path – str или None, относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- async get_download_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку на скачивание файла (или папки).
- Параметры:
relative_path – str или None, относительный путь от ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
str
- async get_meta(relative_path: str | None = None, /, **kwargs) ResourceObject
Получает мета-информацию о ресурсе.
- Параметры:
relative_path – str или None, относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_public_meta(**kwargs) PublicResourceObject
Получает мета-информацию о публичном ресурсе.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки.
offset – отступ от начала списка вложенных ресурсов
limit – максимальное количество элементов списка вложенных ресурсов
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, разрешить обрезку превью
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_type(relative_path: str | None = None, /, **kwargs) str
Получает тип ресурса
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- async get_upload_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку для загрузки файла на диск при помощи PUT запроса.
- Параметры:
relative_path – str или None, относительный путь от ресурса
overwrite – bool, определяет, перезаписывать путь назначения или нет
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
str
- async is_dir(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс папкой.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_file(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс файлом.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)
- async listdir(relative_path: str | None = None, /, **kwargs) AsyncGenerator[ResourceObject, None]
Получает содержимое папки.
- Параметры:
relative_path – относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
ResourceObject
- async mkdir(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Создаёт новую папку.
- Параметры:
relative_path – str или None, относительный путь к папке, подлежащей созданию
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
DirectoryExistsError – путь назначения уже существует
InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async move(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:
move(dst_path, /, **kwargs)
move(relative_path, dst_path, /, **kwargs)
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению
dst_path – путь назначения
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async patch(*args, **kwargs) ResourceObject
Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:
patch(properties, /, **kwargs)
patch(relative_path, properties, /, **kwargs)
- Параметры:
relative_path – str или None, относительный путь от ресурса
properties – dict, новые пользовательские свойства ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async public_listdir(**kwargs) AsyncGenerator[PublicResourceObject, None]
Получает содержимое публичной папки.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
PublicResourceObject
- async publish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает ресурс публичным.
- Параметры:
relative_path – str или None, относительный путь к публикуемому ресурсу
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на ресурс
- async remove(relative_path: str | None = None, /, **kwargs) OperationLinkObject | None
Удаляет ресурс.
- Параметры:
relative_path – str или None, относительный путь к удаляемому ресурсу
permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
md5 – str, MD5 хэш файла, подлежащего удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
BadRequestError – проверка MD5 доступна только для файлов
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
OperationLinkObject
, если операция выполняется асинхронно, иначе None
- async rename(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию
new_name – новое имя файла, в которое следует переименовать ресурс
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
ValueError – new_name не является допустимым именем файла
- Результат:
- async unpublish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает публичный ресурс приватным.
- Параметры:
relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async upload(path_or_file: str | bytes | IO | AsyncFileLike | Callable[[], AsyncIterable[bytes]], relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Загружает файл на диск.
- Параметры:
path_or_file – путь к файлу, файл-подобный объект или функция, возвращающая асинхронный генератор для загрузки
relative_path – str или None, путь назначения относительно ресурса
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
ResourceLinkObject
, ссылка на загруженный ресурс
- async upload_url(url: str, relative_path: str | None = None, /, **kwargs) OperationLinkObject
Загружает файл на диск по URL.
- Параметры:
url – исходный URL
relative_path – str или None, путь назначения относительно ресурса
disable_redirects – bool, запретить делать перенаправления
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
OperationLinkObject
, ссылка на асинхронную операцию
- class yadisk_async.objects.resources.PublicResourcesListObject(public_resources_list: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Список публичных ресурсов.
- Параметры:
public_resources_list – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
items – list, список публичных ресурсов (
PublicResourceObject
)type – str, тип ресурса по которому фильтровать
limit – int, максимальное число элементов в списке
offset – int, отступ от начала списка
- class yadisk_async.objects.resources.ResourceDownloadLinkObject(link: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
LinkObject
Ссылка для скачивания ресурса.
- Параметры:
link – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
href – str, URL ссылки
method – str, HTTP метод
templated – bool, признак шаблонизированного URL
- class yadisk_async.objects.resources.ResourceLinkObject(link: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
LinkObject
,ResourceObjectMethodsMixin
Объект ссылки на ресурс.
- Параметры:
link – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
href – str, URL ссылки
method – str, HTTP метод
templated – bool, признак шаблонизированного URL
path – str, путь к ресурсу
- async copy(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.
Данный метод принимает 1 или 2 позиционных аргумента:
copy(dst_path, /, **kwargs)
copy(relative_path, dst_path, /, **kwargs)
- Параметры:
src_path – str or None, исходный путь, относительно ресурса
dst_path – путь назначения
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
- async download(*args, **kwargs) ResourceLinkObject
Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:
download(dst_path_or_file, /, **kwargs)
download(relative_path, dst_path_or_file, /, **kwargs)
Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.
- Параметры:
relative_path – str or None, исходный путь, относительно ресурса
dst_path_or_file – путь назначения или файл-подобный объект
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на исходный ресурс
- async exists(relative_path: str | None = None, /, **kwargs) bool
Проверяет, существует ли ресурс.
- Параметры:
relative_path – str или None, относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- async get_download_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку на скачивание файла (или папки).
- Параметры:
relative_path – str или None, относительный путь от ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
str
- async get_meta(relative_path: str | None = None, /, **kwargs) ResourceObject
Получает мета-информацию о ресурсе.
- Параметры:
relative_path – str или None, относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_public_meta(**kwargs) PublicResourceObject
Получает мета-информацию о публичном ресурсе.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки.
offset – отступ от начала списка вложенных ресурсов
limit – максимальное количество элементов списка вложенных ресурсов
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, разрешить обрезку превью
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_type(relative_path: str | None = None, /, **kwargs) str
Получает тип ресурса
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- async get_upload_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку для загрузки файла на диск при помощи PUT запроса.
- Параметры:
relative_path – str или None, относительный путь от ресурса
overwrite – bool, определяет, перезаписывать путь назначения или нет
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
str
- async is_dir(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс папкой.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_file(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс файлом.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)
- async listdir(relative_path: str | None = None, /, **kwargs) AsyncGenerator[ResourceObject, None]
Получает содержимое папки.
- Параметры:
relative_path – относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
ResourceObject
- async mkdir(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Создаёт новую папку.
- Параметры:
relative_path – str или None, относительный путь к папке, подлежащей созданию
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
DirectoryExistsError – путь назначения уже существует
InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async move(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:
move(dst_path, /, **kwargs)
move(relative_path, dst_path, /, **kwargs)
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению
dst_path – путь назначения
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async patch(*args, **kwargs) ResourceObject
Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:
patch(properties, /, **kwargs)
patch(relative_path, properties, /, **kwargs)
- Параметры:
relative_path – str или None, относительный путь от ресурса
properties – dict, новые пользовательские свойства ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async public_listdir(**kwargs) AsyncGenerator[PublicResourceObject, None]
Получает содержимое публичной папки.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
PublicResourceObject
- async publish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает ресурс публичным.
- Параметры:
relative_path – str или None, относительный путь к публикуемому ресурсу
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на ресурс
- async remove(relative_path: str | None = None, /, **kwargs) OperationLinkObject | None
Удаляет ресурс.
- Параметры:
relative_path – str или None, относительный путь к удаляемому ресурсу
permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
md5 – str, MD5 хэш файла, подлежащего удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
BadRequestError – проверка MD5 доступна только для файлов
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
OperationLinkObject
, если операция выполняется асинхронно, иначе None
- async rename(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию
new_name – новое имя файла, в которое следует переименовать ресурс
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
ValueError – new_name не является допустимым именем файла
- Результат:
- async unpublish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает публичный ресурс приватным.
- Параметры:
relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async upload(path_or_file: str | bytes | IO | AsyncFileLike | Callable[[], AsyncIterable[bytes]], relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Загружает файл на диск.
- Параметры:
path_or_file – путь к файлу, файл-подобный объект или функция, возвращающая асинхронный генератор для загрузки
relative_path – str или None, путь назначения относительно ресурса
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
ResourceLinkObject
, ссылка на загруженный ресурс
- async upload_url(url: str, relative_path: str | None = None, /, **kwargs) OperationLinkObject
Загружает файл на диск по URL.
- Параметры:
url – исходный URL
relative_path – str или None, путь назначения относительно ресурса
disable_redirects – bool, запретить делать перенаправления
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
OperationLinkObject
, ссылка на асинхронную операцию
- class yadisk_async.objects.resources.ResourceListObject(resource_list: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Список ресурсов.
- Параметры:
resource_list – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
sort – str, тип сортировки
items – list, список ресурсов (
ResourceObject
)limit – int, максимальное число элементов в списке
offset – int, отступ от начала списка
path – str, путь к папке, содержащей элементы списка
total – int, количество элементов списка
- class yadisk_async.objects.resources.ResourceObject(resource: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
,ResourceObjectMethodsMixin
Объект ресурса.
- Параметры:
resource – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
antivirus_status – str, статус проверки антивирусом
file – str, URL для скачивания файла
size – int, размер файла
public_key – str, публичный ключ
sha256 – str, SHA256 хэш
md5 – str, MD5 хэш
embedded –
ResourceListObject
, список вложенных ресурсовname – str, имя файла
exif –
EXIFObject
, метаданные EXIFresource_id – str, идентификатор ресурса
custom_properties – dict, пользовательские свойства ресурса
public_url – str, публичный URL
share –
ShareInfoObject
, информация об общей папкеmodified –
datetime.datetime
, дата последнего измененияcreated –
datetime.datetime
, дата созданияphotoslice_time –
datetime.datetime
, дата создания фото/видеоmime_type – str, MIME-тип
path – str, путь к ресурсу
preview – str, URL превью файла
comment_ids –
CommentIDsObject
, идентификаторы комментариевtype – str, тип («file» или «dir»)
media_type – str, тип файла, согласно Яндекс.Диску
revision – int, ревизия Яндекс.Диска на момент последнего изменения
- async copy(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.
Данный метод принимает 1 или 2 позиционных аргумента:
copy(dst_path, /, **kwargs)
copy(relative_path, dst_path, /, **kwargs)
- Параметры:
src_path – str or None, исходный путь, относительно ресурса
dst_path – путь назначения
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
- async download(*args, **kwargs) ResourceLinkObject
Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:
download(dst_path_or_file, /, **kwargs)
download(relative_path, dst_path_or_file, /, **kwargs)
Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.
- Параметры:
relative_path – str or None, исходный путь, относительно ресурса
dst_path_or_file – путь назначения или файл-подобный объект
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на исходный ресурс
- async exists(relative_path: str | None = None, /, **kwargs) bool
Проверяет, существует ли ресурс.
- Параметры:
relative_path – str или None, относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- async get_download_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку на скачивание файла (или папки).
- Параметры:
relative_path – str или None, относительный путь от ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
str
- async get_meta(relative_path: str | None = None, /, **kwargs) ResourceObject
Получает мета-информацию о ресурсе.
- Параметры:
relative_path – str или None, относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_public_meta(**kwargs) PublicResourceObject
Получает мета-информацию о публичном ресурсе.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки.
offset – отступ от начала списка вложенных ресурсов
limit – максимальное количество элементов списка вложенных ресурсов
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, разрешить обрезку превью
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_type(relative_path: str | None = None, /, **kwargs) str
Получает тип ресурса
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- async get_upload_link(relative_path: str | None = None, /, **kwargs) str
Получает ссылку для загрузки файла на диск при помощи PUT запроса.
- Параметры:
relative_path – str или None, относительный путь от ресурса
overwrite – bool, определяет, перезаписывать путь назначения или нет
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
str
- async is_dir(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс папкой.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_file(relative_path: str | None = None, /, **kwargs) bool
Проверяет, является ли ресурс файлом.
- Параметры:
relative_path – относительный путь от ресурса
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)
- async listdir(relative_path: str | None = None, /, **kwargs) AsyncGenerator[ResourceObject, None]
Получает содержимое папки.
- Параметры:
relative_path – относительный путь от ресурса
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
ResourceObject
- async mkdir(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Создаёт новую папку.
- Параметры:
relative_path – str или None, относительный путь к папке, подлежащей созданию
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
DirectoryExistsError – путь назначения уже существует
InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async move(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:
move(dst_path, /, **kwargs)
move(relative_path, dst_path, /, **kwargs)
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению
dst_path – путь назначения
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async patch(*args, **kwargs) ResourceObject
Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:
patch(properties, /, **kwargs)
patch(relative_path, properties, /, **kwargs)
- Параметры:
relative_path – str или None, относительный путь от ресурса
properties – dict, новые пользовательские свойства ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async public_listdir(**kwargs) AsyncGenerator[PublicResourceObject, None]
Получает содержимое публичной папки.
- Параметры:
path – относительный путь к ресурсу внутри публичной папки
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
PublicResourceObject
- async publish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает ресурс публичным.
- Параметры:
relative_path – str или None, относительный путь к публикуемому ресурсу
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
ResourceLinkObject
, ссылка на ресурс
- async remove(relative_path: str | None = None, /, **kwargs) OperationLinkObject | None
Удаляет ресурс.
- Параметры:
relative_path – str или None, относительный путь к удаляемому ресурсу
permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
md5 – str, MD5 хэш файла, подлежащего удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
BadRequestError – проверка MD5 доступна только для файлов
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
OperationLinkObject
, если операция выполняется асинхронно, иначе None
- async rename(*args, **kwargs) ResourceLinkObject | OperationLinkObject
Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.
- Параметры:
relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию
new_name – новое имя файла, в которое следует переименовать ресурс
overwrite – bool, определяет, перезаписывать путь назначения или нет
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
ValueError – new_name не является допустимым именем файла
- Результат:
- async unpublish(relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Делает публичный ресурс приватным.
- Параметры:
relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async upload(path_or_file: str | bytes | IO | AsyncFileLike | Callable[[], AsyncIterable[bytes]], relative_path: str | None = None, /, **kwargs) ResourceLinkObject
Загружает файл на диск.
- Параметры:
path_or_file – путь к файлу, файл-подобный объект или функция, возвращающая асинхронный генератор для загрузки
relative_path – str или None, путь назначения относительно ресурса
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
ResourceLinkObject
, ссылка на загруженный ресурс
- async upload_url(url: str, relative_path: str | None = None, /, **kwargs) OperationLinkObject
Загружает файл на диск по URL.
- Параметры:
url – исходный URL
relative_path – str или None, путь назначения относительно ресурса
disable_redirects – bool, запретить делать перенаправления
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ParentNotFoundError – родительская папка не существует
PathExistsError – путь назначения уже существует
InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов
- Результат:
OperationLinkObject
, ссылка на асинхронную операцию
- class yadisk_async.objects.resources.ResourceUploadLinkObject(resource_upload_link: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
LinkObject
Ссылка для загрузки файла.
- Параметры:
resource_upload_link – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
operation_id – str, идентификатор операции по загрузке файла
href – str, URL ссылки
method – str, HTTP метод
templated – bool, признак шаблонизированного URL
Базовые классы:
YaDiskObject
Объект информации об общей папке.
- Параметры:
share_info – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
is_root – bool, признак того, что папка является корневой
is_owned – bool, признак того, что пользователь является владельцем этой папки
rights – str, права доступа
- class yadisk_async.objects.resources.TrashResourceListObject(trash_resource_list: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
ResourceListObject
Список ресурсов корзины.
- Параметры:
trash_resource_list – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
sort – str, тип сортировки
items – list, список ресурсов (
TrashResourceObject
)limit – int, максимальное число элементов в списке
offset – int, отступ от начала списка
path – str, путь к папке, содержащей элементы списка
total – int, количество элементов списка
- class yadisk_async.objects.resources.TrashResourceObject(trash_resource: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
ResourceObject
Объект ресурса корзины.
- Параметры:
trash_resource – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
antivirus_status – str, статус проверки антивирусом
file – str, URL для скачивания файла
size – int, размер файла
public_key – str, публичный ключ
sha256 – str, SHA256 хэш
md5 – str, MD5 хэш
embedded –
ResourceListObject
, список вложенных ресурсовname – str, имя файла
exif –
EXIFObject
, метаданные EXIFresource_id – str, идентификатор ресурса
custom_properties – dict, пользовательские свойства ресурса
public_url – str, публичный URL
share –
ShareInfoObject
, информация об общей папкеmodified –
datetime.datetime
, дата последнего измененияcreated –
datetime.datetime
, дата созданияphotoslice_time –
datetime.datetime
, дата создания фото/видеоmime_type – str, MIME-тип
path – str, путь к ресурсу
preview – str, URL превью файла
comment_ids –
CommentIDsObject
, идентификаторы комментариевtype – str, тип («file» или «dir»)
media_type – str, тип файла, согласно Яндекс.Диску
revision – int, ревизия Яндекс.Диска на момент последнего изменения
origin_path – str, оригинальный путь
deleted –
datetime.datetime
, дата удаления
- async exists(relative_path: str | None = None, /, **kwargs) bool [исходный код]
Проверяет, существует ли ресурс в корзине.
- Параметры:
relative_path – str или None, относительный путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
bool
- async get_meta(relative_path: str | None = None, /, **kwargs) TrashResourceObject [исходный код]
Получает мета-информацию о ресурсе корзины.
- Параметры:
relative_path – str или None, относительный путь к ресурсу
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
- async get_type(relative_path: str | None = None, /, **kwargs) str [исходный код]
Получает тип ресурса корзины.
- Параметры:
relative_path – str или None, относительный путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
«file» или «dir»
- async is_dir(relative_path: str | None = None, /, **kwargs) bool [исходный код]
Проверяет, является ли ресурс папкой в корзине.
- Параметры:
relative_path – str или None, относительный путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)
- async is_file(relative_path: str | None = None, /, **kwargs) bool [исходный код]
Проверяет, является ли ресурс файлом в корзине.
- Параметры:
relative_path – str или None, относительный путь к ресурсу
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
- Результат:
True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)
- async listdir(relative_path: str | None = None, /, **kwargs) AsyncGenerator[TrashResourceObject, None] [исходный код]
Получает содержимое папки в корзине.
- Параметры:
relative_path – str или None, относительный путь к папке в корзине
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
WrongResourceTypeError – указанный ресурс не является папкой
- Результат:
генератор
TrashResourceObject
- async patch(*args, **kwargs)[исходный код]
Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:
patch(properties, /, **kwargs)
patch(relative_path, properties, /, **kwargs)
- Параметры:
relative_path – str или None, относительный путь от ресурса
properties – dict, новые пользовательские свойства ресурса
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- async remove(relative_path: str | None = None, /, **kwargs) OperationLinkObject | None [исходный код]
Удаляет ресурс корзины.
- Параметры:
relative_path – str или None, относительный путь к ресурсу корзины, подлежащий удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
OperationLinkObject
, если операция выполняется асинхронно, иначе None
- async restore(dst_path: str, /, **kwargs) ResourceLinkObject | OperationLinkObject [исходный код]
- async restore(relative_path: str | None, dst_path: str, /, **kwargs) ResourceLinkObject | OperationLinkObject
Восстанавливает ресурс корзины. Возвращает ссылку на новый ресурс или ссылку на асинхронную операцию.
Данный метод принимает 1 или 2 позиционных аргумента:
restore(dst_path, /, **kwargs)
restore(relative_path=None, dst_path, /, **kwargs)
- Параметры:
relative_path – str или None, относительный путь к восстанавливаему ресурсу
dst_path – путь назначения
overwrite – bool, определяет может ли путь назначения быть перезаписан
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
- Исключение:
PathNotFoundError – ресурс не был найден на Диске
PathExistsError – путь назначения уже существует
ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос
ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией
- Результат:
- class yadisk_async.objects.operations.OperationStatusObject(operation_status: dict | None = None, yadisk: YaDisk | None = None)[исходный код]
Базовые классы:
YaDiskObject
Объект статуса операции.
- Параметры:
operation_status – dict или None
yadisk –
YaDisk
или None, объект YaDisk
- Переменные:
type – str, тип операции
status – str, статус операции
operation_id – str, идентификатор операции
link –
LinkObject
, ссылка на операциюdata – dict, другая информация об операции
Низкоуровневый API
Вспомогательные средства
- async yadisk_async.utils.auto_retry(func: Callable[[], T | Awaitable[T]], n_retries: int | None = None, retry_interval: int | float | None = None) T [исходный код]
Выполняет запрос с автоматическими повторными попытками. Повторная попытка может быть вызвана
aiohttp.ClientError
илиRetriableYaDiskError
.- Параметры:
func – Функция, подлежащая исполнению, не должна требовать аргументов
n_retries – int, максимальное число повторных попыток запроса
retry_interval – int или float, задержка между повторными попытками в секундах
- Результат:
Значение, возвращаемое func()
- async yadisk_async.utils.get_exception(response: ClientResponse) YaDiskError [исходный код]
Возвращает объект исключения, основываясь на ответе (подразумевается, что запрос не удался).
- Параметры:
response – объект
aiohttp.ClientResponse
- Результат:
Объект исключения, подкласс
YaDiskError
Объекты запросов к API
- class yadisk_async.api.APIRequest(session: ClientSession, args: dict, **kwargs)[исходный код]
Базовый класс для всех объектов запросов к REST API.
- Параметры:
session – объект
aiohttp.ClientSession
args – dict, аргументы, которые будут перданы в process_args
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаheaders – dict или None, дополнительные заголовки запроса
n_retries – int, максимальное число повторных попыток запроса
retry_interval – задержка между повторными попытками в секундах
kwargs – другие аргументы для
aiohttp.ClientSession.request
- Переменные:
url – str, URL запроса
method – str, метод запроса
content_type – str, заголовок Content-Type («application/x-www-form-urlencoded» по умолчанию)
timeout – float или
aiohttp.ClientTimeout
, таймаут запросаn_retries – int, максимальное число повторных попыток запроса
success_codes – list-подобный, список кодов ответов, означающих успех запроса
retry_interval – float, задержка между повторными попытками в секундах
- async process(**kwargs) T [исходный код]
Обрабатывает ответ.
- Результат:
зависит от self.process_json()
- process_json(js: dict | None, **kwargs) T [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- async send() ClientResponse [исходный код]
Отправляет запрос
- Результат:
aiohttp.ClientResponse
(self.response)
- class yadisk_async.api.auth.GetTokenRequest(session: aiohttp.ClientSession, code: str, client_id: str, client_secret: str, device_id: str | None = None, device_name: str | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения токена.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиcode – код подтверждения
client_id – идентификатор приложения
client_secret – пароль приложения
device_id – уникальный идентификатор устройства (между 6 и 50 символами)
- Результат:
- process_json(js: dict | None) TokenObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.auth.RefreshTokenRequest(session: aiohttp.ClientSession, refresh_token: str, client_id: str, client_secret: str, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для обновления существующего токена.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиrefresh_token – refresh-токен, полученный вместе с токеном
client_id – идентификатор приложения
client_secret – пароль приложения
- Результат:
- process_json(js: dict | None) TokenObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.auth.RevokeTokenRequest(session: aiohttp.ClientSession, token: str, client_id: str, client_secret: str, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для отзыва токена.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиtoken – токен, подлежащий отзыву
client_id – идентификатор приложения
client_secret – пароль приложения
- Результат:
- process_json(js: dict | None) TokenRevokeStatusObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.disk.DiskInfoRequest(session: aiohttp.ClientSession, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения информации о диске.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиfields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None) DiskInfoObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.CopyRequest(session: aiohttp.ClientSession, src_path: str, dst_path: str, overwrite: bool = False, force_async: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос копирования файла или папки.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиsrc_path – исходный путь
dst_path – путь назначения
overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) OperationLinkObject | ResourceLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.DeleteRequest(session: aiohttp.ClientSession, path: str, permanently: bool = False, md5: str | None = None, force_async: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для удаления ресурса.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к удаляемому ресурсу
permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
force_async – заставляет выполнять операцию асинхронно
md5 – str, MD5 хэш файла, подлежащего удалению
fields – список ключей, которые будут включены в ответ
- Результат:
OperationLinkObject
или None
- process_json(js: dict | None, yadisk: YaDisk | None = None) OperationLinkObject | None [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.DeleteTrashRequest(session: aiohttp.ClientSession, path: str | None = None, force_async: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для удаления ресурса корзины.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к ресурсу корзины, подлежащий удалению
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
- Результат:
OperationLinkObject
или None
- process_json(js: dict | None, yadisk: YaDisk | None = None) OperationLinkObject | None [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.FilesRequest(session: aiohttp.ClientSession, offset: int = 0, limit: int = 20, media_type: str | Iterable[str] | None = None, preview_size: str | None = None, preview_crop: bool | None = None, sort: str | None = None, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения плоского списка всех файлов.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиoffset – отступ от начала списка
limit – максимальное количество элементов списка
media_type – тип файлов, которые будут включены в список
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) FilesResourceListObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.GetDownloadLinkRequest(session: aiohttp.ClientSession, path: str, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения ссылки на скачивание ресурса.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к скачиваемому ресурсу
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceDownloadLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.GetMetaRequest(session: aiohttp.ClientSession, path: str, limit: int | None = None, offset: int | None = None, preview_size: str | None = None, preview_crop: bool | None = None, sort: str | None = None, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получния мета-информации о ресурсе.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к ресурсу
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.GetPublicDownloadLinkRequest(session: aiohttp.ClientSession, public_key: str, path: str | None = None, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения ссылки на скачивание публичного ресурса.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpublic_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceDownloadLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.GetPublicMetaRequest(session: aiohttp.ClientSession, public_key: str, offset: int = 0, limit: int = 20, path: str | None = None, sort: str | None = None, preview_size: str | None = None, preview_crop: bool | None = None, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получния мета-информации о публичном ресурсе.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpublic_key – публичный ключ или URL к ресурсу
path – относительный путь к ресурсу внутри публичной папки. Указывая ключ опубликованной папки через public_key, вы можете запросить метаинформацию любого ресурса внутри неё.
offset – отступ от начала списка вложенных ресурсов
limit – максимальное количество элементов списка вложенных ресурсов
sort – str, поле использумое для сортировки вложенных ресурсов
preview_size – размер превью файла
preview_crop – bool, разрешить обрезку превью
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) PublicResourceObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.GetPublicResourcesRequest(session: aiohttp.ClientSession, offset: int = 0, limit: int = 20, preview_size: str | None = None, preview_crop: bool | None = None, type: str | None = None, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения списка публичных ресурсов.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиoffset – отступ от начала списка
limit – максимальное число элементов в списке
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
type – фильтр по типу ресурса («file» или «dir»)
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) PublicResourcesListObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.GetTrashRequest(session: aiohttp.ClientSession, path: str, offset: int = 0, limit: int = 20, sort: str | None = None, preview_size: str | None = None, preview_crop: bool | None = None, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получния мета-информации о ресурсе корзины.
- Параметры:
path – путь к ресурсу корзины
limit – количество ресурсов в папке, которые будут включены в ответ
offset – количество ресурсов в папке, которые будут пропущены
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
sort – str, поле использумое для сортировки вложенных ресурсов
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) TrashResourceObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.GetUploadLinkRequest(session: aiohttp.ClientSession, path: str, overwrite: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения ссылки для загрузки ресурса.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь назначения для загрузки файла
overwrite – bool, определяет, перезаписывать путь назначения или нет
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceUploadLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.LastUploadedRequest(session: aiohttp.ClientSession, limit: int = 20, media_type: str | Iterable[str] | None = None, preview_size: str | None = None, preview_crop: bool | None = None, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения списка последних загруженных файлов, отсортированного по дате загрузки.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиlimit – максимальное число элементов в списке
media_type – тип файлов, которые будут включены в список
preview_size – размер превью файла
preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) LastUploadedResourceListObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.MkdirRequest(session: aiohttp.ClientSession, path: str, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для создания новой папки.
- Параметры:
path – путь к папке, подлежащей созданию
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.MoveRequest(session: aiohttp.ClientSession, src_path: str, dst_path: str, force_async: bool = False, overwrite: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для перемещения ресурса.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиsrc_path – исходный путь, подлежащий перемещению
dst_path – путь назначения
force_async – заставляет выполнять операцию асинхронно
overwrite – bool, определяет, перезаписывать путь назначения или нет
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) OperationLinkObject | ResourceLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.PatchRequest(session: aiohttp.ClientSession, path: str, properties: dict, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для обновления пользовательских свойств ресурса.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к ресурсу
properties – dict, новые пользовательские свойства ресурса
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.PublishRequest(session: aiohttp.ClientSession, path: str, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для того, чтобы сделать ресурс публичным.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к публикуемому ресурсу
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.RestoreTrashRequest(session: aiohttp.ClientSession, path: str, dst_path: str | None = None, force_async: bool = False, overwrite: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для восстановления мусора.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к восстанавливаему ресурсу
dst_path – путь назначения
force_async – заставляет выполнять операцию асинхронно
overwrite – bool, определяет может ли путь назначения быть перезаписан
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) OperationLinkObject | ResourceLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.SaveToDiskRequest(session: aiohttp.ClientSession, public_key: str, name: str | None = None, path: str | None = None, save_path: str | None = None, force_async: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для сохранения публичного ресурса на диск.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpublic_key – публичный ключ или URL к ресурсу
name – имя файла/папки, под которым будет сохранён ресурс
path – путь к копируемому ресурсу в публичной папке
save_path – путь к папке назначения (загрузки по умолчанию)
force_async – заставляет выполнять операцию асинхронно
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) OperationLinkObject | ResourceLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.UnpublishRequest(session: aiohttp.ClientSession, path: str, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для того, чтобы сделать публичный ресурс приватным.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиpath – путь к ресурсу, подлежащему депубликации
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) ResourceLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.resources.UploadURLRequest(session: aiohttp.ClientSession, url: str, path: str, disable_redirects: bool = False, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для загрузки файла по URL.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиurl – исходный URL
path – путь назначения
disable_redirects – bool, запретить делать перенаправления
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None, yadisk: YaDisk | None = None) OperationLinkObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно
- class yadisk_async.api.operations.GetOperationStatusRequest(session: aiohttp.ClientSession, operation_id: str, fields: Iterable[str] | None = None, **kwargs)[исходный код]
Базовые классы:
APIRequest
Запрос для получения статуса операции.
- Параметры:
session – объект
aiohttp.ClientSession
с приготовленными заголовкамиoperation_id – идентификатор операции или ссылка на нее
fields – список ключей, которые будут включены в ответ
- Результат:
- process_json(js: dict | None) OperationStatusObject [исходный код]
Обрабатывает JSON ответ.
- Параметры:
js – dict, JSON ответ
kwargs – дополнительные аргументы (опциональные)
- Результат:
обработанный ответ, может быть что угодно