kavita_client.api.plugin.get_api_plugin_parse

Module Contents

Functions

asyncio

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

asyncio_detailed

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

sync

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

sync_detailed

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

API

async kavita_client.api.plugin.get_api_plugin_parse.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET, library_type: kavita_client.models.library_type.LibraryType | kavita_client.types.Unset = UNSET) → kavita_client.models.parse_result_dto.ParseResultDto | None

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

Args:

name (str | Unset): library_type (LibraryType | Unset): Members:

  • 0 — Manga

  • 1 — Comic (Flexible) (Comic)

  • 2 — Book

  • 3 — Image

  • 4 — Light Novel (LightNovel)

  • 5 — Comic (ComicVine)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

ParseResultDto

async kavita_client.api.plugin.get_api_plugin_parse.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET, library_type: kavita_client.models.library_type.LibraryType | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.parse_result_dto.ParseResultDto]

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

Args:

name (str | Unset): library_type (LibraryType | Unset): Members:

  • 0 — Manga

  • 1 — Comic (Flexible) (Comic)

  • 2 — Book

  • 3 — Image

  • 4 — Light Novel (LightNovel)

  • 5 — Comic (ComicVine)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[ParseResultDto]

kavita_client.api.plugin.get_api_plugin_parse.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET, library_type: kavita_client.models.library_type.LibraryType | kavita_client.types.Unset = UNSET) → kavita_client.models.parse_result_dto.ParseResultDto | None

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

Args:

name (str | Unset): library_type (LibraryType | Unset): Members:

  • 0 — Manga

  • 1 — Comic (Flexible) (Comic)

  • 2 — Book

  • 3 — Image

  • 4 — Light Novel (LightNovel)

  • 5 — Comic (ComicVine)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

ParseResultDto

kavita_client.api.plugin.get_api_plugin_parse.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET, library_type: kavita_client.models.library_type.LibraryType | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.parse_result_dto.ParseResultDto]

Parse a string and return Parsed information from it. Does not support any directory fallback parsing

Args:

name (str | Unset): library_type (LibraryType | Unset): Members:

  • 0 — Manga

  • 1 — Comic (Flexible) (Comic)

  • 2 — Book

  • 3 — Image

  • 4 — Light Novel (LightNovel)

  • 5 — Comic (ComicVine)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[ParseResultDto]