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

class yadisk.objects.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.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.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) → Literal['in-progress', 'success', 'failed'][исходный код]

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

Параметры:

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

OperationNotFoundError – указанная операция не найдена

Результат:

str, "in-progress" означает, что операция в процессе, "success" означает, что операция успешно завершилась, "failed" означает, что операция завершилась с ошибкой

async wait(**kwargs) → None[исходный код]

Ждёт, пока операция не будет выполнена. Если выполнение операции не удалось, вызывается исключение. Ожидание осуществляется с помощью вызова asyncio.sleep.

Параметры:

  • poll_interval – float, интервал в секундах между проверками статуса операции

  • poll_timeout – float or None, таймаут ожидания операции (None означает отсутствие таймаута), если этот таймаут превышен, будет вызвано исключение

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:
class yadisk.objects.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 ресурса

class yadisk.objects.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.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, владелец публичного ресурса

class yadisk.objects.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.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, путь к ресурсу

class yadisk.objects.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.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, ревизия Яндекс.Диска на момент последнего изменения

  • sizes – dict[str, str], соответствие всех размеров превью, где ключи - названия размеров, а значения - ссылки для скачивания превью

class yadisk.objects.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.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, дата удаления

  • sizes – dict[str, str], соответствие всех размеров превью, где ключи - названия размеров, а значения - ссылки для скачивания превью

async exists(relative_path: str | None = None, /, **kwargs) → bool[исходный код]

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

Параметры:

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

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

  • 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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

  • 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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

Результат:

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

async listdir(relative_path: str | None = None, /, **kwargs) → AsyncGenerator[AsyncTrashResourceObject, None][исходный код]

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

Параметры:

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

  • max_items – int или None, максимальное число возвращаемых элементов в списке (None означает неограниченное число)

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

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

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

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

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

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

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

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

Результат:

генератор AsyncTrashResourceObject

async remove(relative_path: str | None = None, /, **kwargs) → AsyncOperationLinkObject | None[исходный код]

Удаляет ресурс корзины.

Параметры:

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

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

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

  • wait – bool, если True, метод будет ожидать завершения асинхронной операции

  • poll_interval – float, интервал в секундах между проверками статуса операции

  • poll_timeout – float or None, таймаут ожидания операции (None означает отсутствие таймаута), если этот таймаут превышен, будет вызвано исключение

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

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

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

  • OperationNotFoundError – указанная операция не найдена

  • AsyncOperationFailedError – не удалось совершить операцию

  • AsyncOperationPollingTimeoutError – указанная операция не завершилась в указанное время (когда poll_timeout не None)

Результат:

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 – список ключей, которые будут включены в ответ

  • wait – bool, если True, метод будет ожидать завершения асинхронной операции

  • poll_interval – float, интервал в секундах между проверками статуса операции

  • poll_timeout – float or None, таймаут ожидания операции (None означает отсутствие таймаута), если этот таймаут превышен, будет вызвано исключение

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • aiohttp_args – dict, дополнительные параметры для AIOHTTPSession

  • httpx_args – dict, дополнительные параметры для AsyncHTTPXSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

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

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

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

  • OperationNotFoundError – указанная операция не найдена

  • AsyncOperationFailedError – не удалось совершить операцию

  • AsyncOperationPollingTimeoutError – указанная операция не завершилась в указанное время (когда poll_timeout не None)

Результат:

AsyncResourceLinkObject или AsyncOperationLinkObject

