Типы

yadisk.types.AnyClient

Client или AsyncClient

alias of Union[Client, AsyncClient]

yadisk.types.AnyResponse

Response или AsyncResponse

alias of Union[Response, AsyncResponse]

yadisk.types.AsyncConsumeCallback

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

alias of Union[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

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

alias of Union[str, bytes, BinaryIO, AsyncFileLike, Callable[AsyncIterator[bytes]]]

yadisk.types.AsyncFileOrPathDestination

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

alias of Union[str, bytes, BinaryIO, BinaryAsyncFileLike]

yadisk.types.AsyncOpenFileCallback

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

alias of Union[Callable[Union[str, bytes], Union[Literal[„rb“], Literal[„wb“]], Awaitable[BinaryAsyncFileLike]], Callable[Union[str, bytes], Union[Literal[„rb“], Literal[„wb“]], Awaitable[BinaryIO]]]

yadisk.types.AsyncPayload

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

alias of Union[bytes, Iterator[bytes], AsyncIterator[bytes]]

yadisk.types.AsyncSessionFactory

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

alias of Callable[AsyncSession]

yadisk.types.AsyncSessionName

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

alias of Union[Literal[„aiohttp“], Literal[„httpx“]]

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-запроса

alias of Callable[bytes, None]

yadisk.types.FileOpenMode

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

alias of Union[Literal[„rb“], Literal[„wb“]]

yadisk.types.FileOrPath

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

alias of Union[str, bytes, BinaryIO, Callable[Iterator[bytes]]]

yadisk.types.FileOrPathDestination

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

alias of Union[str, bytes, BinaryIO]

yadisk.types.HTTPMethod

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

alias of Union[Literal[„GET“], Literal[„POST“], Literal[„PUT“], Literal[„PATCH“], Literal[„DELETE“], Literal[„OPTIONS“], Literal[„HEAD“], Literal[„CONNECT“], Literal[„TRACE“]]

yadisk.types.Headers

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

alias of Mapping[str, str]

yadisk.types.JSON

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

alias of Optional[Union[dict, list, str, int, float]]

yadisk.types.OpenFileCallback

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

alias of Callable[Union[str, bytes], Union[Literal[„rb“], Literal[„wb“]], BinaryIO]

yadisk.types.OperationStatus

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

alias of Union[Literal[„in-progress“], Literal[„success“], Literal[„failed“]]

yadisk.types.Payload

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

alias of Union[bytes, Iterator[bytes]]

yadisk.types.SessionFactory

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

alias of Callable[Session]

yadisk.types.SessionName

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

alias of Union[Literal[„httpx“], Literal[„pycurl“], Literal[„requests“]]

yadisk.types.TimeoutParameter

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

alias of Optional[Union[float, tuple[Optional[float], Optional[float]]]]