Объекты ответов сервера

class yadisk.objects.YaDiskObject(field_types: dict | None = None, yadisk: Any | 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.objects.ErrorObject(error=None, yadisk=None)

Базовые классы: YaDiskObject

Реализует объект ошибки REST API Яндекс.Диска.

Параметры:

• error – dict или None

• yadisk – YaDisk или None, объект YaDisk

Переменные:

• message – str, человеко-читаемое сообщение ошибки

• description – str, техническое описание ошибки

• error – str, уникальный код ошибки

class yadisk.objects.auth.DeviceCodeObject(device_code_object: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Результат Client.get_device_code() / AsyncClient.get_device_code().

Параметры:

• device_code_object – dict или None

• yadisk – YaDisk или None, объект YaDisk

Переменные:

• device_code – str, код устройства, который может быть использован для получения токена

• user_code – str, код, который пользователь должен ввести на странице OAuth

• verification_url – str, URL страницы OAuth, на которой пользователь должен ввести user_code

• interval – int, минимальный интервал времени (в секундах), с которым приложение должно запрашивать OAuth токен. Если запросы будут поступать чаще, Яндекс OAuth может вернуть ошибку

• expires_in – int, количество времени, после которого коды истекают

class yadisk.objects.auth.TokenObject(token: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Объект токена.

Параметры:

• token – dict или None

• yadisk – YaDisk или None, объект YaDisk

Переменные:

• access_token – str, строка токена

• refresh_token – str, refresh-токен

• token_type – str, тип токена

• expires_in – int, количество времени, на которое выдаётся токен

• scope – str, список прав, запрашиваемых приложением, возвращается только если токен обладает меньшим набором прав, чем было запрошено

class yadisk.objects.auth.TokenRevokeStatusObject(token_revoke_status: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Результат запроса по отзыву токена.

Параметры:

• token_revoke_status – dict или None

• yadisk – YaDisk или None, объект YaDisk

Переменные:

status – str, статус операции

class yadisk.objects.disk.DiskInfoObject(disk_info: dict | None = None, yadisk: Any | 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.objects.disk.SystemFoldersObject(system_folders: dict | None = None, yadisk: Any | 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.objects.disk.UserObject(user: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Объект пользователя.

Параметры:

• user – dict или None

• yadisk – YaDisk или None, объект YaDisk

Переменные:

• country – str, страна пользователя

• login – str, логин пользователя

• display_name – str, отображаемое имя пользователя

• uid – str, уникальный идентификатор пользователя

class yadisk.objects.disk.UserPublicInfoObject(public_user_info: dict | None = None, yadisk: Any | None = None)

Базовые классы: UserObject

Публичная информация о пользователе. Наследуется от UserObject для совместимости.

Параметры:

• public_user_info – dict или None

• yadisk – YaDisk или None, объект YaDisk

Переменные:

• login – str, логин пользователя

• display_name – str, отображаемое имя пользователя

• uid – str, уникальный идентификатор пользователя

class yadisk.objects.resources.AsyncFilesResourceListObject(files_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: FilesResourceListObject

Плоский список файлов.

Параметры:

• files_resource_list – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• items – list, плоский список файлов (AsyncResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

class yadisk.objects.resources.AsyncLastUploadedResourceListObject(last_uploaded_resources_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: LastUploadedResourceListObject

Список последних загруженных файлов.

Параметры:

• last_uploaded_resources_list – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• items – list, список ресурсов (AsyncResourceObject)

• limit – int, максимальное число элементов в списке

class yadisk.objects.resources.AsyncPublicResourceLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourceLinkObject, AsyncResourceObjectMethodsMixin

Объект ссылки на публичный ресурс.

Параметры:

• link – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

• public_key – str, публичный ключ к ресурсу

• public_url – str, публичный URL ресурса

async copy(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async download(*args, **kwargs) → AsyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на исходный ресурс

async exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

async get_meta(relative_path: str | None = None, /, **kwargs) → AsyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncResourceObject

async get_public_meta(**kwargs) → AsyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncPublicResourceObject

async get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

async listdir(relative_path: str | None = None, /, **kwargs) → AsyncGenerator[AsyncResourceObject, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncResourceObject

async mkdir(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject

async move(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async patch(*args, **kwargs) → AsyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceObject

async public_listdir(**kwargs) → AsyncGenerator[AsyncPublicResourceObject, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncPublicResourceObject

async publish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на ресурс

async remove(relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncOperationLinkObject, если операция выполняется асинхронно, иначе None

async rename(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async unpublish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

ResourceLinkObject

async upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject, ссылка на загруженный ресурс

async upload_url(url: str, relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.AsyncPublicResourceListObject(public_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourceListObject

Список публичных ресурсов.

Параметры:

• public_resource_list – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (AsyncResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

• public_key – str, публичный ключ к ресурсу

class yadisk.objects.resources.AsyncPublicResourceObject(public_resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourceObject, AsyncResourceObjectMethodsMixin

Объект публичного ресурса.

Параметры:

• resource – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• antivirus_status – str, статус проверки антивирусом

• file – str, URL для скачивания файла

• size – int, размер файла

• public_key – str, публичный ключ

• sha256 – str, SHA256 хэш

• md5 – str, MD5 хэш

• embedded – AsyncPublicResourceObject, список вложенных ресурсов

• name – str, имя файла

• exif – EXIFObject, метаданные EXIF

• resource_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) → AsyncResourceLinkObject | AsyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async download(*args, **kwargs) → AsyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на исходный ресурс

async exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

async get_meta(relative_path: str | None = None, /, **kwargs) → AsyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncResourceObject

async get_public_meta(**kwargs) → AsyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncPublicResourceObject

async get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

async listdir(relative_path: str | None = None, /, **kwargs) → AsyncGenerator[AsyncResourceObject, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncResourceObject

async mkdir(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject

async move(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async patch(*args, **kwargs) → AsyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceObject

async public_listdir(**kwargs) → AsyncGenerator[AsyncPublicResourceObject, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncPublicResourceObject

async publish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на ресурс

async remove(relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncOperationLinkObject, если операция выполняется асинхронно, иначе None

async rename(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async unpublish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

ResourceLinkObject

async upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject, ссылка на загруженный ресурс

async upload_url(url: str, relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.AsyncPublicResourcesListObject(public_resources_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourcesListObject

Список публичных ресурсов.

Параметры:

• public_resources_list – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• items – list, список публичных ресурсов (AsyncPublicResourceObject)

• type – str, тип ресурса по которому фильтровать

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

class yadisk.objects.resources.AsyncResourceLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceLinkObject, AsyncResourceObjectMethodsMixin

Объект ссылки на ресурс.

Параметры:

• link – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

• path – str, путь к ресурсу

async copy(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async download(*args, **kwargs) → AsyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на исходный ресурс

async exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

async get_meta(relative_path: str | None = None, /, **kwargs) → AsyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncResourceObject

async get_public_meta(**kwargs) → AsyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncPublicResourceObject

async get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

async listdir(relative_path: str | None = None, /, **kwargs) → AsyncGenerator[AsyncResourceObject, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncResourceObject

async mkdir(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject

async move(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async patch(*args, **kwargs) → AsyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceObject

async public_listdir(**kwargs) → AsyncGenerator[AsyncPublicResourceObject, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncPublicResourceObject

async publish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на ресурс

async remove(relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncOperationLinkObject, если операция выполняется асинхронно, иначе None

async rename(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async unpublish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

ResourceLinkObject

async upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject, ссылка на загруженный ресурс

async upload_url(url: str, relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.AsyncResourceListObject(resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceListObject

Список ресурсов.

Параметры:

• resource_list – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (AsyncResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

class yadisk.objects.resources.AsyncResourceObject(resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceObject, AsyncResourceObjectMethodsMixin

Объект ресурса.

Параметры:

• resource – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• antivirus_status – str, статус проверки антивирусом

• file – str, URL для скачивания файла

• size – int, размер файла

• public_key – str, публичный ключ

• sha256 – str, SHA256 хэш

• md5 – str, MD5 хэш

• embedded – AsyncResourceListObject, список вложенных ресурсов

• name – str, имя файла

• exif – EXIFObject, метаданные EXIF

• resource_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) → AsyncResourceLinkObject | AsyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async download(*args, **kwargs) → AsyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на исходный ресурс

async exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

async get_meta(relative_path: str | None = None, /, **kwargs) → AsyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncResourceObject

async get_public_meta(**kwargs) → AsyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncPublicResourceObject

async get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

async listdir(relative_path: str | None = None, /, **kwargs) → AsyncGenerator[AsyncResourceObject, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncResourceObject

async mkdir(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject

async move(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async patch(*args, **kwargs) → AsyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceObject

async public_listdir(**kwargs) → AsyncGenerator[AsyncPublicResourceObject, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncPublicResourceObject

async publish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject, ссылка на ресурс

async remove(relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncOperationLinkObject, если операция выполняется асинхронно, иначе None

async rename(*args, **kwargs) → AsyncResourceLinkObject | AsyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

async unpublish(relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

ResourceLinkObject

async upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → AsyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncResourceLinkObject, ссылка на загруженный ресурс

async upload_url(url: str, relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

AsyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.AsyncTrashResourceListObject(trash_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: TrashResourceListObject

Список ресурсов корзины.

Параметры:

• trash_resource_list – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (AsyncTrashResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

class yadisk.objects.resources.AsyncTrashResourceObject(trash_resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: TrashResourceObject

Объект ресурса корзины.

Параметры:

• trash_resource – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• antivirus_status – str, статус проверки антивирусом

• file – str, URL для скачивания файла

• size – int, размер файла

• public_key – str, публичный ключ

• sha256 – str, SHA256 хэш

• md5 – str, MD5 хэш

• embedded – AsyncTrashResourceListObject, список вложенных ресурсов

• name – str, имя файла

• exif – EXIFObject, метаданные EXIF

• resource_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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

bool

async get_meta(relative_path: str | None = None, /, **kwargs) → AsyncTrashResourceObject

Получает мета-информацию о ресурсе корзины.

Параметры:

• relative_path – str или None, относительный путь к ресурсу

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

AsyncTrashResourceObject

async get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса корзины.

Параметры:

• relative_path – str или None, относительный путь к ресурсу

• timeout – float или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• 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 или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

async listdir(relative_path: str | None = None, /, **kwargs) → Generator[AsyncTrashResourceObject, None, None]

Получает содержимое папки в корзине.

Параметры:

• relative_path – str или None, относительный путь к папке в корзине

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор AsyncTrashResourceObject

async remove(relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject | None

Удаляет ресурс корзины.

Параметры:

• relative_path – str или None, относительный путь к ресурсу корзины, подлежащий удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncOperationLinkObject, если операция выполняется асинхронно, иначе None

async restore(dst_path: str, /, **kwargs) → AsyncResourceLinkObject | 'AsyncOperationLinkObject'

async restore(relative_path: str | None, dst_path: str, /, **kwargs) → AsyncResourceLinkObject | 'AsyncOperationLinkObject'

Восстанавливает ресурс корзины. Возвращает ссылку на новый ресурс или ссылку на асинхронную операцию.

Данный метод принимает 1 или 2 позиционных аргумента:

1. restore(dst_path, /, **kwargs)

2. restore(relative_path=None, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь к восстанавливаему ресурсу

• dst_path – путь назначения

• overwrite – bool, определяет может ли путь назначения быть перезаписан

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

class yadisk.objects.resources.CommentIDsObject(comment_ids: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Список идентификаторов комментариев.

Параметры:

• comment_ids – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• private_resource – str, идентификатор комментария для приватных ресурсов

• public_resource – str, идентификатор комментария для публичных ресурсов

class yadisk.objects.resources.EXIFObject(exif: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Объект метаданных EXIF.

Параметры:

• exif – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

date_time – datetime.datetime, дата съёмки

class yadisk.objects.resources.FilesResourceListObject(files_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Плоский список файлов.

Параметры:

• files_resource_list – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• items – list, плоский список файлов (ResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

class yadisk.objects.resources.LastUploadedResourceListObject(last_uploaded_resources_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Список последних загруженных файлов.

Параметры:

• last_uploaded_resources_list – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• items – list, список ресурсов (ResourceObject)

• limit – int, максимальное число элементов в списке

class yadisk.objects.resources.PublicResourceLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: LinkObject

Объект ссылки на публичный ресурс.

Параметры:

• link – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

• public_key – str, публичный ключ к ресурсу

• public_url – str, публичный URL ресурса

class yadisk.objects.resources.PublicResourceListObject(public_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceListObject

Список публичных ресурсов.

Параметры:

• public_resource_list – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (ResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

• public_key – str, публичный ключ к ресурсу

class yadisk.objects.resources.PublicResourceObject(public_resource=None, yadisk=None)

Базовые классы: ResourceObject

Объект публичного ресурса.

Параметры:

• resource – dict или None

• yadisk – Client/AsyncClient или 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, метаданные EXIF

• resource_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, владелец публичного ресурса

class yadisk.objects.resources.PublicResourcesListObject(public_resources_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Список публичных ресурсов.

Параметры:

• public_resources_list – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• items – list, список публичных ресурсов (PublicResourceObject)

• type – str, тип ресурса по которому фильтровать

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

class yadisk.objects.resources.ResourceDownloadLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: LinkObject

Ссылка для скачивания ресурса.

Параметры:

• link – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

class yadisk.objects.resources.ResourceLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: LinkObject

Объект ссылки на ресурс.

Параметры:

• link – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

• path – str, путь к ресурсу

class yadisk.objects.resources.ResourceListObject(resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Список ресурсов.

Параметры:

• resource_list – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (ResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

class yadisk.objects.resources.ResourceObject(resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Объект ресурса.

Параметры:

• resource – dict или None

• yadisk – Client/AsyncClient или 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, метаданные EXIF

• resource_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, ревизия Яндекс.Диска на момент последнего изменения

class yadisk.objects.resources.ResourceUploadLinkObject(resource_upload_link: dict | None = None, yadisk: Any | None = None)

Базовые классы: LinkObject

Ссылка для загрузки файла.

Параметры:

• resource_upload_link – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• operation_id – str, идентификатор операции по загрузке файла

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

class yadisk.objects.resources.ShareInfoObject(share_info: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Объект информации об общей папке.

Параметры:

• share_info – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• is_root – bool, признак того, что папка является корневой

• is_owned – bool, признак того, что пользователь является владельцем этой папки

• rights – str, права доступа

class yadisk.objects.resources.SyncFilesResourceListObject(files_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: FilesResourceListObject

Плоский список файлов.

Параметры:

• files_resource_list – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• items – list, плоский список файлов (SyncResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

class yadisk.objects.resources.SyncLastUploadedResourceListObject(last_uploaded_resources_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: LastUploadedResourceListObject

Список последних загруженных файлов.

Параметры:

• last_uploaded_resources_list – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• items – list, список ресурсов (SyncResourceObject)

• limit – int, максимальное число элементов в списке

class yadisk.objects.resources.SyncPublicResourceLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourceLinkObject, ResourceObjectMethodsMixin

Объект ссылки на публичный ресурс.

Параметры:

• link – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

• public_key – str, публичный ключ к ресурсу

• public_url – str, публичный URL ресурса

copy(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_src_path, dst_path, /, **kwargs)

Параметры:

• relative_src_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

download(*args, **kwargs) → SyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на исходный ресурс

exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

bool

get_download_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку на скачивание файла (или папки).

Параметры:

• relative_path – str или None, относительный путь от ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

get_meta(relative_path: str | None = None, /, **kwargs) → SyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncResourceObject

get_public_meta(**kwargs) → SyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncPublicResourceObject

get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

«file» или «dir»

get_upload_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку для загрузки файла на диск при помощи PUT запроса.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

str

is_dir(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс папкой.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)

is_file(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс файлом.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

listdir(relative_path: str | None = None, /, **kwargs) → Generator[SyncResourceObject, None, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncResourceObject

mkdir(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

move(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

patch(*args, **kwargs) → SyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceObject

public_listdir(**kwargs) → Generator[SyncPublicResourceObject, None, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncPublicResourceObject

publish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на ресурс

remove(relative_path: str | None = None, /, **kwargs) → SyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncOperationLinkObject, если операция выполняется асинхронно, иначе None

rename(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

unpublish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject, ссылка на загруженный ресурс

upload_url(url: str, relative_path: str | None = None, /, **kwargs) → OperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.SyncPublicResourceListObject(public_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourceListObject

Список публичных ресурсов.

Параметры:

• public_resource_list – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (SyncResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

• public_key – str, публичный ключ к ресурсу

class yadisk.objects.resources.SyncPublicResourceObject(public_resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourceObject, ResourceObjectMethodsMixin

Объект публичного ресурса.

Параметры:

• resource – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• antivirus_status – str, статус проверки антивирусом

• file – str, URL для скачивания файла

• size – int, размер файла

• public_key – str, публичный ключ

• sha256 – str, SHA256 хэш

• md5 – str, MD5 хэш

• embedded – SyncPublicResourceObject, список вложенных ресурсов

• name – str, имя файла

• exif – EXIFObject, метаданные EXIF

• resource_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, владелец публичного ресурса

copy(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_src_path, dst_path, /, **kwargs)

Параметры:

• relative_src_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

download(*args, **kwargs) → SyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на исходный ресурс

exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

bool

get_download_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку на скачивание файла (или папки).

Параметры:

• relative_path – str или None, относительный путь от ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

get_meta(relative_path: str | None = None, /, **kwargs) → SyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncResourceObject

get_public_meta(**kwargs) → SyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncPublicResourceObject

get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

«file» или «dir»

get_upload_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку для загрузки файла на диск при помощи PUT запроса.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

str

is_dir(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс папкой.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)

is_file(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс файлом.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

listdir(relative_path: str | None = None, /, **kwargs) → Generator[SyncResourceObject, None, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncResourceObject

mkdir(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

move(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

patch(*args, **kwargs) → SyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceObject

public_listdir(**kwargs) → Generator[SyncPublicResourceObject, None, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncPublicResourceObject

publish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на ресурс

remove(relative_path: str | None = None, /, **kwargs) → SyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncOperationLinkObject, если операция выполняется асинхронно, иначе None

rename(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

unpublish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject, ссылка на загруженный ресурс

upload_url(url: str, relative_path: str | None = None, /, **kwargs) → OperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.SyncPublicResourcesListObject(public_resources_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: PublicResourcesListObject

Список публичных ресурсов.

Параметры:

• public_resources_list – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• items – list, список публичных ресурсов (SyncPublicResourceObject)

• type – str, тип ресурса по которому фильтровать

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

class yadisk.objects.resources.SyncResourceLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceLinkObject, ResourceObjectMethodsMixin

Объект ссылки на ресурс.

Параметры:

• link – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

• path – str, путь к ресурсу

copy(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_src_path, dst_path, /, **kwargs)

Параметры:

• relative_src_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

download(*args, **kwargs) → SyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на исходный ресурс

exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

bool

get_download_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку на скачивание файла (или папки).

Параметры:

• relative_path – str или None, относительный путь от ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

get_meta(relative_path: str | None = None, /, **kwargs) → SyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncResourceObject

get_public_meta(**kwargs) → SyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncPublicResourceObject

get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

«file» или «dir»

get_upload_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку для загрузки файла на диск при помощи PUT запроса.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

str

is_dir(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс папкой.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)

is_file(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс файлом.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

listdir(relative_path: str | None = None, /, **kwargs) → Generator[SyncResourceObject, None, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncResourceObject

mkdir(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

move(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

patch(*args, **kwargs) → SyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceObject

public_listdir(**kwargs) → Generator[SyncPublicResourceObject, None, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncPublicResourceObject

publish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на ресурс

remove(relative_path: str | None = None, /, **kwargs) → SyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncOperationLinkObject, если операция выполняется асинхронно, иначе None

rename(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

unpublish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject, ссылка на загруженный ресурс

upload_url(url: str, relative_path: str | None = None, /, **kwargs) → OperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.SyncResourceListObject(resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceListObject

Список ресурсов.

Параметры:

• resource_list – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (SyncResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

class yadisk.objects.resources.SyncResourceObject(resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceObject, ResourceObjectMethodsMixin

Объект ресурса.

Параметры:

• resource – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• antivirus_status – str, статус проверки антивирусом

• file – str, URL для скачивания файла

• size – int, размер файла

• public_key – str, публичный ключ

• sha256 – str, SHA256 хэш

• md5 – str, MD5 хэш

• embedded – SyncResourceListObject, список вложенных ресурсов

• name – str, имя файла

• exif – EXIFObject, метаданные EXIF

• resource_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, ревизия Яндекс.Диска на момент последнего изменения

copy(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Копирует ресурс в dst_path. Если операция выполняется асинхронно, возвращает ссылку на операцию, иначе, возвращает ссылку на новый ресурс.

Данный метод принимает 1 или 2 позиционных аргумента:

1. copy(dst_path, /, **kwargs)

2. copy(relative_src_path, dst_path, /, **kwargs)

Параметры:

• relative_src_path – str or None, исходный путь, относительно ресурса

• dst_path – путь назначения

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• InsufficientStorageError – невозможно выполнить запрос из-за нехватки свободного места на Диске

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

download(*args, **kwargs) → SyncResourceLinkObject

Скачивает файл. Данный метод принимает 1 или 2 позиционных аргумента:

1. download(dst_path_or_file, /, **kwargs)

2. download(relative_path, dst_path_or_file, /, **kwargs)

Если relative_path пустой или None (или не указан), данный метод будет использовать поле file (если доступно) в качестве ссылки для скачивания.

Параметры:

• relative_path – str or None, исходный путь, относительно ресурса

• dst_path_or_file – путь назначения или файл-подобный объект

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на исходный ресурс

exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

bool

get_download_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку на скачивание файла (или папки).

Параметры:

• relative_path – str или None, относительный путь от ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

str

get_meta(relative_path: str | None = None, /, **kwargs) → SyncResourceObject

Получает мета-информацию о ресурсе.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncResourceObject

get_public_meta(**kwargs) → SyncPublicResourceObject

Получает мета-информацию о публичном ресурсе.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки.

• offset – отступ от начала списка вложенных ресурсов

• limit – максимальное количество элементов списка вложенных ресурсов

• sort – str, поле использумое для сортировки вложенных ресурсов

• preview_size – размер превью файла

• preview_crop – bool, разрешить обрезку превью

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncPublicResourceObject

get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

«file» или «dir»

get_upload_link(relative_path: str | None = None, /, **kwargs) → str

Получает ссылку для загрузки файла на диск при помощи PUT запроса.

Параметры:

• relative_path – str или None, относительный путь от ресурса

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

str

is_dir(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс папкой.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)

is_file(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс файлом.

Параметры:

• relative_path – относительный путь от ресурса

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

listdir(relative_path: str | None = None, /, **kwargs) → Generator[SyncResourceObject, None, None]

Получает содержимое папки.

Параметры:

• relative_path – относительный путь от ресурса

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncResourceObject

mkdir(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Создаёт новую папку.

Параметры:

• relative_path – str или None, относительный путь к папке, подлежащей созданию

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• DirectoryExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно создать папку из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

move(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Перемещает ресурс в dst_path. Данный метод принимает 1 или 2 позиционных аргумента:

1. move(dst_path, /, **kwargs)

2. move(relative_path, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий перемещению

• dst_path – путь назначения

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

patch(*args, **kwargs) → SyncResourceObject

Обновляет пользовательские свойства ресурса. Данный метод принимает 1 или 2 позиционных аргумента:

1. patch(properties, /, **kwargs)

2. patch(relative_path, properties, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь от ресурса

• properties – dict, новые пользовательские свойства ресурса

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceObject

public_listdir(**kwargs) → Generator[SyncPublicResourceObject, None, None]

Получает содержимое публичной папки.

Параметры:

• path – относительный путь к ресурсу внутри публичной папки

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncPublicResourceObject

publish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает ресурс публичным.

Параметры:

• relative_path – str или None, относительный путь к публикуемому ресурсу

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject, ссылка на ресурс

remove(relative_path: str | None = None, /, **kwargs) → SyncOperationLinkObject | None

Удаляет ресурс.

Параметры:

• relative_path – str или None, относительный путь к удаляемому ресурсу

• permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину

• md5 – str, MD5 хэш файла, подлежащего удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• BadRequestError – проверка MD5 доступна только для файлов

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncOperationLinkObject, если операция выполняется асинхронно, иначе None

rename(*args, **kwargs) → SyncResourceLinkObject | SyncOperationLinkObject

Переименовывает src_path в new_name. Делает то же самое, что и move(), за исключением того, что меняет только имя файла.

Параметры:

• relative_path – str или None, исходный путь, относительно ресурса, подлежащий переименованию

• new_name – новое имя файла, в которое следует переименовать ресурс

• overwrite – bool, определяет, перезаписывать путь назначения или нет

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• ValueError – new_name не является допустимым именем файла

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

unpublish(relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Делает публичный ресурс приватным.

Параметры:

• relative_path – str или None, относительный путь к ресурсу, подлежащему депубликации

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject

upload(path_or_file: str | IO, relative_path: str | None = None, /, **kwargs) → SyncResourceLinkObject

Загружает файл на диск.

Параметры:

• path_or_file – путь к файлу или файл-подобный объект для загрузки

• relative_path – str или None, путь назначения относительно ресурса

• overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncResourceLinkObject, ссылка на загруженный ресурс

upload_url(url: str, relative_path: str | None = None, /, **kwargs) → OperationLinkObject

Загружает файл на диск по URL.

Параметры:

• url – исходный URL

• relative_path – str или None, путь назначения относительно ресурса

• disable_redirects – bool, запретить делать перенаправления

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• ParentNotFoundError – родительская папка не существует

• PathExistsError – путь назначения уже существует

• InsufficientStorageError – невозможно загрузить файл из-за нехватки места на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

• UploadTrafficLimitExceededError – достигнут лимит на загрузку файлов

Результат:

SyncOperationLinkObject, ссылка на асинхронную операцию

class yadisk.objects.resources.SyncTrashResourceListObject(trash_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: TrashResourceListObject

Список ресурсов корзины.

Параметры:

• trash_resource_list – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (SyncTrashResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

class yadisk.objects.resources.SyncTrashResourceObject(trash_resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: TrashResourceObject

Объект ресурса корзины.

Параметры:

• trash_resource – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• antivirus_status – str, статус проверки антивирусом

• file – str, URL для скачивания файла

• size – int, размер файла

• public_key – str, публичный ключ

• sha256 – str, SHA256 хэш

• md5 – str, MD5 хэш

• embedded – SyncTrashResourceListObject, список вложенных ресурсов

• name – str, имя файла

• exif – EXIFObject, метаданные EXIF

• resource_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, дата удаления

exists(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, существует ли ресурс в корзине.

Параметры:

• relative_path – str или None, относительный путь к ресурсу

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

bool

get_meta(relative_path: str | None = None, /, **kwargs) → SyncTrashResourceObject

Получает мета-информацию о ресурсе корзины.

Параметры:

• relative_path – str или None, относительный путь к ресурсу

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• sort – str, поле использумое для сортировки вложенных ресурсов

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

SyncTrashResourceObject

get_type(relative_path: str | None = None, /, **kwargs) → str

Получает тип ресурса корзины.

Параметры:

• relative_path – str или None, относительный путь к ресурсу

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

«file» или «dir»

is_dir(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс папкой в корзине.

Параметры:

• relative_path – str или None, относительный путь к ресурсу

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является папкой, False, в остальных случаях (даже если ресурс не существует)

is_file(relative_path: str | None = None, /, **kwargs) → bool

Проверяет, является ли ресурс файлом в корзине.

Параметры:

• relative_path – str или None, относительный путь к ресурсу

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

Результат:

True, если path является файлом, False, в остальных случаях (даже если ресурс не существует)

listdir(relative_path: str | None = None, /, **kwargs) → Generator[SyncTrashResourceObject, None, None]

Получает содержимое папки в корзине.

Параметры:

• relative_path – str или None, относительный путь к папке в корзине

• limit – количество ресурсов в папке, которые будут включены в ответ

• offset – количество ресурсов в папке, которые будут пропущены

• preview_size – размер превью файла

• preview_crop – bool, обрезает превью согласно размеру, заданному в preview_size

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• WrongResourceTypeError – указанный ресурс не является папкой

Результат:

генератор SyncTrashResourceObject

remove(relative_path: str | None = None, /, **kwargs) → SyncOperationLinkObject | None

Удаляет ресурс корзины.

Параметры:

• relative_path – str или None, относительный путь к ресурсу корзины, подлежащий удалению

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncOperationLinkObject, если операция выполняется асинхронно, иначе None

restore(dst_path: str, /, **kwargs) → SyncResourceLinkObject | 'SyncOperationLinkObject'

restore(relative_path: str | None, dst_path: str, /, **kwargs) → SyncResourceLinkObject | 'SyncOperationLinkObject'

Восстанавливает ресурс корзины. Возвращает ссылку на новый ресурс или ссылку на асинхронную операцию.

Данный метод принимает 1 или 2 позиционных аргумента:

1. restore(dst_path, /, **kwargs)

2. restore(relative_path=None, dst_path, /, **kwargs)

Параметры:

• relative_path – str или None, относительный путь к восстанавливаему ресурсу

• dst_path – путь назначения

• overwrite – bool, определяет может ли путь назначения быть перезаписан

• force_async – заставляет выполнять операцию асинхронно

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

• PathNotFoundError – ресурс не был найден на Диске

• PathExistsError – путь назначения уже существует

• ForbiddenError – у приложения не хватает прав, чтобы выполнить данный запрос

• ResourceIsLockedError – запрашиваемый ресурс заблокирован другой операцией

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

class yadisk.objects.resources.TrashResourceListObject(trash_resource_list: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceListObject

Список ресурсов корзины.

Параметры:

• trash_resource_list – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• sort – str, тип сортировки

• items – list, список ресурсов (TrashResourceObject)

• limit – int, максимальное число элементов в списке

• offset – int, отступ от начала списка

• path – str, путь к папке, содержащей элементы списка

• total – int, количество элементов списка

class yadisk.objects.resources.TrashResourceObject(trash_resource: dict | None = None, yadisk: Any | None = None)

Базовые классы: ResourceObject

Объект ресурса корзины.

Параметры:

• trash_resource – dict или None

• yadisk – Client/AsyncClient или 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, метаданные EXIF

• resource_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, дата удаления

class yadisk.objects.link_object.LinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Объект ссылки.

Параметры:

• link – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

class yadisk.objects.operations.AsyncOperationLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: OperationLinkObject

Объект ссылки на операцию.

Параметры:

• link – dict или None

• yadisk – AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

async get_status(**kwargs) → str

Получает статус операции.

Параметры:

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

OperationNotFoundError – указанная операция не найдена

Результат:

str, "in-progress" означает, что операция в процессе, "success" означает, что операция успешно завершилась, "failed" означает, что операция завершилась с ошибкой

class yadisk.objects.operations.OperationLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: LinkObject

Объект ссылки на операцию.

Параметры:

• link – dict или None

• yadisk – Client/AsyncClient или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

class yadisk.objects.operations.OperationStatusObject(operation_status: dict | None = None, yadisk: Any | None = None)

Базовые классы: YaDiskObject

Объект статуса операции.

Параметры:

• operation_status – dict или None

• yadisk – YaDisk или None, объект YaDisk

Переменные:

• type – str, тип операции

• status – str, статус операции

• operation_id – str, идентификатор операции

• link – LinkObject, ссылка на операцию

• data – dict, другая информация об операции

class yadisk.objects.operations.SyncOperationLinkObject(link: dict | None = None, yadisk: Any | None = None)

Базовые классы: OperationLinkObject

Объект ссылки на операцию.

Параметры:

• link – dict или None

• yadisk – Client или None, объект YaDisk

Переменные:

• href – str, URL ссылки

• method – str, HTTP метод

• templated – bool, признак шаблонизированного URL

get_status(**kwargs) → str

Получает статус операции.

Параметры:

• fields – список ключей, которые будут включены в ответ

• timeout – float или tuple, таймаут запроса

• headers – dict или None, дополнительные заголовки запроса

• n_retries – int, максимальное число повторных попыток запроса

• retry_interval – задержка между повторными попытками в секундах

Исключение:

OperationNotFoundError – указанная операция не найдена

Результат:

str, "in-progress" означает, что операция в процессе, "success" означает, что операция успешно завершилась, "failed" означает, что операция завершилась с ошибкой