AsyncDex API¶
This page contains all of the classes, attributes, and methods of the various parts of AsyncDex.
Client¶
-
class
asyncdex.MangadexClient(*, username: Optional[str] = None, password: Optional[str] = None, refresh_token: Optional[str] = None, sleep_on_ratelimit: bool = True, session: Optional[aiohttp.client.ClientSession] = None, api_url: str = 'https://api.mangadex.org', anonymous: bool = False, **session_kwargs)¶ The main client that runs preforms all of the method requests.
Warning
The client object should only be created under an async context. While it should be safe to initialize normally, the aiohttp ClientSession does not like this.
Warning
The client cannot ratelimit effectively if multiple clients are running on the same program. Furthermore, the ratelimit may not work if multiple other people are accessing the MangaDex API at the same time or the client is running on a shared network.
- Parameters
username (str) – The username of the user to authenticate as. Leave blank to not allow login to fetch a new refresh token. Specifying the username without specifying the password is an error.
password (str) – The password of the user to authenticate as. Leave blank to not allow login to fetch a new refresh token. Specifying the password without specifying the username is an error.
refresh_token (str) – The refresh token to use. Leaving the
usernameandpasswordparameters blank but specifying this parameter allows the client to make requests using the refresh token for as long as it is valid. Once the refresh token is invalid, if the username and password are not specified, the client will throwUnauthorized, unlesslogout()is used to set the client to anonymous mode.sleep_on_ratelimit (bool) – Whether or not to sleep when a ratelimit occurs or raise a
Ratelimit. Defaults to True.session (aiohttp.ClientSession) – The session object for the client to use. If one is not provided, the client will create a new session instead. This is useful for providing a custom session.
api_url (str) – The base URL for the MangaDex API. Useful for private instances or a testing environment. Should not include a trailing slash.
anonymous (bool) – Whether or not to force anonymous mode. This will clear the username and/or password.
session_kwargs – Optional keyword arguments to pass on to the
aiohttp.ClientSession.
-
async
__aenter__()¶ Allow the client to be used with
async withsyntax similar toaiohttp.ClientSession.
-
async
__aexit__(exc_type: Optional[Type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[traceback])¶ Exit the client and calls
logout(). This will also close the underlying session object.
-
__repr__() → str¶ Provide a string representation of the client.
- Returns
The string representation
- Return type
-
anonymous_mode: bool¶ Whether or not the client is operating in Anonymous Mode, where it only accesses public endpoints.
Updates a lot of authors at once, reducing the time needed to update tens or hundreds of authors.
New in version 0.2.
- Parameters
authors (Tuple[Author, ..]) – A tuple of all the authors (and artists) to update.
-
async
batch_chapters(*chapters: asyncdex.models.chapter.Chapter)¶ Updates a lot of chapters at once, reducing the time needed to update tens or hundreds of chapters.
New in version 0.3.
See also
- Parameters
chapters (Tuple[Chapter, ..]) – A tuple of all the chapters to update.
-
async
batch_groups(*groups: asyncdex.models.group.Group)¶ Updates a lot of groups at once, reducing the time needed to update tens or hundreds of groups.
New in version 0.3.
- Parameters
groups (Tuple[Group, ..]) – A tuple of all the groups to update.
-
async
batch_mangas(*mangas: asyncdex.models.manga.Manga)¶ Updates a lot of mangas at once, reducing the time needed to update tens or hundreds of mangas.
New in version 0.2.
- Parameters
mangas (Tuple[Manga, ..]) – A tuple of all the mangas to update.
-
async
convert_legacy(model: Type[_LegacyModelT], ids: List[int]) → Dict[int, _LegacyModelT]¶ Convert a list of legacy IDs to the new UUID system.
New in version 0.3.
- Parameters
- Returns
A dictionary mapping old IDs to instances of the model with the new UUIDs.
Note
Except for tags, all other models will be lazy models. However, batch methods exist for all other models.
- Return type
Get an author using it’s ID.
New in version 0.2.
Note
This method can also be used to get artists, since they are the same class.
Warning
This method returns a lazy Author instance. Call
Author.fetch()on the returned object to see any values.
-
get_chapter(id: str) → asyncdex.models.chapter.Chapter¶ Get a chapter using it’s ID.
New in version 0.3.
See also
Warning
This method returns a lazy Chapter instance. Call
Chapter.fetch()on the returned object to see any values.
-
get_group(id: str) → asyncdex.models.group.Group¶ Get a group using it’s ID.
New in version 0.3.
Warning
This method returns a lazy Group instance. Call
Group.fetch()on the returned object to see any values.
-
get_manga(id: str) → asyncdex.models.manga.Manga¶ Get a manga using it’s ID.
New in version 0.2.
See also
search().Warning
This method returns a lazy Manga instance. Call
Manga.fetch()on the returned object to see any values.
-
async
get_session_token()¶ Get the session token and store it inside the client.
-
async
get_tag(id: str) → asyncdex.models.tag.Tag¶ Get a tag using it’s ID.
New in version 0.2.
Note
In order to find a tag by the tag’s name, it is recommended to call
refresh_tag_cache()and then iterate overtag_cache.
-
get_user(id: str) → asyncdex.models.user.User¶ Get a user using it’s ID.
New in version 0.3.
Warning
This method returns a lazy User instance. Call
User.fetch()on the returned object to see any values.
-
async
logged_in_user() → asyncdex.models.user.User¶ Get the user that is currently logged in.
New in version 0.3.
-
async
login(username: Optional[str] = None, password: Optional[str] = None)¶ Logs in to the MangaDex API.
- Parameters
username (str) – Provide a username in order to make the client stop running in anonymous mode. Specifying the username without specifying the password is an error.
password (str) – Provide a password in order to make the client stop running in anonymous mode. Specifying the password without specifying the username is an error.
-
async
logout()¶ Log out from the API. If a refresh token exists, calls the logout route on the API. The username and password are cleared, and the client is put into anonymous mode.
-
password: Optional[str]¶ The password of the user that the client is logged in as. This will be None when the client is operating in anonymous mode.
-
async
ping()¶ Ping the server. This will throw an error if there is any error in making connections, whether with the client or the server.
New in version 0.3.
-
async
random_manga() → asyncdex.models.manga.Manga¶ Get a random manga.
New in version 0.2.
- Returns
A random manga.
- Return type
-
ratelimits: asyncdex.ratelimit.Ratelimits¶ The
Ratelimitsobject that the client is using.
-
refresh_token: Optional[str]¶ The refresh token that the client has obtained. This will be None when the client is operating in anonymous mode, as well as if the client has not obtained a refresh token from the API.
-
async
request(method: str, url: str, *, params: Optional[Mapping[str, Optional[Union[str, Sequence[str], bool, float]]]] = None, json: Optional[Any] = None, with_auth: bool = True, retries: int = 3, **session_request_kwargs) → aiohttp.client_reqrep.ClientResponse¶ Perform a request.
Warning
All requests have to be released, otherwise connections will not be reused. Make sure to call
aiohttp.ClientResponse.release()on the object returned by the method if you do not read data from the response.Note
The request method will log all URLs that are requested. Enable logging on the
asyncdexlogger to view them. These requests are made under theINFOlevel. Retries are also logged on theWARNINGlevel.Changed in version 0.3: Added a global (shared between all requests made in the client) ratelimit.
- Parameters
method (str) – The HTTP method to use for the request.
url (str) – The URL to use for the request. May be either an absolute URL or a URL relative to the base MangaDex API URL.
params (Mapping[str, Union[str, Sequence[str]]]) – Optional query parameters to append to the URL. If one of the values of the parameters is an array, the elements will be automatically added to the URL in the order that the array elements appear in.
json (Any) – JSON data to pass in a POST request.
with_auth (bool) – Whether or not to append the session token to the request headers. Requests made without the header will behave as if the client is in anonymous mode. Defaults to
True.retries (int) – The amount of times to retry. The function will recursively call itself, subtracting
1from the original count until retries run out.session_request_kwargs – Optional keyword arguments to pass to
aiohttp.ClientSession.request().
- Raises
Unauthorizedif the endpoint requires authentication and sufficient parameters for authentication were not provided to the client.- Returns
The response.
- Return type
-
session: aiohttp.client.ClientSession¶ The
aiohttp.ClientSessionthat the client will use to make requests.
-
property
session_token¶ The session token tht the client has obtained. This will be None when the client is operating in anonymous mode, as well as if the client has not obtained a refresh token from the API or if it has been roughly 15 minutes since the token was retrieved from the server.
-
tag_cache: Dict[str, asyncdex.models.tag.Tag]¶ A cache of tags. This cache will be used to lower the amount of tag objects, and allows for easily updating the attributes of tags. This cache can be refreshed manually by either calling
refresh_tag_cache()or fetching data for any tag object.New in version 0.2.
Models¶
-
class
asyncdex.models.abc.Model(client: MangadexClient, *, id: Optional[str] = None, version: int = 0, data: Optional[Dict[str, Any]] = None)¶ An abstract model. Cannot be instantiated.
New in version 0.2.
- Raises
Missingif there is no valid ID in the model after parsing provided data.- Parameters
data (Dict[str, Any]) – The data received from the server. May be None if there is no data yet.
-
__hash__()¶ Return hash(self).
-
client: MangadexClient¶ The client that created this model.
-
abstract async
fetch()¶ Fetch the data to complete any missing non-critical values.
- Raises
InvalidIDif an object with the ID does not exist.
-
abstract
parse(data: Dict[str, Any])¶ Parse the data received from the server.
- Parameters
data (Dict[str, Any]) – The data from the server.
-
class
asyncdex.models.Author(client: MangadexClient, *, id: Optional[str] = None, version: int = 0, data: Optional[Dict[str, Any]] = None)¶ A
Modelrepresenting an individual author.Note
Artists and authors are stored identically and share all properties.
New in version 0.2.
-
__hash__()¶ Return hash(self).
-
biographies: asyncdex.utils.DefaultAttrDict[Optional[str]]¶ A
DefaultAttrDictholding the biographies of the author.
-
client: MangadexClient¶ The client that created this model.
-
created_at: datetime¶ A
datetime.datetimerepresenting the object’s creation time.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
async
fetch()¶ Fetch the data to complete any missing non-critical values.
- Raises
InvalidIDif an object with the ID does not exist.
-
async
load_mangas()¶ Shortcut method that calls
Client.batch_mangas()with the mangas that belong to the author.Roughly equivalent to:
await client.batch_mangas(*author.mangas)
-
mangas: List[Manga]¶ A list of all the mangas that the author has written.
Note
In order to efficiently get all mangas in one go, use:
await client.batch_mangas(*author.mangas)
-
property
modified_at¶ The last time the object was modified. This will return the creation time if the object was never updated after creation, or the modification time if it has.
See also
- Returns
The last time the object was changed as a
datetime.datetimeobject.Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
- Return type
-
parse(data: Dict[str, Any])¶ Parse the data received from the server.
- Parameters
data (Dict[str, Any]) – The data from the server.
-
transfer(new_obj: _T)¶ Transfer data from a new object to the current object.
- Parameters
new_obj (Model) – The new object. Should be the same type as the current model.
-
updated_at: Optional[datetime]¶ A
datetime.datetimerepresenting the last time the object was updated. May be None if the object was never updated after creation.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
-
class
asyncdex.models.Chapter(client: MangadexClient, *, id: Optional[str] = None, version: int = 0, data: Optional[Dict[str, Any]] = None)¶ A
Modelrepresenting an individual chapter.New in version 0.3.
-
__ge__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than or equal to the other model’s creation time.
- Return type
-
__gt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than the other model’s creation time.
- Return type
-
__hash__()¶ Return hash(self).
-
__le__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than or equal to the other model’s creation time.
- Return type
-
__lt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than the other model’s creation time.
- Return type
-
client: MangadexClient¶ The client that created this model.
-
created_at: datetime¶ A
datetime.datetimerepresenting the object’s creation time.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
data_saver_page_names: List[str]¶ A list of strings containing the filenames of the data saver pages.
See also
-
async
download_chapter(*, folder_format: str = '{manga}/{chapter_num}{separator}{title}', file_format: str = '{num}', as_bytes_list: bool = False, overwrite: bool = True, retries: int = 3, use_data_saver: bool = False, ssl_only: bool = False) → Optional[List[bytes]]¶ Download all of the pages of the chapter and either save them locally to the filesystem or return the raw bytes.
- Parameters
folder_format (str) –
The format of the folder to create for the chapter. The folder can already be existing. The default format is
{manga}/{chapter_num}{separator}{chapter_title}.Note
Specify
.if you want to save the pages in the current folder.Available variables:
{manga}: The name of the manga. If the chapter’s manga object does not contain a title object, it will be fetched.{chapter_num}: The number of the chapter, if it exists.{separator}: A separator if both the chapter’s number and title exists.{title}: The title of the chapter, if it exists.
file_format (str) –
The format of the individual image file names. The default format is
{num}.Note
The file extension is applied automatically from the real file name. There is no need to include it.
Available variables:
{num}: The numbering of the image files starting from 1. This respects the order the images are in inside ofpage_names.{num0}: The same as{num}but starting from 0.{name}: The actual filename of the image frompage_names, without the file extension.
as_bytes_list (bool) – Whether or not to return the pages as a list of raw bytes. Setting this parameter to
Truewill ignore the value of thefolder_formatparameter.overwrite (bool) – Whether or not to override existing files with the same name as the page. Defaults to
True.retries (int) – How many times to retry a chapter if a MD@H node does not let us download the pages. Defaults to
3.use_data_saver (bool) – Whether or not to use the data saver pages or the normal pages. Defaults to
False.ssl_only (bool) –
Whether or not the given URL has port
443. Useful if your firewall blocks outbound connections to ports that are not port443. Defaults toFalse.Note
This will lower the pool of available clients and can cause higher download times.
- Raises
aiohttp.ClientResponseErrorif there is an error after all retries are exhausted.- Returns
A list of byte strings if
as_bytes_listisTrueelse None.- Return type
Optional[List[bytes]]
-
async
fetch()¶ Fetch the data to complete any missing non-critical values.
- Raises
InvalidIDif an object with the ID does not exist.
-
async
get_page(url: str) → aiohttp.client_reqrep.ClientResponse¶ A method to download one page of a chapter, using the URLs from
pages(). This method is more low-level so that it is not necessary to download all pages at once. This method also respects the API rules on downloading pages.- Parameters
url (str) – The URL to download.
- Raises
aiohttp.ClientResponseErrorif a 4xx or 5xx response code is returned.- Returns
The
aiohttp.ClientResponseobject containing the image.- Return type
-
groups: List[asyncdex.models.group.Group]¶ The groups that uploaded this chapter.
-
async
load_groups()¶ Shortcut method that calls
Client.batch_groups()with the groups that belong to the group.Roughly equivalent to:
await client.batch_groups(*user.groups)
-
property
modified_at¶ The last time the object was modified. This will return the creation time if the object was never updated after creation, or the modification time if it has.
See also
- Returns
The last time the object was changed as a
datetime.datetimeobject.Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
- Return type
-
property
name¶ Returns a nicely formatted name based on available fields. Includes the volume number, chapter number, and chapter title if any one or more of them exist.
- Returns
Formatted name
- Return type
-
number: Optional[str]¶ The number of the chapter.
Noneif the chapter is un-numbered (such as in an anthology).Note
A chapter can have a number, a title, or both. If a chapter’s number is
None, it must have a title.
-
async
pages(*, data_saver: bool = False, ssl_only: bool = False) → List[str]¶ Get fully formatted page URLs.
Note
The given page URLs are only valid for a short timeframe. These URLs cannot be used for hotlinking.
- Parameters
data_saver (bool) – Whether or not to return the pages for the data saver URLs. Defaults to
False.ssl_only (bool) –
Whether or not the given URL has port
443. Useful if your firewall blocks outbound connections to ports that are not port443. Defaults toFalse.Note
This will lower the pool of available clients and can cause higher latencies.
- Returns
A list of valid URLs in the order of the pages.
- Return type
List[str]
-
parse(data: Dict[str, Any])¶ Parse the data received from the server.
- Parameters
data (Dict[str, Any]) – The data from the server.
-
publish_time: datetime.datetime¶ A
datetime.datetimerepresenting the time the chapter was published.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
property
sorting_number¶ Returns
0if the chapter does not have a number, otherwise returns the chapter’s number.- Returns
A number usable for sorting.
- Return type
-
title: Optional[str]¶ The title of the chapter.
Noneif the chapter does not have a title.Note
A chapter can have a number, a title, or both. If a chapter’s title is
None, it must have a number.
-
transfer(new_obj: _T)¶ Transfer data from a new object to the current object.
- Parameters
new_obj (Model) – The new object. Should be the same type as the current model.
-
updated_at: Optional[datetime]¶ A
datetime.datetimerepresenting the last time the object was updated. May be None if the object was never updated after creation.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
user: asyncdex.models.user.User¶ The user that uploaded this chapter.
-
-
class
asyncdex.models.Group(client: MangadexClient, *, id: Optional[str] = None, version: int = 0, data: Optional[Dict[str, Any]] = None)¶ A
Modelrepresenting an individual scanlation group.New in version 0.3.
-
__ge__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than or equal to the other model’s creation time.
- Return type
-
__gt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than the other model’s creation time.
- Return type
-
__hash__()¶ Return hash(self).
-
__le__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than or equal to the other model’s creation time.
- Return type
-
__lt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than the other model’s creation time.
- Return type
-
client: MangadexClient¶ The client that created this model.
-
created_at: datetime¶ A
datetime.datetimerepresenting the object’s creation time.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
async
fetch()¶ Fetch the data to complete any missing non-critical values.
- Raises
InvalidIDif an object with the ID does not exist.
-
leader: asyncdex.models.user.User¶ The user who created the group.
-
async
load_chapters()¶ Shortcut method that calls
Client.batch_chapters()with the chapters that belong to the group.Roughly equivalent to:
await client.batch_chapters(*user.chapters)
-
members: List[asyncdex.models.user.User]¶ Users who are members of the group.
-
property
modified_at¶ The last time the object was modified. This will return the creation time if the object was never updated after creation, or the modification time if it has.
See also
- Returns
The last time the object was changed as a
datetime.datetimeobject.Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
- Return type
-
parse(data: Dict[str, Any])¶ Parse the data received from the server.
- Parameters
data (Dict[str, Any]) – The data from the server.
-
transfer(new_obj: _T)¶ Transfer data from a new object to the current object.
- Parameters
new_obj (Model) – The new object. Should be the same type as the current model.
-
updated_at: Optional[datetime]¶ A
datetime.datetimerepresenting the last time the object was updated. May be None if the object was never updated after creation.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
-
class
asyncdex.models.Manga(client: MangadexClient, *, id: Optional[str] = None, version: int = 0, data: Optional[Dict[str, Any]] = None)¶ A
Modelrepresenting an individual manga.New in version 0.2.
-
__ge__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than or equal to the other model’s creation time.
- Return type
-
__gt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than the other model’s creation time.
- Return type
-
__hash__()¶ Return hash(self).
-
__le__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than or equal to the other model’s creation time.
- Return type
-
__lt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than the other model’s creation time.
- Return type
-
property
amazon_url¶ Returns a formatted url for the manga’s Amazon entry if it exists.
Note
While the MangaDex API currently returns fully formatted URLs for the
amazon_idattribute, this may change in the future. This property will always return a fully formatted URL.
-
property
anilist_url¶ Returns a formatted url for the manga’s Anilist entry if it exists.
- Returns
A full URL or None if
anilist_idis None.- Return type
-
property
animeplanet_url¶ Returns a formatted url for the manga’s AnimePlanet entry if it exists.
- Returns
A full URL or None if
animeplanet_idis None.- Return type
-
artists: List[asyncdex.models.author.Author]¶ A list of
Authorobjects that represent the manga’s artists.See also
Note
In order to efficiently get all authors and artists in one go, use
load_authors().
A list of
Authorobjects that represent the manga’s authors.See also
Note
In order to efficiently get all authors and artists in one go, use
load_authors().
-
property
bookwalker_url¶ Returns a formatted url for the manga’s Bookwalker entry if it exists.
- Returns
A full URL or None if
bookwalker_idis None.- Return type
-
property
cdjapan_url¶ Returns a formatted url for the manga’s CDJapan entry if it exists.
Note
While the MangaDex API currently returns fully formatted URLs for the
cdjapan_idattribute, this may change in the future. This property will always return a fully formatted URL.- Returns
A full URL or None if
cdjapan_idis None.- Return type
-
chapters: asyncdex.models.chapter.ChapterList¶ A
ChapterListrepresenting the chapters of the manga.New in version 0.3.
-
client: MangadexClient¶ The client that created this model.
-
created_at: datetime¶ A
datetime.datetimerepresenting the object’s creation time.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
demographic: asyncdex.enum.Demographic¶ The manga’s demographic.
-
descriptions: asyncdex.utils.DefaultAttrDict[Optional[str]]¶ A
DefaultAttrDictholding the descriptions of the manga.Note
If a language is missing a description,
Nonewill be returned.
-
property
ebookjapan_url¶ Returns a formatted url for the manga’s EbookJapan entry if it exists.
Note
While the MangaDex API currently returns fully formatted URLs for the
ebookjapan_idattribute, this may change in the future. This property will always return a fully formatted URL.- Returns
A full URL or None if
ebookjapan_idis None.- Return type
-
english_translation_url: Optional[str]¶ The URL for the official English translation of the manga, if it exists.
-
async
fetch()¶ Fetch the data to complete any missing non-critical values.
- Raises
InvalidIDif an object with the ID does not exist.
-
property
kitsu_url¶ Returns a formatted url for the manga’s Kitsu entry if it exists.
-
last_chapter: Optional[str]¶ The last chapter of the manga.
Noneif it is not specified or does not exist.Changed in version 0.3: Changed to a string in order to better match the API specification.
-
last_volume: Optional[str]¶ The last volume of the manga.
Noneif it is not specified or does not exist.Changed in version 0.3: Changed to a string in order to better match the API specification.
Shortcut method that calls
Client.batch_authors()with the authors and artists that belong to the manga.Roughly equivalent to:
await client.batch_authors(*manga.authors, *manga.artists)
-
property
mangaupdates_url¶ Returns a formatted url for the manga’s MangaUpdates entry if it exists.
- Returns
A full URL or None if
mangaupdates_idis None.- Return type
-
property
modified_at¶ The last time the object was modified. This will return the creation time if the object was never updated after creation, or the modification time if it has.
See also
- Returns
The last time the object was changed as a
datetime.datetimeobject.Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
- Return type
-
property
myanimelist_url¶ Returns a formatted url for the manga’s MyAnimeList entry if it exists.
- Returns
A full URL or None if
myanimelist_idis None.- Return type
-
property
novelupdates_url¶ Returns a formatted url for the manga’s NovelUpdates entry if it exists.
- Returns
A full URL or None if
novelupdates_idis None.- Return type
-
parse(data: Dict[str, Any])¶ Parse the data received from the server.
- Parameters
data (Dict[str, Any]) – The data from the server.
-
rating: asyncdex.enum.ContentRating¶ The manga’s content rating.
-
status: asyncdex.enum.MangaStatus¶ The manga’s status.
A list of
Tagobjects that represent the manga’s tags. A manga without tags will have an empty list.
-
titles: asyncdex.utils.DefaultAttrDict[asyncdex.models.title.TitleList]¶ A
DefaultAttrDictholding the titles of the manga.
-
transfer(new_obj: _T)¶ Transfer data from a new object to the current object.
- Parameters
new_obj (Model) – The new object. Should be the same type as the current model.
-
updated_at: Optional[datetime]¶ A
datetime.datetimerepresenting the last time the object was updated. May be None if the object was never updated after creation.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
-
class
asyncdex.models.Tag(client: MangadexClient, *, id: Optional[str] = None, version: int = 0, data: Optional[Dict[str, Any]] = None)¶ A
Modelrepresenting a tag in a Manga.New in version 0.2.
-
__hash__()¶ Return hash(self).
-
client: MangadexClient¶ The client that created this model.
-
async
fetch()¶ Fetch the data to complete any missing non-critical values.
- Raises
InvalidIDif an object with the ID does not exist.
-
names: asyncdex.utils.DefaultAttrDict[Optional[str]]¶ A
DefaultAttrDictholding the names of the tag.Note
If a language is missing a name,
Nonewill be returned.
-
parse(data: Dict[str, Any])¶ Parse the data received from the server.
- Parameters
data (Dict[str, Any]) – The data from the server.
-
-
class
asyncdex.models.User(client: MangadexClient, *, id: Optional[str] = None, version: int = 0, data: Optional[Dict[str, Any]] = None)¶ A
Modelrepresenting an individual user.New in version 0.3.
-
__hash__()¶ Return hash(self).
-
client: MangadexClient¶ The client that created this model.
-
async
fetch()¶ Fetch the data to complete any missing non-critical values.
- Raises
InvalidIDif an object with the ID does not exist.
-
async
load_chapters()¶ Shortcut method that calls
Client.batch_chapters()with the chapters that belong to the user.Roughly equivalent to:
await client.batch_chapters(*user.chapters)
-
parse(data: Dict[str, Any])¶ Parse the data received from the server.
- Parameters
data (Dict[str, Any]) – The data from the server.
-
Exceptions¶
-
exception
asyncdex.exceptions.AsyncDexException¶ Base exception class for all exceptions by the package.
-
exception
asyncdex.exceptions.Ratelimit(path: str, ratelimit_amount: int, ratelimit_expires: datetime.datetime)¶ An exception raised if
MangadexClient.sleep_on_ratelimitis set to False.-
path: str¶ The route that was taken that hit the ratelimit. This will match the path in the MangaDex API Documentation.
-
ratelimit_amount: int¶ How many calls to this path can be made once the ratelimit expires without being ratelimited again.
-
ratelimit_expires: datetime.datetime¶ A
datetime.datetimeobject in UTC time representing when the ratelimit will expire.
-
-
exception
asyncdex.exceptions.HTTPException(path: str, response: aiohttp.client_reqrep.ClientResponse)¶ Exceptions for HTTP status codes.
-
response: aiohttp.client_reqrep.ClientResponse¶ The
aiohttp.ClientResponseobject from the request.
-
An exception raised if a request to an endpoint requiring authorization is made where the client cannot authorize using provided information.
The
aiohttp.ClientResponseobject from the request. May beNoneif a user tries to login without stored credentials.
-
exception
asyncdex.exceptions.Missing(attribute: str, model: Optional[str] = None)¶ An exception raised if a response is missing a critical element for a model.
New in version 0.2.
- Parameters
model (str) – The name of the model that requires the attribute. Can be empty.
-
exception
asyncdex.exceptions.InvalidID(id: str, model: Type[Model])¶ An exception raised if an invalid ID is given to any of the
get_*methods representing that an item with this ID does not exist.New in version 0.2.
-
model: Type[Model]¶ The model that would have been returned had the ID been valid.
-
Enums¶
-
class
asyncdex.enum.Demographic(value)¶ An Enum representing the various demographics. Source: https://api.mangadex.org/docs.html#section/Static-data/Manga-publication-demographic.
New in version 0.2.
-
JOSEI= 'josei'¶ A Josei Manga.
Changed in version 0.3: The typo for this field has been corrected.
-
SEINEN= 'seinen'¶ A Seinen Manga.
-
SHOUJO= 'shoujo'¶ A Shoujo Manga.
-
SHOUNEN= 'shounen'¶ A Shounen Manga.
Note
In the developer documentation as of May 7, 2021, there is a typo in the word
Shounen, where it is spelled without theu. However, the actual API will only recognize the variant including au. For the library, both variations can be used for the enum.
-
-
class
asyncdex.enum.MangaStatus(value)¶ An Enum representing the various statuses a manga can have. Source: https://api.mangadex.org/docs.html#section/Static-data/Manga-status
New in version 0.2.
Note
The status of the manga does not dictate whether or not the chapter list will be stable. Scanlation teams may have not published all chapters up to the completion of updates, so the manga may still get new chapters, especially in different languages. The only way to know if a manga has actually finished updating is by checking if the “end chapter” is present in the current language. Even this is not a guarantee, as an author may add additional media accompanying the work, such as a extra page related to the manga on Twitter or Pixiv, especially for manga that are mainly published online. The labels shown for a manga’s status should not dictate the policy for update checking, as they are only meant to be an aid for end users and not actually representative of the immutability of the manga’s chapter list.
-
CANCELLED= 'cancelled'¶ A manga where the author has intentionally stopped publishing new chapters.
Changed in version 0.3: The MangaDex API changed the value from
abandonedtocancelled.MangaStatus.ABANDONEDwill continue to represent the right value, but calling the enum withabandonedwill not.
-
COMPLETED= 'completed'¶ A manga that has finished publication.
-
HIATUS= 'hiatus'¶ A manga where the author is on a known hiatus.
-
ONGOING= 'ongoing'¶ A manga that is actively being published, in volume format, in a magazine like Weekly Shonen, or online.
-
-
class
asyncdex.enum.FollowStatus(value)¶ An Enum representing the status that the user has marked the manga has. Source: https://api.mangadex.org/docs.html#section/Static-data/Manga-reading-status
New in version 0.2.
-
COMPLETED= 'completed'¶ A manga that the user has marked as completed.
Warning
When a manga is marked as completed, the MangaDex API drops all chapter read markers. Setting a manga as completed will result in the deletion of data. Be very careful!
-
DROPPED= 'dropped'¶ A manga that the user has marked as dropped.
-
ON_HOLD= 'on_hold'¶ A manga that the user has marked as on_hold.
-
PLAN_TO_READ= 'plan_to_read'¶ A manga that the user has marked as plan_to_read.
-
READING= 'reading'¶ A manga that the user has marked as reading.
-
RE_READING= 're_reading'¶ A manga that the user has marked as re_reading.
-
-
class
asyncdex.enum.ContentRating(value)¶ An Enum representing the content in a manga. Source: https://api.mangadex.org/docs.html#section/Static-data/Manga-content-rating
New in version 0.2.
-
EROTICA= 'erotica'¶ A manga that is erotica.
Note
This type of content represents content tagged with the
Smuttag.
-
PORNOGRAPHIC= 'pornographic'¶ A manga that is pornographic.
Note
This type of content was the only type of content that MangaDex’s old 18+ filter used to block. This type of content was also the type of content that old MangaDex APIs used to call “hentai”.
-
SAFE= 'safe'¶ A manga that is safe.
Note
This is the only content rating that means a manga is safe for work. All other values are not safe for work (NSFW).
-
SUGGESTIVE= 'suggestive'¶ A manga that is suggestive.
Note
This type of content represents content tagged with the
Ecchitag.
-
-
class
asyncdex.enum.Visibility(value)¶ An enum representing the visibility of an
CustomList. Source: https://api.mangadex.org/docs.html#section/Static-data/CustomList-visibilityNew in version 0.2.
-
PRIVATE= 'private'¶ A private
CustomList.
-
PUBLIC= 'public'¶ A public
CustomList.
-
-
class
asyncdex.enum.Relationship(value)¶ An enum representing the different types of relationship types. Source: https://api.mangadex.org/docs.html#section/Static-data/Relationship-types
New in version 0.2.
-
CUSTOM_LIST= 'custom_list'¶ A
CustomListresource.
-
-
class
asyncdex.enum.DuplicateResolutionAlgorithm(value)¶ An enum representing the various methods of resolving duplicate chapters in the same language.
New in version 0.3.
Note
The filtering algorithms are short-circuiting, meaning that once the chapters for a certain chapter number is lowered down to one item, it will be returned.
Operation order:
Previous group
Specific Group
Specific User
Creation Date ascending/descending/Views ascending/descending
Note
It is an error to specify more than one of the lowest-priority operations, since they all return only one value. Doing so will raise an error.
-
CREATION_DATE_ASC= 4¶ A resolution strategy that will select the chapter that was created first.
See also
-
CREATION_DATE_DESC= 5¶ A resolution strategy that will select the chapter that was created last.
See also
-
PREVIOUS_GROUP= 1¶ A resolution strategy that attempts to use the same group for the chapter as the previous chapter. This needs an accompanying strategy to determine the initial group.
See also
-
SPECIFIC_GROUP= 2¶ A resolution strategy that attempts to only select certain groups. This needs an accompanying strategy for chapters where the group is not present.
See also
-
SPECIFIC_USER= 3¶ A resolution strategy that attempts to only select chapters by certain users. This needs an accompanying strategy for chapters where the user ia not present.
See also
-
VIEWS_ASC= 6¶ A resolution strategy that will select the chapter with the least views.
Warning
This is not implemented yet as the API does not return view counts.
See also
Constants¶
-
asyncdex.constants.invalid_folder_name_regex¶ The regex for invalid folder names.
Contains:
- Windows/MacOS/Linux restricted characters:
<>:"/\|?*
All control characters from
0x0through0x31inclusive.- Windows restricted filename:
CONPRNAUXNULCOM1COM2COM3COM4COM5COM6COM7COM8COM9LPT1LPT2LPT3LPT4LPT5LPT6LPT7LPT8LPT9
Source: https://stackoverflow.com/a/31976060/12248328
New in version 0.3.
-
asyncdex.constants.ratelimit_data: List[asyncdex.ratelimit.PathRatelimit]¶ These are the ratelimit rules taken from the API Docs.
Note
The API rules given here do not reflect all possible API ratelimit rules. The client will automatically ratelimit when appropriate headers are sent by the API. Check the latest API rules at the official API documentation.
Changed in version 0.3.
Ratelimit¶
-
class
asyncdex.ratelimit.Path(name: str, path_regex: re.Pattern, method: Optional[str] = None)¶ A Path object representing a various path.
-
method: Optional[str] = None¶ The HTTP method for the path. Leave None if ratelimit applies to all methods.
-
name: str¶ The name of the path. This will be the value provided by
Ratelimit.path.
-
path_regex: re.Pattern¶ A compiled regex pattern matching the path, used when the path has a variable, such as
/action/{id}.
-
-
class
asyncdex.ratelimit.PathRatelimit(path: asyncdex.ratelimit.Path, ratelimit_amount: int, ratelimit_time: int)¶ An object that allows the request method to check the ratelimit before making a response.
-
expire()¶ Expire the ratelimit.
-
path: asyncdex.ratelimit.Path¶ A
Pathobject.
-
ratelimit_amount: int¶ Analogous to
Ratelimit.ratelimit_amount
-
ratelimit_expires: datetime.datetime = datetime.datetime(1, 1, 1, 0, 0)¶ Analogous to
Ratelimit.ratelimit_expires
-
time_until_expire() → datetime.timedelta¶ Returns a
datetime.timedeltarepresenting the amount of seconds for the ratelimit to expire.
-
update(response: aiohttp.client_reqrep.ClientResponse)¶ Update the path’s ratelimit based on the headers.
- Parameters
response (aiohttp.ClientResponse) – The response object.
-
-
class
asyncdex.ratelimit.Ratelimits(*ratelimits: asyncdex.ratelimit.PathRatelimit)¶ An object holding all of the various ratelimits.
- Parameters
ratelimits (PathRatelimit) – The
PathRatelimitobject.
-
__repr__() → str¶ Provide a string representation of the object.
- Returns
The string representation
- Return type
-
add(obj: asyncdex.ratelimit.PathRatelimit)¶ Add a new ratelimit. If the path is the same as an existing path, it will be overwritten.
- Parameters
obj (PathRatelimit) – The new ratelimit object to add.
-
async
check(url: str, method: str) → Tuple[float, Optional[asyncdex.ratelimit.PathRatelimit]]¶ Check if a path is ratelimited.
- Parameters
- Returns
A number representing the amount of seconds before ratelimit expire or -1 if there is no need to ratelimit as well as the
PathRatelimitobject if found.- Return type
-
ratelimit_dictionary: Dict[re.Pattern, asyncdex.ratelimit.PathRatelimit]¶ A dictionary where the keys are regex patterns representing the paths and the values are
PathRatelimitobjects.
-
remove(obj: asyncdex.ratelimit.PathRatelimit)¶ Remove a ratelimit.
- Parameters
obj (PathRatelimit) – The new ratelimit object to remove.
-
async
sleep(url: str, method: str) → Optional[asyncdex.ratelimit.PathRatelimit]¶ Helper function that sleeps the amount of time returned by
check().- Parameters
- Returns
The
PathRatelimitobject if found- Return type
Misc¶
-
asyncdex.utils.remove_prefix(prefix: str, string: str) → str¶ Remove a prefix from a string. This is a polyfill for Python versions <3.9.
-
class
asyncdex.utils.AttrDict¶ A
dictwhere keys can be accessed by attributes.New in version 0.2.
-
__repr__() → str¶ Provide a string representation of the object.
- Returns
The string representation
- Return type
-
-
class
asyncdex.utils.DefaultAttrDict(mapping_or_iterable: Optional[Union[Mapping[str, _VT], Iterable[Tuple[str, _VT]]]] = None, *, default: Callable[], _VT])¶ An
AttrDictwith a default.New in version 0.2.
-
__missing__(key: str) → _VT¶ Apply the default if a key does not exist.
- Parameters
key (str) – The key that is missing
- Returns
The new default
- Return type
Any
-
default¶ A callable that accepts no arguments and returns an instance of the value’s class.
-
-
asyncdex.utils.copy_key_to_attribute(source_dict: dict, key: str, obj: Any, attribute_name: Optional[str] = None, *, default: Any = Sentinel, transformation: Optional[Callable[[str], Any]] = None)¶ Copies the value of a dictionary’s key to an object.
New in version 0.2.
- Parameters
source_dict (dict) – The dictionary with the key and value.
key (str) – The key that has the value.
obj (Any) – The object to set the attribute of.
attribute_name (str) – The name of the attribute to set if the name of the key and the name of the attribute are different.
default (Any) – A default value to add if the value is not found.
transformation (Callable[[str], Any]) – A callable that will be executed on the value of the key. It should accept a
strand can return anything.
-
asyncdex.utils.parse_relationships(data: dict, obj: Model)¶ Parse the relationships available in a model.
New in version 0.2.
Changed in version 0.3: Added support for
Chapter,User, and :class:.Group` objects.
-
class
asyncdex.models.mixins.DatetimeMixin¶ A mixin for models with
created_atandupdated_atattributes.New in version 0.2.
-
__ge__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than or equal to the other model’s creation time.
- Return type
-
__gt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is greater than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is greater than the other model’s creation time.
- Return type
-
__le__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than or equal to the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than or equal to the other model’s creation time.
- Return type
-
__lt__(other: _T) → bool¶ Compares the two object’s creation times to find if the current model’s creation time is less than the other model’s creation time.
New in version 0.3.
- Parameters
other (DatetimeMixin) – The other model.
- Returns
Whether or not the current model’s creation time is less than the other model’s creation time.
- Return type
-
created_at: datetime.datetime¶ A
datetime.datetimerepresenting the object’s creation time.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
property
modified_at¶ The last time the object was modified. This will return the creation time if the object was never updated after creation, or the modification time if it has.
See also
- Returns
The last time the object was changed as a
datetime.datetimeobject.Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
- Return type
-
updated_at: Optional[datetime.datetime]¶ A
datetime.datetimerepresenting the last time the object was updated. May be None if the object was never updated after creation.See also
Note
The datetime is timezone aware as it is parsed from an ISO-8601 string.
-
-
class
asyncdex.models.title.TitleList(iterable=(), /)¶ An object representing a list of titles.
New in version 0.2.
-
class
asyncdex.models.ChapterList(manga: Manga, *, entries: Optional[Iterable[asyncdex.models.chapter.Chapter]] = None)¶ An object representing a list of chapters from a manga.
New in version 0.3.
- Parameters
entries (Iterable[Chapter]) – Pre-fill the ChapterList with the given entries.
-
__repr__() → str¶ Provide a string representation of the object.
- Returns
The string representation
- Return type
-
filter(*, locales: Optional[List[str]] = None, creation_time: Optional[asyncdex.utils.Interval[datetime.datetime]] = None, update_time: Optional[asyncdex.utils.Interval[datetime.datetime]] = None, publish_time: Optional[asyncdex.utils.Interval[datetime.datetime]] = None, views: Optional[asyncdex.utils.Interval[int]] = None, has_number: Optional[bool] = None, chapter_number_range: Optional[asyncdex.utils.Interval[float]] = None, chapter_numbers: Optional[asyncdex.utils.InclusionExclusionPair[Optional[float]]] = None, remove_duplicates: bool = False, duplicate_strategy: Optional[List[asyncdex.enum.DuplicateResolutionAlgorithm]] = None, duplicate_strategy_groups: Optional[List[asyncdex.models.group.Group]] = None, duplicate_strategy_users: Optional[List[asyncdex.models.user.User]] = None, groups: Optional[asyncdex.utils.InclusionExclusionPair[asyncdex.models.group.Group]] = None, users: Optional[asyncdex.utils.InclusionExclusionPair[asyncdex.models.user.User]] = None) → asyncdex.models.chapter.ChapterList¶ Filter the chapter list and return a new
ChapterList. Calling this method without specifying any additional filtering mechanisms will return a shallow copy of the list.The order of the filter will be as follows:
Filter the datetimes first
Filter by the intervals
Filter by the inclusion and exclusion pairs
Filter duplicates
- Parameters
locales (List[str]) – The locales that should be present in the chapters.
creation_time (Interval[datetime]) –
An
Intervalrepresenting the bounds of the chapter’s creation time.Interval.minwill select all chapters created after the given time, andInterval.maxwill select all chapters created before the given time.Note
The datetime objects needs to be a non-timezone aware datetime in UTC time. A datetime in any timezone can be converted to a naive UTC timezone by:
from datetime import timezone # dt is the datetime object. utc_naive = dt.astimezone(timezone.utc).replace(tzinfo=None)
Example intervals:
from asyncdex import Interval min_interval = Interval(min=datetime.datetime(2021, 1, 1)) max_interval = Interval(max=datetime.datetime(2021, 1, 1)) both = Interval(datetime.datetime(2021, 1, 1), datetime.datetime(2021, 5, 1))
update_time (Interval[datetime]) –
An
Intervalrepresenting the bounds of the chapter’s update time.Interval.minwill select all chapters updated after the given time, andInterval.maxwill select all chapters updated before the given time.Note
The datetime objects needs to be a non-timezone aware datetime in UTC time. A datetime in any timezone can be converted to a naive UTC timezone by:
from datetime import timezone # dt is the datetime object. utc_naive = dt.astimezone(timezone.utc).replace(tzinfo=None)
Example intervals:
from asyncdex import Interval min_interval = Interval(min=datetime.datetime(2021, 1, 1)) max_interval = Interval(max=datetime.datetime(2021, 1, 1)) both = Interval(datetime.datetime(2021, 1, 1), datetime.datetime(2021, 5, 1))
publish_time (Interval[datetime]) –
An
Intervalrepresenting the bounds of the chapter’s publish time.Interval.minwill select all chapters published after the given time, andInterval.maxwill select all chapters published before the given time.Note
The datetime objects needs to be a non-timezone aware datetime in UTC time. A datetime in any timezone can be converted to a naive UTC timezone by:
from datetime import timezone # dt is the datetime object. utc_naive = dt.astimezone(timezone.utc).replace(tzinfo=None)
Example intervals:
min_interval = Interval(min=datetime.datetime(2021, 1, 1)) max_interval = Interval(max=datetime.datetime(2021, 1, 1)) both = Interval(datetime.datetime(2021, 1, 1), datetime.datetime(2021, 5, 1))
An
Intervalof the views that a manga can have.Warning
The mangadex API does not return views yet, so specifying something for this parameter will result in
NotImplementedErrorbeing raised.Example intervals:
from asyncdex import Interval min_interval = Interval(min=100) max_interval = Interval(max=25000) both = Interval(100, 25000)
has_number (bool) – Only select chapters with valid numbers.
chapter_number_range (Interval[float]) –
An
Intervalof the number of the chapter.Note
Chapters without a number will be given a provisional number of 0 when sorted.
Example intervals:
from asyncdex import Interval min_interval = Interval(min=2) max_interval = Interval(max=20.5) both = Interval(2, 20.5)
chapter_numbers (InclusionExclusionPair[float]) –
An
InclusionExclusionPairdenoting the chapter numbers that are either included or excluded.Note
Chapters without a number will be given a provisional number of 0 when sorted.
Example inclusion/exclusion pairs:
from asyncdex import InclusionExclusionPair include = InclusionExclusionPair(include=[5, 6]) excluse = InclusionExclusionPair(exclude=[7, 8, 9.5])
remove_duplicates (bool) –
Whether or not to remove duplicate chapters, ie chapters with the same chapter number.
Note
This will not take locales into consideration. Make sure to specify a locale in the
localesparameter if you want duplicates filtered for a specific locale.duplicate_strategy (List[DuplicateResolutionAlgorithm]) –
The list of strategies used to resolve duplicates. See the values in
DuplicateResolutionAlgorithmto find the possible algorithms. By default, the strategy of choosing the previous group and the strategy of choosing the first chapter chronologically when there is no previous group will be used.Note
If an adequate strategy is not found for dealing with certain chapters, the fallback mechanism of selecting the chapter that was created first will be used.
duplicate_strategy_groups (List[Group]) –
The groups to use for
DuplicateResolutionAlgorithm.SPECIFIC_GROUP.Note
If the group is not present in all the chapters for a specific number, an alternate resolution algorithm will be used. Use the
include_groupsparam if you only want chapters from that group.duplicate_strategy_users (List[User]) –
The users to use for
DuplicateResolutionAlgorithm.SPECIFIC_USER.Note
If the user is not present in all the chapters for a specific number, an alternate resolution algorithm will be used. Use the
include_usersparam if you only want chapters from that user.users (InclusionExclusionPair[User]) – An
InclusionExclusionPairdenoting the users to include/exclude from the listing.groups (InclusionExclusionPair[Group]) – An
InclusionExclusionPairdenoting the groups to include/exclude from the listing.
- Returns
A filtered
ChapterList.Note
The filtered list is not cached in
Manga.chapters.- Return type
-
async
get(*, locales: Optional[List[str]] = None, created_after: Optional[datetime.datetime] = None, updated_after: Optional[datetime.datetime] = None, published_after: Optional[datetime.datetime] = None)¶ Gets the list of chapters.
- Parameters
locales (List[str]) – The locales to filter by.
created_after (datetime) –
Get chapters created after this date.
Note
The datetime object needs to be in UTC time. It does not matter if the datetime if naive or timezone aware.
updated_after (datetime) –
Get chapters updated after this date.
Note
The datetime object needs to be in UTC time. It does not matter if the datetime if naive or timezone aware.
published_after (datetime) –
Get chapters published after this date.
Note
The datetime object needs to be in UTC time. It does not matter if the datetime if naive or timezone aware.
-
class
asyncdex.models.pager.Pager(url: str, model: Type[_ModelT], client: MangadexClient, *, params: Optional[MutableMapping[str, Any]] = None, limit_size: int = 100)¶ A pager object which automatically paginates responses with an offset and limit combo.
New in version 0.3.
- Parameters
limit_size (int) – The maximum limit for each request. Defaults to
100.
-
__aiter__() → AsyncIterator[_ModelT]¶ Return an async iterator (itself)
- Returns
The Pager class.
- Return type
-
async
__anext__() → _ModelT¶ Return a model from the queue. If there are no items remaining, a request is made to fetch the next set of items.
- Returns
The new model.
- Return type
-
__repr__() → str¶ Provide a string representation of the object.
- Returns
The string representation
- Return type
-
client: MangadexClient¶ The client that is associated with the Pager.
-
class
asyncdex.utils.Interval(min: Optional[_T] = None, max: Optional[_T] = None, inclusive: bool = True)¶ A class representing an interval.
New in version 0.3.
-
inclusive: bool = True¶ Whether or not the interval includes the min and max values or only values after and before respectively are considered.
-
max: Optional[_T] = None¶ The maximum value of the interval.
-
min: Optional[_T] = None¶ The minimum value of the interval.
-
-
class
asyncdex.utils.InclusionExclusionPair(include: List[_T] = <factory>, exclude: List[_T] = <factory>)¶ A class representing an inclusion and exclusion pair.
New in version 0.3.
Note
It is an error to both include and exclude something.
-
exclude: List[_T]¶ Values that should not be present.
-
include: List[_T]¶ Values that should be present.
-