Skip to content

client

This module has the client to connect to MAL API.

Client

An asynchronous client used to interact with the MAL API.

Parameters:

Name Type Description Default
client_id str

The MAL Client Id to be used with the requests.

 required
Source code in aniwrap/client.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class Client:
    """An asynchronous client used to interact with the MAL API.

    Args:
        client_id: The MAL Client Id to be used with the requests.
    """

    __slots__ = ("_http", "_serializer", "_anime", "_manga", "_forum")

    def __init__(self, client_id: str) -> None:
        self._http = services.HttpService(client_id=client_id)
        self._serializer = serializer.Serializer()
        self._anime = services.AnimeService(self._http, self._serializer)
        self._manga = services.MangaService(self._http, self._serializer)
        self._forum = services.ForumService(self._http, self._serializer)

    @property
    def anime(self) -> services.AnimeService:
        """The [`AnimeService`][aniwrap.AnimeService] used to make anime related requests."""
        return self._anime

    @property
    def manga(self) -> services.MangaService:
        """The [`MangaService`][aniwrap.MangaService] used to make manga related requests."""
        return self._manga

    @property
    def forum(self) -> services.ForumService:
        """The [`ForumService`][aniwrap.ForumService] used to make forum related requests."""
        return self._forum

    async def close(self) -> None:
        """Close the existing client session.

        !!! warning

            You will receive an error in your console if this is not called before the program terminates.
        """
        await self._http.close()

anime property 

anime: services.AnimeService

The AnimeService used to make anime related requests.

forum property 

forum: services.ForumService

The ForumService used to make forum related requests.

manga property 

manga: services.MangaService

The MangaService used to make manga related requests.

close async 

close() -> None

Close the existing client session.

Warning

You will receive an error in your console if this is not called before the program terminates.

Source code in aniwrap/client.py 
41
42
43
44
45
46
47
48
async def close(self) -> None:
    """Close the existing client session.

    !!! warning

        You will receive an error in your console if this is not called before the program terminates.
    """
    await self._http.close()

UserClient

An asynchronous client used to interact with the user methods of MAL API.

Parameters:

Name Type Description Default
access_token str

The access token that is generated using the MAL oauth flow.

required

Note

The access_token will be unique for each MAL user.

Source code in aniwrap/client.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class UserClient:
    """
    An asynchronous client used to interact with the user methods of MAL API.

    Args:
        access_token: The access token that is generated using the MAL oauth flow. 

    !!! Note    
        The `access_token` will be unique for each MAL user.
    """

    __slots__ = ("_http", "_serializer", "_user")

    def __init__(self, access_token: str) -> None:
        self._http = services.HttpService(access_token=access_token)
        self._serializer = serializer.Serializer()
        self._user = services.UserService(self._http, self._serializer)

    @property
    def user(self) -> services.UserService:
        """"""
        return self._user

    async def close(self) -> None:
        """Close the existing client session.

        !!! warning

            You will receive an error in your console if this is not called before the program terminates.
        """
        await self._http.close()

close async 

close() -> None

Close the existing client session.

Warning

You will receive an error in your console if this is not called before the program terminates.

Source code in aniwrap/client.py 
74
75
76
77
78
79
80
81
async def close(self) -> None:
    """Close the existing client session.

    !!! warning

        You will receive an error in your console if this is not called before the program terminates.
    """
    await self._http.close()