kavita_client.types

Contains some shared types for properties

Module Contents

Classes

File	Contains information for file uploads
Response	A response from an endpoint
Unset

Data

FileContent
FileTypes
RequestFiles
T
UNSET
__all__

API

class kavita_client.types.File

Contains information for file uploads

file_name: str | None = None

mime_type: str | None = None

payload: BinaryIO = None

to_tuple() → kavita_client.types.FileTypes

Return a tuple representation that httpx will accept for multipart/form-data

kavita_client.types.FileContent = None

kavita_client.types.FileTypes = None

kavita_client.types.RequestFiles = None

class kavita_client.types.Response

Bases: typing.Generic[kavita_client.types.T]

A response from an endpoint

content: bytes = None

headers: collections.abc.MutableMapping[str, str] = None

parsed: kavita_client.types.T | None = None

status_code: http.HTTPStatus = None

kavita_client.types.T = 'TypeVar(...)'

kavita_client.types.UNSET: kavita_client.types.Unset = 'Unset(...)'

class kavita_client.types.Unset

__bool__() → Literal[False]

kavita_client.types.__all__ = ['UNSET', 'File', 'FileTypes', 'RequestFiles', 'Response', 'Unset']