Типы

yadisk.types.AnyClient

Client или AsyncClient

псевдоним для Client | AsyncClient

yadisk.types.AnyResponse

Response или AsyncResponse

псевдоним для Response | AsyncResponse

yadisk.types.AsyncConsumeCallback

Функция обратного вызова (может быть асинхронной), которая вызывается для «потребления» тела HTTP-запроса

псевдоним для Callable[[bytes], None] | Callable[[bytes], Awaitable[None]]

class yadisk.types.AsyncFileLike(*args, **kwargs)

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

Данный протокол описывает минимальный набор методов для асинхронного файл-подобного объекта (открытого либо в бинарном или текстовом режиме).

async read(size: int = Ellipsis, /) → str | bytes

Считывает size байт или символов

Параметры:

size – int, число байт/символов, которые нужно считать

Результат:

данные, которые были прочитаны из файла

async seek(pos: int, whence: int = Ellipsis, /) → int

Выполняет операцию seek над файлом

Параметры:

• pos – int, позиция

• whence – int, 0 (абсолютное позиционирование), 1 (относительное позиционирование) или 2 (позиционирование относительно конца файла)

Результат:

int, абсолютная позиция внутри файла после операции seek

async tell() → int

Возвращает текущую позицию внутри файла

Результат:

int, текущая позиция внутри файла

async write(buffer: Any, /) → int

Записывает данные (содержащейся в buffer).

Параметры:

buffer – данные, которые нужно записать

Результат:

число записанных байт/символов

yadisk.types.AsyncFileOrPath

Используется для указания исходного файла для загрузки на сервер (асинхронный вариант)

псевдоним для str | bytes | BinaryIO | AsyncFileLike | Callable[[], AsyncIterator[bytes]]

yadisk.types.AsyncFileOrPathDestination

Используется для указания файла назначения, в который будут скачаны данные (асинхронный вариант)

псевдоним для str | bytes | BinaryIO | BinaryAsyncFileLike

yadisk.types.AsyncOpenFileCallback

Функция, которая используется для открытия локальных файлов (асинхронный вариант)

псевдоним для Callable[[str | bytes, Literal[„rb“] | Literal[„wb“]], Awaitable[BinaryAsyncFileLike]] | Callable[[str | bytes, Literal[„rb“] | Literal[„wb“]], Awaitable[BinaryIO]]

yadisk.types.AsyncPayload

Полезная нагрузка запроса - данные, которые будут загружены на сервер (асинхронный вариант)

псевдоним для bytes | Iterator[bytes] | AsyncIterator[bytes] | BinaryIO | BinaryAsyncFileLike

yadisk.types.AsyncSessionFactory

Функция, возвращающая объект AsyncSession

псевдоним для Callable[[], AsyncSession]

yadisk.types.AsyncSessionName

Имя асинхронной сессии (см. Доступные реализации сессий)

псевдоним для Literal[„aiohttp“] | Literal[„httpx“]

class yadisk.types.AvailableUntilVerbose

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

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

Переменные:

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

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

class yadisk.types.BinaryAsyncFileLike(*args, **kwargs)

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

Данный протокол описывает минимальный набор методов для асинхронного файл-подобного объекта, открытого в бинарном режиме.

async read(size: int = Ellipsis, /) → bytes

Считывает size байт.

Параметры:

size – int, число байт/символов, которые нужно считать

Результат:

данные, которые были прочитаны из файла

async seek(pos: int, whence: int = Ellipsis, /) → int

Выполняет операцию seek над файлом

Параметры:

• pos – int, позиция

• whence – int, 0 (абсолютное позиционирование), 1 (относительное позиционирование) или 2 (позиционирование относительно конца файла)

Результат:

int, абсолютная позиция внутри файла после операции seek

async tell() → int

Возвращает текущую позицию внутри файла

Результат:

int, текущая позиция внутри файла

async write(buffer: Any, /) → int

Записывает данные (содержащейся в buffer).

Параметры:

buffer – данные, которые нужно записать

Результат:

число записанных байт

yadisk.types.ConsumeCallback

Функция обратного вызова, которая вызывается для «потребления» тела HTTP-запроса

псевдоним для Callable[[bytes], None]

class yadisk.types.ExternalOrganizationIdVerbose

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

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

Переменные:

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

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

yadisk.types.FileOpenMode

Режим открытия файла для OpenFileCallback и AsyncOpenFileCallback

псевдоним для Literal[„rb“] | Literal[„wb“]

yadisk.types.FileOrPath

Используется для указания исходного файла для загрузки на сервер

псевдоним для str | bytes | BinaryIO | Callable[[], Iterator[bytes]]

yadisk.types.FileOrPathDestination

Используется для указания файла назначения, в который будут скачаны данные

псевдоним для str | bytes | BinaryIO

yadisk.types.HTTPMethod

Метод HTTP запроса

псевдоним для Literal[„GET“] | Literal[„POST“] | Literal[„PUT“] | Literal[„PATCH“] | Literal[„DELETE“] | Literal[„OPTIONS“] | Literal[„HEAD“] | Literal[„CONNECT“] | Literal[„TRACE“]

yadisk.types.Headers

Тип используемый для задания заголовков HTTP запросов

псевдоним для Mapping[str, str]

yadisk.types.JSON

Данные JSON (после парсинга)

псевдоним для dict | list | str | int | float | None

yadisk.types.OpenFileCallback

Функция, которая используется для открытия локальных файлов (как open)

псевдоним для Callable[[str | bytes, Literal[„rb“] | Literal[„wb“]], BinaryIO]

yadisk.types.OperationStatus

Статус асинхронной операции Яндекс.Диска

псевдоним для Literal[„in-progress“] | Literal[„success“] | Literal[„failed“]

class yadisk.types.PasswordVerbose

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

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

Переменные:

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

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

yadisk.types.Payload

Полезная нагрузка запроса - данные, которые будут загружены на сервер

псевдоним для bytes | Iterator[bytes] | BinaryIO

class yadisk.types.PublicSettings

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

Публичные настройки общего ресурса. Этот тип описывает входные данные для запросов, модифицирующих публичные настройки. См. также связанный с ним объект PublicSettingsObject.

Переменные:

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

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

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

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

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

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

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

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

Примечание

Как показывает практика, передача пустой строки в поле available_until отключает дату истечения доступа. Аналогично, пароль можно отключить, передав False или 0. Но подобное поведение не задокументировано.

class yadisk.types.PublicSettingsAccess

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

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

Переменные:

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

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

• user_ids – List[str], список идентификаторов пользователей

• group_ids – List[int], список идентификаторов групп

• department_ids – List[int], список идентификаторов подразделений

• rights – list[str], список прав доступа

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

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

• read: просмотр

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

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

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

yadisk.types.SessionFactory

Функция, возвращающая объект Session

псевдоним для Callable[[], Session]

yadisk.types.SessionName

Имя сессии (см. Доступные реализации сессий)

псевдоним для Literal[„httpx“] | Literal[„pycurl“] | Literal[„requests“]

yadisk.types.TimeoutParameter

Таймаут запроса (в секундах). Может быть числом, None или кортежем. Если таймаут задан как кортеж, то первое значение - таймаут соединения, а второе - таймаут чтения. Иначе, заданное значение используется для обоих таймаутов. Значение None означает отсутствие таймаута. Если в качестве таймаута передано значение ..., то используется таймаут по умолчанию (settings.DEFAULT_TIMEOUT или settings.DEFAULT_UPLOAD_TIMEOUT)

псевдоним для float | tuple[float | None, float | None] | None