Документация

class yadisk.YaDisk(id='', secret='', token='')[исходный код]

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

Параметры:
  • id – идентификатор приложения
  • secret – пароль приложения
  • token – токен
Переменные:
  • idstr, идентификатор приложения
  • secretstr, пароль приложения
  • tokenstr, токен
check_token(token=None, **kwargs)[исходный код]

Проверяет, действителен ли токен.

Параметры:
  • token – токен, подлежащий проверке, то же самое, что self.token при None
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

bool

clear_session_cache()[исходный код]

Очищает кэш сессий. Неиспользуемые сессии будут закрыты.

copy(src_path, dst_path, **kwargs)[исходный код]

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

Параметры:
  • src_path – исходный путь
  • dst_path – путь назначения
  • overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject или OperationLinkObject

download(src_path, path_or_file, **kwargs)[исходный код]

Скачивает файл.

Параметры:
  • src_path – исходный путь
  • path_or_file – путь назначения или файл-подобный объект
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
download_public(public_key, file_or_path, **kwargs)[исходный код]

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

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • file_or_path – путь назначения или файл-подобный объект
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
exists(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

bool

get_auth_url(**kwargs)[исходный код]

Получает URL для аутентификации для пользователя.

Параметры:
  • type – тип ответа («code», чтобы получить код подтверждения или «token», чтобы получить токен автоматически)
  • device_id – уникальный идентификатор устройства, от 6 до 50 символов
  • device_name – имя устройства, не более 100 символов
  • display – указывает использовать облегчённую вёрстку, обрабатывает только «popup», остальные значения игнорируются
  • login_hint – username или email аккаунта, для которого будет получен токен
  • scope – список разрешений для приложения
  • optional_scope – список опциональных разрешений для приложения
  • force_confirm – Если True, пользователь должен будет разрешить доступ к аккаунту, даже если он уже это сделал до этого
  • state – Строка состояния, которую Яндекс.OAuth возвращает без изменений (<= 1024 символов)
Результат:

URL для аутентификации

get_code_url(**kwargs)[исходный код]

Получает URL для получения пользователем кода подтверждения. Он может быть использован для получения токена.

Параметры:
  • device_id – уникальный идентификатор устройства, от 6 до 50 символов
  • device_name – имя устройства, не более 100 символов
  • display – указывает использовать облегчённую вёрстку, обрабатывает только «popup», остальные значения игнорируются
  • login_hint – username или email аккаунта, для которого будет получен токен
  • scope – список разрешений для приложения
  • optional_scope – список опциональных разрешений для приложения
  • force_confirm – Если True, пользователь должен будет разрешить доступ к аккаунту, даже если он уже это сделал до этого
  • state – Строка состояния, которую Яндекс.OAuth возвращает без изменений (<= 1024 символов)
Результат:

URL для аутентификации

get_disk_info(**kwargs)[исходный код]

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

Параметры:
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

DiskInfoObject

Получает ссылку на скачивание файла (или папки).

Параметры:
  • path – путь к ресурсу
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

get_files(**kwargs)[исходный код]

Получить плоский список всех файлов (без папок).

Параметры:
  • offset – отступ от начала списка
  • limit – максимальное количество элементов списка
  • media_type – тип файлов, которые будут включены в список
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор ResourceObject

get_last_uploaded(**kwargs)[исходный код]

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

Параметры:
  • limit – максимальное число элементов в списке
  • media_type – тип файлов, которые будут включены в список
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор LastUploadedResourceListObject

get_meta(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к ресурсу
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

ResourceObject

get_operation_status(operation_id, **kwargs)[исходный код]

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

Параметры:
  • operation_id – идентификатор операции или ссылка на нее
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

Получает ссылку на скачивание публичного ресурса.

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

get_public_meta(public_key, **kwargs)[исходный код]

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

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки. Указывая ключ опубликованной папки через public_key, вы можете запросить метаинформацию любого ресурса внутри неё.
  • offset – отступ от начала списка вложенных ресурсов
  • limit – максимальное количество элементов списка вложенных ресурсов
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • preview_size – размер превью файла
  • preview_cropbool, разрешить обрезку превью
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

PublicResourceObject

get_public_resources(**kwargs)[исходный код]

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

Параметры:
  • offset – отступ от начала списка
  • limit – максимальное число элементов в списке
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • type – фильтр по типу ресурса («file» или «dir»)
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

PublicResourcesListObject

get_public_type(public_key, **kwargs)[исходный код]

Получает тип публичного ресурса.

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

«file» или «dir»

get_session(token=None)[исходный код]

То же, что и YaDisk.make_session, но с обёрткой functools.lru_cache.

Результат:requests.Session, отдельные объекты для разных потоков
get_token(code, **kwargs)[исходный код]

Получает новый токен.

Параметры:
  • code – код подтверждения
  • device_id – уникальный идентификатор устройства (между 6 и 50 символами)
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TokenObject

get_trash_meta(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к ресурсу корзины
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TrashResourceObject

get_trash_type(path, **kwargs)[исходный код]

Получает тип ресурса корзины.

Параметры:
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

«file» или «dir»

get_type(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

«file» или «dir»

Получает ссылку для загрузки файла на диск при помощи PUT запроса.

Параметры:
  • path – путь назначения
  • overwritebool, определяет, перезаписывать путь назначения или нет
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

is_dir(path, **kwargs)[исходный код]

Проверяет, является ли path папкой.

Параметры:
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

is_file(path, **kwargs)[исходный код]

Проверяет, является ли path файлом.

Параметры:
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

is_public_dir(public_key, **kwargs)[исходный код]

Проверяет, является ли public_key публичной папкой.

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

is_public_file(public_key, **kwargs)[исходный код]

Проверяет, является ли public_key публичным файлом.

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

is_trash_dir(path, **kwargs)[исходный код]

Проверяет, является ли path папкой в корзине.

Параметры:
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

is_trash_file(path, **kwargs)[исходный код]

Проверяет, является ли path файлом в корзине.

Параметры:
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

listdir(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к папке
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор ResourceObject

make_session(token=None)[исходный код]

Готовит объект requests.Session с заголовками, необходимыми для API.

Параметры:token – токен, то же самое, что self.token, если None
Результат:requests.Session
mkdir(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к папке, подлежащей созданию
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject

move(src_path, dst_path, **kwargs)[исходный код]

Перемещает src_path в dst_path.

Параметры:
  • src_path – исходный путь, подлежащий перемещению
  • dst_path – путь назначения
  • overwritebool, определяет, перезаписывать путь назначения или нет
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

OperationLinkObject или LinkObject

patch(path, properties, **kwargs)[исходный код]

Обновляет пользовательские свойства ресурса.

Параметры:
  • path – путь к ресурсу
  • propertiesdict, новые пользовательские свойства ресурса
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

ResourceObject

public_exists(public_key, **kwargs)[исходный код]

Проверяет, существует ли публичный ресурс.

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

bool

public_listdir(public_key, **kwargs)[исходный код]

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

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу в публичной папке. Указывая ключ опубликованной папки через public_key, вы можете запросить содержимое любой вложенной папки.
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор PublicResourceObject

publish(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к публикуемому ресурсу
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

refresh_token(refresh_token, **kwargs)[исходный код]

Обновляет существующий токен.

Параметры:
  • refresh_token – refresh-токен, полученный вместе с токеном
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TokenObject

remove(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к удаляемому ресурсу
  • permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
  • md5str, MD5 хэш файла, подлежащего удалению
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

remove_trash(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к ресурсу корзины, подлежащий удалению
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

restore_trash(path, dst_path=None, **kwargs)[исходный код]

Восстанавливает ресурс корзины. Возвращает ссылку на новый ресурс или ссылку на асинхронную операцию.

Параметры:
  • path – путь к ресурсу корзины, подлежащий удалению
  • dst_path – путь назначения
  • overwritebool, определяет может ли путь назначения быть перезаписан
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject или OperationLinkObject

revoke_token(token=None, **kwargs)[исходный код]

Отзывает токен.

Параметры:
  • token – токен, подлежащий отзыву, то же самое, что self.token, если None
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TokenRevokeStatusObject

save_to_disk(public_key, **kwargs)[исходный код]

Сохраняет публичный ресурс на диск. Возвращает ссылку на операцию, если сохранение выполняется асинхронно, или возвращает ссылку на ресурс.

Параметры:
  • public_key – публичный ключ или URL к ресурсу
  • name – имя файла/папки, под которым будет сохранён ресурс
  • path – путь к копируемому ресурсу в публичной папке
  • save_path – путь к папке назначения (загрузки по умолчанию)
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject или OperationLinkObject

trash_exists(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

bool

trash_listdir(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к папке в корзине
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор TrashResourceObject

unpublish(path, **kwargs)[исходный код]

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

Параметры:
  • path – путь к ресурсу, подлежащему депубликации
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

upload(path_or_file, dst_path, **kwargs)[исходный код]

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

Параметры:
  • path_or_file – путь к файлу или файл-подобный объект для загрузки
  • dst_path – путь назначения
  • overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
upload_url(url, path, **kwargs)[исходный код]

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

Параметры:
  • url – исходный URL
  • path – путь назначения
  • disable_redirectsbool, запретить делать перенаправления
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

Общие параметры

Почти все методы YaDisk (те, которые принимают **kwargs) принимают некоторые дополнительные параметры:

  • n_retries - int, максимальное число повторных попыток запроса
  • retry_delay - float, задержка между повторными попытками (в секундах)
  • headers - dict или None, дополнительные заголовки запроса

Параметры requests, такие как timeout, proxies и подобные так же принимаются (см. requests.request()).

Это так же применяется для низкоуровневых функций и объектов запросов API.

Настройки

Следующие настройки в модуле yadisk.settings могут быть получены и изменены:

  • DEFAULT_TIMEOUT - tuple из 2-х чисел (int или float), стандартный таймаут для запросов. Первое число - это таймаут соединения, второе - таймаут чтения.
  • DEFAULT_N_RETRIES - int, максимальное число повторных попыток запроса по умолчанию
  • DEFAULT_RETRY_DELAY - float, стандартная задержка между повторными попытками
  • DEFAULT_UPLOAD_TIMEOUT - аналогично DEFAULT_TIMEOUT, но для функции upload
  • DEFAULT_UPLOAD_RETRY_INTERVAL - аналогично DEFAULT_RETRY_INTERVAL, но для функции upload

Исключения

Кроме исключений, перечисленных ниже, запросы к API могут также вызвать исключения requests.

exception yadisk.exceptions.YaDiskError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: Exception

Базовый класс для всех исключений в этой библиотеке.

Переменные:
  • error_typestr, уникальный код ошибки, полученный от API
  • response – объект requests.Response
Параметры:
  • error_typestr, уникальный код ошибки, полученный от API
  • msgstr, сообщение исключения
  • response – объект requests.Response
exception yadisk.exceptions.RetriableYaDiskError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается в случае, если произошла ошибка, но имеет смысл повторить запрос.

exception yadisk.exceptions.UnknownYaDiskError(msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.RetriableYaDiskError

Вызывается, когда запрос не удался, но не содержит информации об ошибке.

exception yadisk.exceptions.WrongResourceTypeError(msg='')[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда ожидался ресурс другого типа (например, файл вместо папки).

exception yadisk.exceptions.BadRequestError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 400.

exception yadisk.exceptions.UnauthorizedError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 401.

exception yadisk.exceptions.ForbiddenError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 403.

exception yadisk.exceptions.NotFoundError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 404.

exception yadisk.exceptions.NotAcceptableError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 406.

exception yadisk.exceptions.ConflictError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 409.

exception yadisk.exceptions.UnsupportedMediaError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 415.

exception yadisk.exceptions.LockedError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 423.

exception yadisk.exceptions.TooManyRequestsError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 429.

exception yadisk.exceptions.InternalServerError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.RetriableYaDiskError

Вызывается, когда сервер вернул код 500.

exception yadisk.exceptions.BadGatewayError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.RetriableYaDiskError

Вызывается, когда сервер вернул код 502.

exception yadisk.exceptions.UnavailableError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.RetriableYaDiskError

Вызывается, когда сервер вернул код 503.

exception yadisk.exceptions.GatewayTimeoutError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.RetriableYaDiskError

Вызывается, когда сервер вернул код 504.

exception yadisk.exceptions.InsufficientStorageError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.YaDiskError

Вызывается, когда сервер вернул код 509.

exception yadisk.exceptions.PathNotFoundError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.NotFoundError

Вызывается, когда запрашиваемый путь не существует.

exception yadisk.exceptions.ParentNotFoundError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.ConflictError

Вызывается mkdir, upload и т.д. когда родительская папка не существует.

exception yadisk.exceptions.PathExistsError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.ConflictError

Вызывается, когда запрашиваемый путь уже существует.

exception yadisk.exceptions.DirectoryExistsError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.PathExistsError

Вызывается, когда папка уже существует.

exception yadisk.exceptions.FieldValidationError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.BadRequestError

Вызывается, когда запрос содежит поля с некорректными данными.

exception yadisk.exceptions.ResourceIsLockedError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.LockedError

Вызывается, когда запрашиваемый ресурс заблокирован другой операцией.

exception yadisk.exceptions.MD5DifferError(error_type=None, msg='', response=None)[исходный код]
Базовые классы: yadisk.exceptions.ConflictError

Вызывается, когда MD5 хэш удаляемого ресурса не совпадает с указанным.

Объекты

class yadisk.objects.YaDiskObject(field_types=None)[исходный код]

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

Параметры:field_typesdict или None
import_fields(source_dict)[исходный код]

Задаёт значения всех полей объекта из source_dict. Все остальные ключи игнорируются.

Параметры:source_dictdict или None (тогда ничего не будет сделано)
remove_alias(alias)[исходный код]

Удаляет псевдоним.

Параметры:aliasstr
remove_field(field)[исходный код]

Удаляет поле.

Параметры:fieldstr
set_alias(alias, name)[исходный код]

Задаёт псевдоним.

Параметры:
  • aliasstr, псевдоним
  • namestr, имя поля
set_field_type(field, type)[исходный код]

Задаёт тип поля.

Параметры:
  • fieldstr
  • type – тип данных или factory
set_field_types(field_types)[исходный код]

Задаёт типы полей объекта

Параметры:field_typesdict, где ключи - это наименования полей, а значения - это типы
class yadisk.objects.ErrorObject(error=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

errordict или None

Переменные:
  • messagestr, человеко-читаемое сообщение ошибки
  • descriptionstr, техническое описание ошибки
  • errorstr, уникальный код ошибки
class yadisk.objects.auth.TokenObject(token=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

tokendict или None

Переменные:
  • access_tokenstr, строка токена
  • refresh_tokenstr, refresh-токен
  • token_typestr, тип токена
  • expires_inint, количество времени, на которое выдаётся токен
class yadisk.objects.auth.TokenRevokeStatusObject(token_revoke_status=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:token_revoke_statusdict или None
Переменные:statusstr, статус операции
class yadisk.objects.disk.DiskInfoObject(disk_info=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

disk_infodict или None

Переменные:
  • max_file_sizeint, максимальный поддерживаемый размер файла (в байтах)
  • unlimited_autoupload_enabledbool, признак включенной безлимитной автозагрузки с мобильных устройств
  • total_spaceint, общий размер диска (в байтах)
  • trash_sizeint, размер, занятый мусором (в байтах), чась used_space
  • is_paidbool, признак платного аккаунта
  • used_spaceint, количество занятого места (в байтах)
  • system_foldersSystemFoldersObject, пути к системным папкам
  • userUserObject, владелец диска
  • revisionint, текущая ревизия Яндекс.Диска
class yadisk.objects.disk.SystemFoldersObject(system_folders=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

Объект, содержащий пути к системным папкам.

Параметры:

system_foldersdict или None

Переменные:
  • odnoklassnikistr, путь к папке Одноклассников
  • googlestr, путь к папке Google+
  • instagramstr, путь к папке Instagram
  • vkontaktestr, путь к папке ВКонтакте
  • mailrustr, путь к папке Моего Мира
  • facebookstr, путь к папке Facebook
  • socialstr, путь к папке социальных сетей
  • screenshotsstr, путь к папке скриншотов
  • photostreamstr, путь к папке фотокамеры
class yadisk.objects.disk.UserObject(user=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

userdict или None

Переменные:
  • countrystr, страна пользователя
  • loginstr, логин пользователя
  • display_namestr, отображаемое имя пользователя
  • uidstr, уникальный идентификатор пользователя
class yadisk.objects.disk.UserPublicInfoObject(public_user_info=None)[исходный код]
Базовые классы: yadisk.objects.disk.UserObject

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

Параметры:

public_user_infodict или None

Переменные:
  • loginstr, логин пользователя
  • display_namestr, отображаемое имя пользователя
  • uidstr, уникальный идентификатор пользователя
class yadisk.objects.resources.CommentIDsObject(comment_ids=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

Список идентификаторов комментариев.

Параметры:

comment_idsdict или None

Переменные:
  • private_resourcestr, идентификатор комментария для приватных ресурсов
  • public_resourcestr, идентификатор комментария для публичных ресурсов
class yadisk.objects.resources.EXIFObject(exif=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:exifdict или None
Переменные:date_timedatetime.datetime, дата съёмки
class yadisk.objects.resources.FilesResourceListObject(files_resource_list=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

files_resource_listdict или None

Переменные:
  • itemslist, плоский список файлов (ResourceObject)
  • limitint, максимальное число элементов в списке
  • offsetint, отступ от начала списка
class yadisk.objects.resources.LastUploadedResourceListObject(last_uploaded_resources_list=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

last_uploaded_resources_listdict или None

Переменные:
  • itemslist, список ресурсов (ResourceObject)
  • limitint, максимальное число элементов в списке
class yadisk.objects.resources.LinkObject(link=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

Объект ссылки.

Параметры:

linkdict или None

Переменные:
  • hrefstr, URL ссылки
  • methodstr, HTTP метод
  • templatedbool, признак шаблонизированного URL
class yadisk.objects.resources.OperationLinkObject(link=None)[исходный код]
Базовые классы: yadisk.objects.resources.LinkObject

Объект ссылки на операцию.

Параметры:

linkdict или None

Переменные:
  • hrefstr, URL ссылки
  • methodstr, HTTP метод
  • templatedbool, признак шаблонизированного URL
class yadisk.objects.resources.PublicResourcesListObject(public_resources_list=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

public_resources_listdict или None

Переменные:
  • itemslist, список публичных ресурсов (PublicResourceObject)
  • typestr, тип ресурса по которому фильтровать
  • limitint, максимальное число элементов в списке
  • offsetint, отступ от начала списка
class yadisk.objects.resources.ResourceListObject(resource_list=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

Список ресурсов.

Параметры:

resource_listdict или None

Переменные:
  • sortstr, тип сортировки
  • itemslist, список ресурсов (ResourceObject)
  • limitint, максимальное число элементов в списке
  • offsetint, отступ от начала списка
  • pathstr, путь к папке, содержащей элементы списка
  • totalint, количество элементов списка
class yadisk.objects.resources.ResourceObject(resource=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

Объект ресурса.

Параметры:

resourcedict или None

Переменные:
  • antivirus_statusstr, статус проверки антивирусом
  • filestr, URL для скачивания файла
  • sizeint, размер файла
  • public_keystr, публичный ключ
  • sha256str, SHA256 хэш
  • md5str, MD5 хэш
  • embeddedResourceListObject, список вложенных ресурсов
  • namestr, имя файла
  • exifEXIFObject, метаданные EXIF
  • resource_idstr, идентификатор ресурса
  • custom_propertiesdict, пользовательские свойства ресурса
  • public_urlstr, публичный URL
  • shareShareInfoObject, информация об общей папке
  • modifieddatetime.datetime, дата последнего изменения
  • createddatetime.datetime, дата создания
  • photoslice_timedatetime.datetime, дата создания фото/видео
  • mime_typestr, MIME-тип
  • pathstr, путь к ресурсу
  • previewstr, URL превью файла
  • comment_idsCommentIDsObject, идентификаторы комментариев
  • typestr, тип («file» или «dir»)
  • media_typestr, тип файла, согласно Яндекс.Диску
  • revisionint, ревизия Яндекс.Диска на момент последнего изменения
class yadisk.objects.resources.ResourceUploadLinkObject(resource_upload_link=None)[исходный код]
Базовые классы: yadisk.objects.resources.LinkObject

Ссылка для загрузки файла.

Параметры:

resource_upload_linkdict или None

Переменные:
  • operation_idstr, идентификатор операции по загрузке файла
  • hrefstr, URL ссылки
  • methodstr, HTTP метод
  • templatedbool, признак шаблонизированного URL
class yadisk.objects.resources.ShareInfoObject(share_info=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

Объект информации об общей папке.

Параметры:

share_infodict или None

Переменные:
  • is_rootbool, признак того, что папка является корневой
  • is_ownedbool, признак того, что пользователь является владельцем этой папки
  • rightsstr, права доступа
class yadisk.objects.resources.PublicResourceObject(public_resource=None)[исходный код]
Базовые классы: yadisk.objects.resources.ResourceObject

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

Параметры:

resourcedict или None

Переменные:
  • antivirus_statusstr, статус проверки антивирусом
  • filestr, URL для скачивания файла
  • sizeint, размер файла
  • public_keystr, публичный ключ
  • sha256str, SHA256 хэш
  • md5str, MD5 хэш
  • embeddedPublicResourceObject, список вложенных ресурсов
  • namestr, имя файла
  • exifEXIFObject, метаданные EXIF
  • resource_idstr, идентификатор ресурса
  • custom_propertiesdict, пользовательские свойства ресурса
  • public_urlstr, публичный URL
  • shareShareInfoObject, информация об общей папке
  • modifieddatetime.datetime, дата последнего изменения
  • createddatetime.datetime, дата создания
  • photoslice_timedatetime.datetime, дата создания фото/видео
  • mime_typestr, MIME-тип
  • pathstr, путь к ресурсу
  • previewstr, URL превью файла
  • comment_idsCommentIDsObject, идентификаторы комментариев
  • typestr, тип («file» или «dir»)
  • media_typestr, тип файла, согласно Яндекс.Диску
  • revisionint, ревизия Яндекс.Диска на момент последнего изменения
  • view_countint, количество просмотров публичного ресурса
  • ownerUserPublicInfoObject, владелец публичного ресурса
class yadisk.objects.resources.PublicResourceListObject(public_resource_list=None)[исходный код]
Базовые классы: yadisk.objects.resources.ResourceListObject

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

Параметры:

public_resource_listdict или None

Переменные:
  • sortstr, тип сортировки
  • itemslist, список ресурсов (ResourceObject)
  • limitint, максимальное число элементов в списке
  • offsetint, отступ от начала списка
  • pathstr, путь к папке, содержащей элементы списка
  • totalint, количество элементов списка
  • public_keystr, публичный ключ к ресурсу
class yadisk.objects.resources.TrashResourceObject(trash_resource=None)[исходный код]
Базовые классы: yadisk.objects.resources.ResourceObject

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

Параметры:

trash_resourcedict или None

Переменные:
  • antivirus_statusstr, статус проверки антивирусом
  • filestr, URL для скачивания файла
  • sizeint, размер файла
  • public_keystr, публичный ключ
  • sha256str, SHA256 хэш
  • md5str, MD5 хэш
  • embeddedResourceListObject, список вложенных ресурсов
  • namestr, имя файла
  • exifEXIFObject, метаданные EXIF
  • resource_idstr, идентификатор ресурса
  • custom_propertiesdict, пользовательские свойства ресурса
  • public_urlstr, публичный URL
  • shareShareInfoObject, информация об общей папке
  • modifieddatetime.datetime, дата последнего изменения
  • createddatetime.datetime, дата создания
  • photoslice_timedatetime.datetime, дата создания фото/видео
  • mime_typestr, MIME-тип
  • pathstr, путь к ресурсу
  • previewstr, URL превью файла
  • comment_idsCommentIDsObject, идентификаторы комментариев
  • typestr, тип («file» или «dir»)
  • media_typestr, тип файла, согласно Яндекс.Диску
  • revisionint, ревизия Яндекс.Диска на момент последнего изменения
  • origin_pathstr, оригинальный путь
  • deleteddatetime.datetime, дата удаления
class yadisk.objects.resources.TrashResourceListObject(trash_resource_list=None)[исходный код]
Базовые классы: yadisk.objects.resources.ResourceListObject

Список ресурсов корзины.

Параметры:

trash_resource_listdict или None

Переменные:
  • sortstr, тип сортировки
  • itemslist, список ресурсов (TrashResourceObject)
  • limitint, максимальное число элементов в списке
  • offsetint, отступ от начала списка
  • pathstr, путь к папке, содержащей элементы списка
  • totalint, количество элементов списка
class yadisk.objects.operations.OperationStatusObject(operation_status=None)[исходный код]
Базовые классы: yadisk.objects.yadisk_object.YaDiskObject

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

Параметры:

operation_statusdict или None

Переменные:
  • typestr, тип операции
  • statusstr, статус операции
  • operation_idstr, идентификатор операции
  • linkLinkObject, ссылка на операцию
  • datadict, другая информация об операции

Низкоуровневый API

Вспомогательные средства

yadisk.utils.get_exception(response)[исходный код]

Возвращает объект исключения, основываясь на ответе (подразумевается, что запрос не удался).

Параметры:response – объект requests.Response
Результат:Объект исключения, подкласс YaDiskError
yadisk.utils.auto_retry(func, n_retries=None, retry_interval=None)[исходный код]

Выполняет запрос с автоматическими повторными попытками. Повторная попытка может быть вызвана requests.RequestException или RetriableYaDiskError.

Параметры:
  • func – Функция, подлежащая исполнению, не должна требовать аргументов
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_intervalint или float, задержка между повторными попытками в секундах
Результат:

Значение, возвращаемое func()

Функции

yadisk.functions.auth.check_token(session, **kwargs)[исходный код]

Проверяет, действителен ли токен.

Параметры:session – объект requests.Session с приготовленными заголовками
Результат:bool
yadisk.functions.auth.get_auth_url(client_id, **kwargs)[исходный код]

Получает URL для аутентификации для пользователя.

Параметры:
  • client_id – идентификатор приложения
  • type – тип ответа («code», чтобы получить код подтверждения или «token», чтобы получить токен автоматически)
  • device_id – уникальный идентификатор устройства, от 6 до 50 символов
  • device_name – имя устройства, не более 100 символов
  • display – указывает использовать облегчённую вёрстку, обрабатывает только «popup», остальные значения игнорируются
  • login_hint – username или email аккаунта, для которого будет получен токен
  • scope – список разрешений для приложения
  • optional_scope – список опциональных разрешений для приложения
  • force_confirm – Если True, пользователь должен будет разрешить доступ к аккаунту, даже если он уже это сделал до этого
  • state – Строка состояния, которую Яндекс.OAuth возвращает без изменений (<= 1024 символов)
Результат:

URL для аутентификации

yadisk.functions.auth.get_code_url(client_id, **kwargs)[исходный код]

Получает URL для получения пользователем кода подтверждения. Он может быть использован для получения токена.

Параметры:
  • client_id – идентификатор приложения
  • device_id – уникальный идентификатор устройства, от 6 до 50 символов
  • device_name – имя устройства, не более 100 символов
  • display – указывает использовать облегчённую вёрстку, обрабатывает только «popup», остальные значения игнорируются
  • login_hint – username или email аккаунта, для которого будет получен токен
  • scope – список разрешений для приложения
  • optional_scope – список опциональных разрешений для приложения
  • force_confirm – Если True, пользователь должен будет разрешить доступ к аккаунту, даже если он уже это сделал до этого
  • state – Строка состояния, которую Яндекс.OAuth возвращает без изменений (<= 1024 символов)
Результат:

URL для аутентификации

yadisk.functions.auth.get_token(code, client_id, client_secret, **kwargs)[исходный код]

Получает новый токен.

Параметры:
  • code – код подтверждения
  • client_id – идентификатор приложения
  • client_secret – пароль приложения
  • device_id – уникальный идентификатор устройства (между 6 и 50 символами)
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TokenObject

yadisk.functions.auth.refresh_token(refresh_token, client_id, client_secret, **kwargs)[исходный код]

Обновляет существующий токен.

Параметры:
  • refresh_token – refresh-токен, полученный вместе с токеном
  • client_id – идентификатор приложения
  • client_secret – пароль приложения
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TokenObject

yadisk.functions.auth.revoke_token(token, client_id, client_secret, **kwargs)[исходный код]

Отзывает токен.

Параметры:
  • token – токен, подлежащий отзыву
  • client_id – идентификатор приложения
  • client_secret – пароль приложения
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TokenRevokeStatusObject

yadisk.functions.disk.get_disk_info(session, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

DiskInfoObject

yadisk.functions.resources.copy(session, src_path, dst_path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • src_path – исходный путь
  • dst_path – путь назначения
  • overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject или OperationLinkObject

yadisk.functions.resources.download(session, src_path, file_or_path, **kwargs)[исходный код]

Скачивает файл.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • src_path – исходный путь
  • path_or_file – путь назначения или файл-подобный объект
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
yadisk.functions.resources.exists(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

bool

Получает ссылку на скачивание файла (или папки).

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

yadisk.functions.resources.get_meta(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

ResourceObject

yadisk.functions.resources.get_type(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

«file» или «dir»

Получает ссылку для загрузки файла на диск при помощи PUT запроса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь назначения
  • overwritebool, определяет, перезаписывать путь назначения или нет
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

yadisk.functions.resources.is_dir(session, path, **kwargs)[исходный код]

Проверяет, является ли path папкой.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.is_file(session, path, **kwargs)[исходный код]

Проверяет, является ли path файлом.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.listdir(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к папке
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор ResourceObject

yadisk.functions.resources.mkdir(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к папке, подлежащей созданию
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject

yadisk.functions.resources.remove(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к удаляемому ресурсу
  • permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
  • md5str, MD5 хэш файла, подлежащего удалению
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.upload(session, file_or_path, dst_path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • file_or_path – путь к файлу или файл-подобный объект для загрузки
  • dst_path – путь назначения
  • overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
yadisk.functions.resources.get_trash_meta(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу корзины
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

TrashResourceObject

yadisk.functions.resources.trash_exists(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

bool

yadisk.functions.resources.restore_trash(session, path, dst_path=None, **kwargs)[исходный код]

Восстанавливает ресурс корзины. Возвращает ссылку на новый ресурс или ссылку на асинхронную операцию.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к восстанавливаему ресурсу
  • dst_path – путь назначения
  • overwritebool, определяет может ли путь назначения быть перезаписан
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject или OperationLinkObject

yadisk.functions.resources.move(session, src_path, dst_path, **kwargs)[исходный код]

Перемещает src_path в dst_path.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • src_path – исходный путь, подлежащий перемещению
  • dst_path – путь назначения
  • overwritebool, определяет, перезаписывать путь назначения или нет
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject или OperationLinkObject

yadisk.functions.resources.remove_trash(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу корзины, подлежащий удалению
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.publish(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к публикуемому ресурсу
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.unpublish(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу, подлежащему депубликации
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject

yadisk.functions.resources.save_to_disk(session, public_key, **kwargs)[исходный код]

Сохраняет публичный ресурс на диск. Возвращает ссылку на операцию, если сохранение выполняется асинхронно, или возвращает ссылку на ресурс.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • name – имя файла/папки, под которым будет сохранён ресурс
  • path – путь к копируемому ресурсу в публичной папке
  • save_path – путь к папке назначения (загрузки по умолчанию)
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

LinkObject или OperationLinkObject

yadisk.functions.resources.get_public_meta(session, public_key, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • path – относительный путь к ресурсу внутри публичной папки. Указывая ключ опубликованной папки через public_key, вы можете запросить метаинформацию любого ресурса внутри неё.
  • offset – отступ от начала списка вложенных ресурсов
  • limit – максимальное количество элементов списка вложенных ресурсов
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • preview_size – размер превью файла
  • preview_cropbool, разрешить обрезку превью
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

PublicResourceObject

yadisk.functions.resources.public_exists(session, public_key, **kwargs)[исходный код]

Проверяет, существует ли публичный ресурс.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

bool

yadisk.functions.resources.public_listdir(session, public_key, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • path – относительный путь к ресурсу в публичной папке. Указывая ключ опубликованной папки через public_key, вы можете запросить содержимое любой вложенной папки.
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор PublicResourceObject

yadisk.functions.resources.get_public_type(session, public_key, **kwargs)[исходный код]

Получает тип публичного ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

«file» или «dir»

yadisk.functions.resources.is_public_dir(session, public_key, **kwargs)[исходный код]

Проверяет, является ли публичный ресурс публичной папкой.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.is_public_file(session, public_key, **kwargs)[исходный код]

Проверяет, является ли публичный ресурс публичным файлом.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.trash_listdir(session, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к папке в корзине
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор TrashResourceObject

yadisk.functions.resources.get_trash_type(session, path, **kwargs)[исходный код]

Получает тип ресурса корзины.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

«file» или «dir»

yadisk.functions.resources.is_trash_dir(session, path, **kwargs)[исходный код]

Проверяет, является ли path папкой в корзине.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.is_trash_file(session, path, **kwargs)[исходный код]

Проверяет, является ли path файлом в корзине.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу корзины
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

yadisk.functions.resources.get_public_resources(session, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • offset – отступ от начала списка
  • limit – максимальное число элементов в списке
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • type – фильтр по типу ресурса («file» или «dir»)
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

PublicResourcesListObject

yadisk.functions.resources.patch(session, path, properties, **kwargs)[исходный код]

Обновляет пользовательские свойства ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • propertiesdict, новые пользовательские свойства ресурса
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

ResourceObject

yadisk.functions.resources.get_files(session, **kwargs)[исходный код]

Получить плоский список всех файлов (без папок).

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • offset – отступ от начала списка
  • limit – максимальное количество элементов списка
  • media_type – тип файлов, которые будут включены в список
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор ResourceObject

yadisk.functions.resources.get_last_uploaded(session, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • limit – максимальное число элементов в списке
  • media_type – тип файлов, которые будут включены в список
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

генератор LastUploadedResourceListObject

yadisk.functions.resources.upload_url(session, url, path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • url – исходный URL
  • path – путь назначения
  • disable_redirectsbool, запретить делать перенаправления
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

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

Получает ссылку на скачивание публичного ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

yadisk.functions.resources.download_public(session, public_key, file_or_path, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к публичному ресурсу
  • file_or_path – путь назначения или файл-подобный объект
  • path – относительный путь к ресурсу внутри публичной папки
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
yadisk.functions.operations.get_operation_status(session, operation_id, **kwargs)[исходный код]

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

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • operation_id – идентификатор операции или ссылка на нее
  • fields – список ключей, которые будут включены в ответ
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
Результат:

str

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

class yadisk.api.APIRequest(session, args, **kwargs)[исходный код]

Базовый класс для всех объектов запросов к REST API.

Параметры:
  • session – объект requests.Session
  • argsdict, аргументы, которые будут перданы в process_args
  • timeoutfloat или tuple, таймаут запроса
  • headersdict или None, дополнительные заголовки запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • retry_interval – задержка между повторными попытками в секундах
  • kwargs – другие аргументы для requests.Session.send
Переменные:
  • urlstr, URL запроса
  • methodstr, метод запроса
  • content_typestr, заголовок Content-Type («application/x-www-form-urlencoded» по умолчанию)
  • timeoutfloat или tuple, таймаут запроса
  • n_retriesint, максимальное число повторных попыток запроса
  • success_codeslist-подобный, список кодов ответов, означающих успех запроса
  • retry_intervalfloat, задержка между повторными попытками в секундах
prepare()[исходный код]

Готовит запрос

process()[исходный код]

Обрабатывает ответ.

Результат:зависит от self.process_json()
process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
send()[исходный код]
Отправляет запрос
Результат:requests.Response (self.response)
class yadisk.api.auth.RefreshTokenRequest(session, refresh_token, client_id, client_secret, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для обновления существующего токена.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • refresh_token – refresh-токен, полученный вместе с токеном
  • client_id – идентификатор приложения
  • client_secret – пароль приложения
Результат:

TokenObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.auth.RevokeTokenRequest(session, token, client_id, client_secret, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для отзыва токена.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • token – токен, подлежащий отзыву
  • client_id – идентификатор приложения
  • client_secret – пароль приложения
Результат:

TokenRevokeStatusObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.auth.GetTokenRequest(session, code, client_id, client_secret, device_id=None, device_name=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения токена.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • code – код подтверждения
  • client_id – идентификатор приложения
  • client_secret – пароль приложения
  • device_id – уникальный идентификатор устройства (между 6 и 50 символами)
Результат:

TokenObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.disk.DiskInfoRequest(session, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения информации о диске.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • fields – список ключей, которые будут включены в ответ
Результат:

DiskInfoObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.GetPublicResourcesRequest(session, offset=0, limit=20, preview_size=None, preview_crop=None, type=None, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения списка публичных ресурсов.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • offset – отступ от начала списка
  • limit – максимальное число элементов в списке
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • type – фильтр по типу ресурса («file» или «dir»)
  • fields – список ключей, которые будут включены в ответ
Результат:

PublicResourcesListObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.UnpublishRequest(session, path, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для того, чтобы сделать публичный ресурс приватным.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу, подлежащему депубликации
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.GetDownloadLinkRequest(session, path, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения ссылки на скачивание ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к скачиваемому ресурсу
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.GetTrashRequest(session, path=None, offset=0, limit=20, sort=None, preview_size=None, preview_crop=None, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получния мета-информации о ресурсе корзины.

Параметры:
  • path – путь к ресурсу корзины
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • fields – список ключей, которые будут включены в ответ
Результат:

TrashResourceObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.RestoreTrashRequest(session, path, dst_path=None, force_async=False, overwrite=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для восстановления мусора.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к восстанавливаему ресурсу
  • dst_path – путь назначения
  • force_async – заставляет выполнять операцию асинхронно
  • overwritebool, определяет может ли путь назначения быть перезаписан
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject или OperationLinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.DeleteTrashRequest(session, path=None, force_async=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для удаления ресурса корзины.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу корзины, подлежащий удалению
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
Результат:

OperationLinkObject или None

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.LastUploadedRequest(session, limit=20, media_type=None, preview_size=None, preview_crop=None, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения списка последних загруженных файлов, отсортированного по дате загрузки.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • limit – максимальное число элементов в списке
  • media_type – тип файлов, которые будут включены в список
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
Результат:

LastUploadedResourceListObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.CopyRequest(session, src_path, dst_path, overwrite=False, force_async=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос копирования файла или папки.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • src_path – исходный путь
  • dst_path – путь назначения
  • overwrite – если True, путь назначения может быть перезаписан, иначе будет вызвана ошибка
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject или OperationLinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.GetMetaRequest(session, path, limit=None, offset=None, preview_size=None, preview_crop=None, sort=None, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получния мета-информации о ресурсе.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • limit – количество ресурсов в папке, которые будут включены в ответ
  • offset – количество ресурсов в папке, которые будут пропущены
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • fields – список ключей, которые будут включены в ответ
Результат:

ResourceObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.GetUploadLinkRequest(session, path, overwrite=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения ссылки для загрузки ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь назначения для загрузки файла
  • overwritebool, определяет, перезаписывать путь назначения или нет
  • fields – список ключей, которые будут включены в ответ
Результат:

ResourceUploadLinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.MkdirRequest(session, path, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для создания новой папки.

Параметры:
  • path – путь к папке, подлежащей созданию
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.PublishRequest(session, path, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для того, чтобы сделать ресурс публичным.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к публикуемому ресурсу
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.UploadURLRequest(session, url, path, disable_redirects=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для загрузки файла по URL.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • url – исходный URL
  • path – путь назначения
  • disable_redirectsbool, запретить делать перенаправления
  • fields – список ключей, которые будут включены в ответ
Результат:

OperationLinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.DeleteRequest(session, path, permanently=False, md5=None, force_async=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для удаления ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к удаляемому ресурсу
  • permanently – если True, ресурс будет безвозвратно удалён, иначе ресурс будет перемещён в корзину
  • force_async – заставляет выполнять операцию асинхронно
  • md5str, MD5 хэш файла, подлежащего удалению
  • fields – список ключей, которые будут включены в ответ
Результат:

OperationLinkObject или None

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.SaveToDiskRequest(session, public_key, name=None, path=None, save_path=None, force_async=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для сохранения публичного ресурса на диск.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к ресурсу
  • name – имя файла/папки, под которым будет сохранён ресурс
  • path – путь к копируемому ресурсу в публичной папке
  • save_path – путь к папке назначения (загрузки по умолчанию)
  • force_async – заставляет выполнять операцию асинхронно
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject или OperationLinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.GetPublicMetaRequest(session, public_key, offset=0, limit=20, path=None, sort=None, preview_size=None, preview_crop=None, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получния мета-информации о публичном ресурсе.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки. Указывая ключ опубликованной папки через public_key, вы можете запросить метаинформацию любого ресурса внутри неё.
  • offset – отступ от начала списка вложенных ресурсов
  • limit – максимальное количество элементов списка вложенных ресурсов
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • preview_size – размер превью файла
  • preview_cropbool, разрешить обрезку превью
  • fields – список ключей, которые будут включены в ответ
Результат:

PublicResourceObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.GetPublicDownloadLinkRequest(session, public_key, path=None, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения ссылки на скачивание публичного ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • public_key – публичный ключ или URL к ресурсу
  • path – относительный путь к ресурсу внутри публичной папки
  • fields – список ключей, которые будут включены в ответ
Результат:

LinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.MoveRequest(session, src_path, dst_path, force_async=False, overwrite=False, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для перемещения ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • src_path – исходный путь, подлежащий перемещению
  • dst_path – путь назначения
  • force_async – заставляет выполнять операцию асинхронно
  • overwritebool, определяет, перезаписывать путь назначения или нет
  • fields – список ключей, которые будут включены в ответ
Результат:

OperationLinkObject или LinkObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.FilesRequest(session, offset=0, limit=20, media_type=None, preview_size=None, preview_crop=None, sort=None, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения плоского списка всех файлов.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • offset – отступ от начала списка
  • limit – максимальное количество элементов списка
  • media_type – тип файлов, которые будут включены в список
  • sortstr, поле использумое для сортировки вложенных ресурсов
  • preview_size – размер превью файла
  • preview_cropbool, обрезает превью согласно размеру, заданному в preview_size
  • fields – список ключей, которые будут включены в ответ
Результат:

FilesResourceListObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.resources.PatchRequest(session, path, properties, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для обновления пользовательских свойств ресурса.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • path – путь к ресурсу
  • propertiesdict, новые пользовательские свойства ресурса
  • fields – список ключей, которые будут включены в ответ
Результат:

ResourceObject

prepare(*args, **kwargs)[исходный код]

Готовит запрос

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно
class yadisk.api.operations.GetOperationStatusRequest(session, operation_id, fields=None, **kwargs)[исходный код]
Базовые классы: yadisk.api.api_request.APIRequest

Запрос для получения статуса операции.

Параметры:
  • session – объект requests.Session с приготовленными заголовками
  • operation_id – идентификатор операции или ссылка на нее
  • fields – список ключей, которые будут включены в ответ
Результат:

OperationStatusObject

process_json(js)[исходный код]

Обрабатывает JSON ответ.

Параметры:jsdict, JSON ответ
Результат:обработанный ответ, может быть что угодно