Coverage for anime_list_apis/api/ApiInterface.py : 100%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
|
"""LICENSE Copyright 2018 Hermann Krumrey <hermann@krumreyh.com>
This file is part of anime-list-apis.
anime-list-apis is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
anime-list-apis is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with anime-list-apis. If not, see <http://www.gnu.org/licenses/>. LICENSE"""
MediaUserData, AnimeUserData, MangaUserData AnimeListEntry, MangaListEntry, MediaListEntry
""" Defines methods that every API connector should implement """
self, id_type: IdType, cache: Cache = None, rate_limit_pause: float = 0.0 ): """ Initializes the Api interface. Intializes cache or uses the one provided. :param id_type: TheID type of the API Interface :param cache: The cache to use. If left as None, will use default cache :param rate_limit_pause: A duration in seconds that the API Interface will pause after a network operation to prevent being rate limited """
# Public Methods ----------------------------------------------------------
self, media_type: MediaType, _id: int or Id, fresh: bool = False ) -> Optional[MediaData]: """ Retrieves a single data object using the API Tries to get the cached value first, then checks Anilist :param media_type: The media type to retrieve :param _id: The ID to retrieve. May be either an int or an Id object :param fresh: Fetches a fresh, i.e. non-cached version :return: The Media Data or None if no valid data was found """
self, media_type: MediaType, _id: int or Id, username: str, fresh: bool = True ) -> Optional[MediaUserData]: """ Retrieves the user data of a single entry for a user :param media_type: The type of media to fetch :param _id: The ID to fetch :param username: The username for which to fetch :param fresh: Fetches a fresh, i.e. non-cached version :return: The MediaUserData object or None if not found """ IdType.ANILIST, media_type, _id, username )
media_type, self.__generate_id_obj(_id), username )
self, media_type: MediaType, username: str ) -> List[MediaUserData]: """ Retrieves a user's entire list with only the user data :param media_type: The media type to fetch the entries for :param username: The user for whom to fetch the entries for :return: The retrieves user data in a list """
self, media_type: MediaType, _id: int or Id, username: str, fresh: bool = False ) -> Optional[MediaListEntry]: """ Retrieves a user list entry. First checks for cached entries, otherwise fetches from anilist :param media_type: The media type to fetch :param _id: The ID to retrieve. May be and int or an Id object :param username: The user for which to fetch the entry :param fresh: Fetches a fresh, i.e. non-cached version :return: The entry for the user or None if the user doesn't have such an entry """ IdType.ANILIST, media_type, _id, username )
media_type, self.__generate_id_obj(_id), username )
self, media_type: MediaType, username: str ) -> List[MediaListEntry]: """ Retrieves a user's entire list Stores all entries in the cache upon completion :param media_type: The media type to fetch :param username: The username for which to fetch the list :return: The list of List entries """
self, media_type: MediaType, _id: int or Id, username: str, fresh: bool = False ) -> bool: """ Checks if an entry is in a user's list :param media_type: The media type to check for :param _id: The ID to check for :param username: The username for which to check :param fresh: Indicates if the most up-to-date results should be used :return: True if the id is in the list, False otherwise """
self, datas: List[MediaData] or MediaData, fresh: bool = False ) -> List[MediaData]: """ Retrieves related data for either a list of MediaData objects or a single MediaData object :param datas: A list of MediaData objects (or a single one) :param fresh: Indicates if the most up-to-date results should be used :return: A list of related media data """
# Abstract Methods --------------------------------------------------------
self, media_type: MediaType, _id: Id ) -> Optional[MediaData]: """ Retrieves a single data object using the API Actual implementation should be done by subclasses :param media_type: The media type to retrieve :param _id: The ID to retrieve. :return: The Anime Data or None if no valid data was found """ raise NotImplementedError() # pragma: no cover
self, media_type: MediaType, _id: Id, username: str ) -> Optional[MediaUserData]: """ Actual implementation of the get_user_data for each subclass :param media_type: The media type to fetch :param _id: The ID to retrieve :param username: The user for which to fetch the data :return: The user data for the entry or None if the user doesn't have such an entry """ raise NotImplementedError() # pragma: no cover
-> List[MediaUserData]: """ Retrieves a user's entire list of user data Actual implementation method to be implemented by subclasses :param media_type: The media type to fetch :param username: The username for which to fetch the list :return: The list of user data """ raise NotImplementedError() # pragma: no cover
self, media_type: MediaType, _id: Id, username: str ) -> Optional[MediaListEntry]: """ Actual implementation of the get_list_entry for each subclass :param media_type: The media type to fetch :param _id: The ID to retrieve :param username: The user for which to fetch the entry :return: The entry for the user or None if the user doesn't have such an entry """ raise NotImplementedError() # pragma: no cover
-> List[MediaListEntry]: """ Retrieves a user's entire list Actual implementation method to be implemented by subclasses :param media_type: The media type to fetch :param username: The username for which to fetch the list :return: The list of List entries """ raise NotImplementedError() # pragma: no cover
# Shortcut Methods --------------------------------------------------------
-> Optional[AnimeData]: """ Shortcut for get_data that retrieves only Anime media :param _id: The ID to fetch. May be int or Id object :param fresh: Fetches a fresh, i.e. non-cached version :return: The retrieved AnimeData object or None if not a valid ID """
self, _id: int or Id, username: str, fresh: bool = False ) -> Optional[AnimeUserData]: """ Retrieves a user's user data for a single entry :param _id: The ID to fetch. May be int or an Id object :param username: The user for which to fetch the user data :param fresh: Fetches a fresh, i.e. non-cached version :return: The AnimeUserData or None if there is not such entry """
""" Retrieves a user's complete anime list of user data objects :param username: The user's username :return: The user's list of AnimeUserData objects """ # noinspection PyTypeChecker
self, _id: int or Id, username: str, fresh: bool = False ) -> Optional[AnimeListEntry]: """ Retrieves a user's list entry for a single entry :param _id: The ID to fetch. May be int or an Id object :param username: The user for which to fetch the entry :param fresh: Fetches a fresh, i.e. non-cached version :return: The Anime List Entry or None if there is not such entry """
""" Retrieves a user's complete anime list :param username: The user's username :return: The user's list of AnimeListEntry objects """ # noinspection PyTypeChecker
self, _id: int or Id, username: str, fresh: bool = False ) -> bool: """ Checks if an entry is in a user's list :param _id: The ID to check for :param username: The username for which to check :param fresh: Indicates if the most up-to-date results should be used :return: True if the id is in the list, False otherwise """
-> Optional[MangaData]: """ Shortcut for get_data that retrieves only Manga media :param _id: The ID to fetch. May be int or Id object :param fresh: Fetches a fresh, i.e. non-cached version :return: The retrieved MangaData object or None if not a valid ID """
self, _id: int or Id, username: str, fresh: bool = False ) -> Optional[MangaUserData]: """ Retrieves a user's user data for a single entry :param _id: The ID to fetch. May be int or an Id object :param username: The user for which to fetch the user data :param fresh: Fetches a fresh, i.e. non-cached version :return: The MangaUserData or None if there is not such entry """
""" Retrieves a user's complete manga list of user data objects :param username: The user's username :return: The user's list of MangaUserData objects """ # noinspection PyTypeChecker
self, _id: int or Id, username: str, fresh: bool = False ) -> Optional[MangaListEntry]: """ Retrieves a user's list entry for a single entry :param _id: The ID to fetch. May be int or an Id object :param username: The user for which to fetch the entry :param fresh: Fetches a fresh, i.e. non-cached version :return: The Manga List Entry or None if there is not such entry """
""" Retrieves a user's complete manga list :param username: The user's username :return: The user's list of MangaListEntry objects """ # noinspection PyTypeChecker
self, _id: int or Id, username: str, fresh: bool = False ) -> bool: """ Checks if an entry is in a user's manga list :param _id: The ID to check for :param username: The username for which to check :param fresh: Indicates if the most up-to-date results should be used :return: True if the id is in the list, False otherwise """
# Helper Methods ----------------------------------------------------------
""" Caches a cache-able data object :param data: The data object to cache :param dont_write: Will make sure that the cache won't be written to file. :return: None """ self.id_type, data, ignore_for_write_count=dont_write )
""" Generates an Id object if the given ID is an integer :param _id: The ID to make sure is an Id object :return: The generated Id object """
self, data: MediaData, previous: List[MediaData], fresh: bool = False ): """ Retrieves the related MediaData objects for a given MediaData object. This method works in-place. :param data: The data for which to retrieve the related data :param previous: The previously found data, used in recursive calls :param fresh: Indicates if the most up-to-date results should be used :return: None """
lambda x: x.id == relation.dest, previous ))
else: # In-place recursive method self.get_data(relation.dest_type, relation.dest, fresh) |