class yadisk.objects.AvailableUntilVerboseObject(available_until_verbose: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Развёрнутая информация о дате истечения доступа

Переменные:

  • enabled – bool, признак наличия даты истечения

  • value – int, дата (timestamp) истечения ссылки

class yadisk.objects.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.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.DiskInfoObject(disk_info: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Объект информации о диске.

Параметры:

  • disk_info – dict или None

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

Переменные:

  • deletion_restriction_days – int, количество дней до удаления файлов после блокировки

  • free_photounlim_end_date – int, timestamp в мс окончания бесплатного места в фотобезлимите

  • hide_screenshots_in_photoslice – bool, настройка скрытия скриншотов у пользователя

  • is_idm_managed_folder_address_access – bool, не ясно, для чего это

  • is_idm_managed_public_access – bool, не ясно, для чего это

  • is_legal_entity – bool, признак принадлежности пользователя к юридическому лицу

  • is_paid – bool, признак платного аккаунта

  • max_file_size – int, максимальный поддерживаемый размер файла (в байтах)

  • paid_max_file_size – int, максимальный поддерживаемый размер файла для платного аккаунта (в байтах)

  • payment_flow – bool, признак причастности пользователя к payment_flow

  • photounlim_size – int, общий размер файлов в фотобезлимите

  • reg_time – datetime.datetime, дата регистрации

  • revision – int, текущая ревизия Яндекс.Диска

  • system_folders – SystemFoldersObject, пути к системным папкам

  • total_space – int, общий размер диска (в байтах)

  • trash_size – int, размер, занятый мусором (в байтах), часть used_space

  • unlimited_autoupload_enabled – bool, признак включенной безлимитной автозагрузки с мобильных устройств

  • used_space – int, количество занятого места (в байтах)

  • user – UserObject, владелец диска

  • will_be_overdrawn – bool, признак - будет ли пользователь в овердрафте по достижении free_photounlim_end_date

class yadisk.objects.EXIFObject(exif: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Объект метаданных EXIF.

Параметры:

  • exif – dict или None

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

Переменные:

  • date_time – datetime.datetime, дата съёмки

  • gps_longitude – str, координата съёмки (долгота)

  • gps_latitude – str, координата съёмки (широта)

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.ExternalOrganizationIdVerboseObject(external_organization_id_verbose: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Развёрнутая информация об идентификаторе внешней организации общего ресурса

Переменные:

  • enabled – bool, признак наличия идентификатора внешней организации

  • value – str, идентификатор внешней организации

class yadisk.objects.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.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.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.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.OperationStatusObject(operation_status: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Объект статуса операции.

Параметры:

  • operation_status – dict или None

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

Переменные:

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

class yadisk.objects.PasswordVerboseObject(password_verbose: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Развёрнутая информация о пароле общего ресурса.

Переменные:

  • enabled – bool, признак активности пароля

  • value – str, значения пароля

class yadisk.objects.PublicAccessObject(public_access: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Настройки доступа общего ресурса.

Переменные:

  • macros – List[Union[Literal[«employees»], Literal[«all»]]],, определяет кто имеет доступ к общему ресурсу, может содержать только один элемент

  • type – str, указывает тип доступа, должен быть один из следующих:

  • macro: доступ для всех сотрудников или пользователей

  • user: доступ для конкретного пользователя

  • group: доступ для конкретной группы

  • department: доступ для конкретного подразделения

Переменные:

  • org_id – str, идентификатор организации

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

  • rights – List[str], описывает права доступа

Доступные права доступа:

  • write: редактирование

  • read: просмотр

  • read_without_download: просмотр без возможности скачивания

  • read_with_password: просмотр с доступом по паролю

  • read_with_password_without_download: просмотр с доступом по паролю без возможности скачивания

class yadisk.objects.PublicAvailableSettingsObject(public_available_settings: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Cписок настроек доступа к ресурсу для владельца OAuth-токена

Переменные:

  • permissions – List[str], список доступных разрешений

  • address_access_sharing – str, определяет кто имеет доступ к общему ресурсу, значение должно быть одним из следующих: - all: доступ для всех пользователей - inner: доступ для всех сотрудников

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

  • macro_sharing – str, определяет кто имеет доступ к общему ресурсу, значение должно быть одним из следующих: - all: доступ для всех пользователей - inner: доступ для всех сотрудников

  • default – List[PublicDefault], настройки доступа по умолчанию

class yadisk.objects.PublicDefaultObject(public_default: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Настройки доступа общего ресурса.

Переменные:

  • macros – List[Union[Literal[«employees»], Literal[«all»]]],, определяет кто имеет доступ к общему ресурсу, может содержать только один элемент

  • org_id – str, идентификатор организации

  • rights – List[str], описывает права доступа

Доступные права доступа:

  • write: редактирование

  • read: просмотр

  • read_without_download: просмотр без возможности скачивания

  • read_with_password: просмотр с доступом по паролю

  • read_with_password_without_download: просмотр с доступом по паролю без возможности скачивания

class yadisk.objects.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.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.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.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.PublicSettingsObject(public_settings: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Настройки доступа к общему ресурсу.

Переменные:

  • available_until – int, timestamp даты истечения ссылки

  • read_only – bool, признак того, что ссылка доступна только на чтение

  • available_until_verbose – AvailableUntilVerboseObject, развёрнутая информация о дате истечения доступа

  • password – str, пароль для доступа к ресурсу

  • password_verbose – PasswordVerboseObject, развёрнутая информация о пароле

  • external_organization_id – str, идентификатор внешней организации

  • external_organization_id_verbose – ExternalOrganizationIdVerboseObject, развёрнутая информация о идентификаторе внешней организации

  • accesses – List[PublicSettingsAccessObject], список настроек доступа

class yadisk.objects.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.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.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.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, ревизия Яндекс.Диска на момент последнего изменения

  • sizes – dict[str, str], соответствие всех размеров превью, где ключи - названия размеров, а значения - ссылки для скачивания превью

class yadisk.objects.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.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.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.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.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) → Literal['in-progress', 'success', 'failed'][исходный код]

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

Параметры:

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

OperationNotFoundError – указанная операция не найдена

Результат:

str, "in-progress" означает, что операция в процессе, "success" означает, что операция успешно завершилась, "failed" означает, что операция завершилась с ошибкой

wait(**kwargs) → None[исходный код]

Ждёт, пока операция не будет выполнена. Если операция не удалась, вызывает исключение. Ожидание осуществляется с помощью вызова time.sleep.

Параметры:

  • poll_interval – float, интервал в секундах между проверками статуса операции

  • poll_timeout – float or None, таймаут ожидания операции (None означает отсутствие таймаута), если этот таймаут превышен, будет вызвано исключение

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:
class yadisk.objects.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 ресурса

class yadisk.objects.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.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, владелец публичного ресурса

class yadisk.objects.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.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, путь к ресурсу

class yadisk.objects.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.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, ревизия Яндекс.Диска на момент последнего изменения

  • sizes – dict[str, str], соответствие всех размеров превью, где ключи - названия размеров, а значения - ссылки для скачивания превью

class yadisk.objects.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.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, дата удаления

  • sizes – dict[str, str], соответствие всех размеров превью, где ключи - названия размеров, а значения - ссылки для скачивания превью

exists(relative_path: str | None = None, /, **kwargs) → bool[исходный код]

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

Параметры:

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

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

  • 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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

  • 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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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 – задержка между повторными попытками в секундах

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

Результат:

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

listdir(relative_path: str | None = None, /, **kwargs) → Generator[SyncTrashResourceObject, None, None][исходный код]

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

Параметры:

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

  • max_items – int или None, максимальное число возвращаемых элементов в списке (None означает неограниченное число)

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

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

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

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

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

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

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

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

Результат:

генератор SyncTrashResourceObject

remove(relative_path: str | None = None, /, **kwargs) → SyncOperationLinkObject | None[исходный код]

Удаляет ресурс корзины.

Параметры:

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

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

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

  • wait – bool, если True, метод будет ожидать завершения асинхронной операции

  • poll_interval – float, интервал в секундах между проверками статуса операции

  • poll_timeout – float or None, таймаут ожидания операции (None означает отсутствие таймаута), если этот таймаут превышен, будет вызвано исключение

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

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

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

  • OperationNotFoundError – указанная операция не найдена

  • AsyncOperationFailedError – не удалось совершить операцию

  • AsyncOperationPollingTimeoutError – указанная операция не завершилась в указанное время (когда poll_timeout не None)

Результат:

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 – список ключей, которые будут включены в ответ

  • wait – bool, если True, метод будет ожидать завершения асинхронной операции

  • poll_interval – float, интервал в секундах между проверками статуса операции

  • poll_timeout – float or None, таймаут ожидания операции (None означает отсутствие таймаута), если этот таймаут превышен, будет вызвано исключение

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

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

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

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

  • retry_on – tuple, дополнительные классы исключений, которые вызовут повторную попытку

  • requests_args – dict, Дополнительные параметры для RequestsSession

  • httpx_args – dict, дополнительные параметры для HTTPXSession

  • curl_options – dict, дополнительные опции для PycURLSession

  • kwargs – другие параметры для Session.send_request()

Исключение:

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

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

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

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

  • OperationNotFoundError – указанная операция не найдена

  • AsyncOperationFailedError – не удалось совершить операцию

  • AsyncOperationPollingTimeoutError – указанная операция не завершилась в указанное время (когда poll_timeout не None)

Результат:

SyncResourceLinkObject или SyncOperationLinkObject

class yadisk.objects.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.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.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.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.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, дата удаления

  • sizes – dict[str, str], соответствие всех размеров превью, где ключи - названия размеров, а значения - ссылки для скачивания превью

class yadisk.objects.UserObject(user: dict | None = None, yadisk: Any | None = None)[исходный код]

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

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

Параметры:

  • user – dict или None

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

Переменные:

  • reg_time – datetime.datetime, дата регистрации

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

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

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

  • is_child – bool, признак того, что аккаунт является детским

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

class yadisk.objects.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.YaDiskObject(field_types: dict | None = None, yadisk: Any | None = None)[исходный код]

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

Базовый класс для всех объектов, реализующий объекты, возвращаемые REST API Яндекс.Диска. У наследующего объекта фиксированное количество полей, каждое со своим типом. Поддерживает доступ по индексу и через точку.

Параметры:

  • field_types – dict или None

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

__matmul__(name: str) → Any[исходный код]

Оператор @. Делает то же самое, что YaDiskObject.field().Может быть использован следующим образом:

# if embedded or embedded.total turn out to be None, we'll get a ValueError
file_count = client.get_meta("/some_folder") @ "embedded" @ "total"
print(f"/some_folder contains {file_count} files")
Параметры:

name – str, имя поля

Исключение:

ValueError – значение требуемого поля - None

Результат:

значение поля

field(name: str) → Any[исходный код]

Получает значение поля name, гарантируя, что оно не None или вызывает ValueError в противном случае

Параметры:

name – str, имя поля

Исключение:

ValueError – значение требуемого поля - None

Результат:

значение поля

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, где ключи - это наименования полей, а значения - это типы