MangaSearch

This module contains the MangaSearch class which is used to search for a manga on Anilist.

no_manga_found module-attribute

no_manga_found: list[tuple[str, Union[int, None]]] = []

MangaSearch

MangaSearch(name: str, last_chapter_read: Union[int, None], app: object, max_retries: int = 3, delay: float = 60)

A class used to search for a manga on Anilist.

ATTRIBUTE	DESCRIPTION
name	The name of the manga to search for. TYPE: str
last_chapter_read	The last chapter read of the manga. TYPE: int
app	The application object used to update the terminal and progress. TYPE: object
max_retries	The maximum number of retries. Defaults to 5. TYPE: int
delay	The delay between retries in seconds. Defaults to 15. TYPE: int
retry_count	The current number of retries. TYPE: int
matches	The list of matches from the search results. TYPE: list
id_list	The list of IDs for the matches. TYPE: list

METHOD	DESCRIPTION
search_manga	Searches for the manga on Anilist.
process_manga_item	Processes a manga item from the search results.
process_title	Processes the title by replacing certain characters.
_check_title_match	Checks if the title matches the name.
get_id_list	Gets the list of IDs from the matches.
print_details	Prints the details of the matches.
handle_no_ids_found	Handles the case where no IDs are found.
handle_server_error	Handles server errors.
get_manga_id	Retrieves the ID of the manga.

PARAMETER	DESCRIPTION
name	The name of the manga to search for. TYPE: str
last_chapter_read	The last chapter read of the manga. TYPE: int
app	The application object used to update the terminal and progress. TYPE: object
max_retries	The maximum number of retries. Defaults to 5. TYPE: int DEFAULT: 3
delay	The delay between retries in seconds. Defaults to 15. TYPE: float DEFAULT: 60
retry_count	The current number of retries. TYPE: int
matches	The list of matches from the search results. TYPE: list
id_list	The list of IDs for the matches. TYPE: list
cache	The cache object used to store the manga data.

Source code in AnilistMangaUpdater/Manga/manga_search.py

def __init__(  # pylint: disable=R0913
    self,
    name: str,
    last_chapter_read: Union[int, None],
    app: object,
    max_retries: int = 3,
    delay: float = 60,
) -> None:
    """
    Initializes the MangaSearch object.

    Parameters:
        name (str): The name of the manga to search for.
        last_chapter_read (int): The last chapter read of the manga.
        app: The application object used to update the terminal and progress.
        max_retries (int, optional): The maximum number of retries. Defaults to 5.
        delay (float, optional): The delay between retries in seconds. Defaults to 15.
        retry_count (int): The current number of retries.
        matches (list): The list of matches from the search results.
        id_list (list): The list of IDs for the matches.
        cache: The cache object used to store the manga data.
    """
    Logger.INFO("Function __init__ called.")
    Logger.DEBUG(
        f"Parameters - name: {name}, "
        f"last_chapter_read: {last_chapter_read}, "
        f"max_retries: {max_retries}, "
        f"delay: {delay}"
    )
    self.name: str = name
    self.last_chapter_read: Union[int, None] = last_chapter_read
    self.app: object = app
    self.max_retries: int = max_retries
    self.delay: float = delay
    self.retry_count: int = 0
    self.matches: list = []
    self.id_list: list = []
    self.cache = Cache("Manga_Data/title_cache.json")
    Logger.DEBUG("MangaSearch object initialized.")

app instance-attribute

app: object = app

cache instance-attribute

cache = Cache('Manga_Data/title_cache.json')

delay instance-attribute

delay: float = delay

id_list instance-attribute

id_list: list = []

last_chapter_read instance-attribute

last_chapter_read: Union[int, None] = last_chapter_read

matches instance-attribute

matches: list = []

max_retries instance-attribute

max_retries: int = max_retries

name instance-attribute

name: str = name

retry_count instance-attribute

retry_count: int = 0

get_id_list

get_id_list() -> None

Gets the list of IDs from the matches.

This method sorts the matches by the match score in descending order. Then it gets the list of IDs for the matches with a positive match score.

Source code in AnilistMangaUpdater/Manga/manga_search.py

def get_id_list(self) -> None:
    """
    Gets the list of IDs from the matches.

    This method sorts the matches by the match score in descending order.
    Then it gets the list of IDs for the matches with a positive match score.
    """
    Logger.INFO("Function get_id_list called.")
    self.matches.sort(key=lambda x: x[0], reverse=True)
    Logger.DEBUG("Sorted matches by match score in descending order.")
    self.id_list = [manga_item["id"] for match, manga_item in self.matches if match]
    Logger.DEBUG(f"Got list of IDs from matches: {self.id_list}")

get_manga_id

get_manga_id() -> list[int]

Gets the ID of the manga.

RETURNS	DESCRIPTION
list	A list of manga IDs. TYPE: list[int]

Source code in AnilistMangaUpdater/Manga/manga_search.py

def get_manga_id(self) -> list[int]:
    """
    Gets the ID of the manga.

    Returns:
        list: A list of manga IDs.
    """
    Logger.INFO("Function get_manga_id called.")
    result: list = []

    # Check if the manga ID is in the cache
    cached_result_str: Optional[str] = self.cache.get(self.name)
    if cached_result_str is not None:
        if isinstance(cached_result_str, list):
            cached_result_str = json.dumps(cached_result_str)
        cached_result: Optional[List[int]] = json.loads(cached_result_str)
    else:
        cached_result = None
    if cached_result is not None:
        self.app.update_terminal(f"\nFound manga: {self.name} in cache.")
        Logger.INFO(f"Found manga: {self.name} in cache.")
        return cached_result

    while self.retry_count < self.max_retries:
        Logger.DEBUG(
            f"Retry count: {self.retry_count}. Max retries: {self.max_retries}."
        )
        if self.name != "Skipping Title":
            Logger.INFO(f"Searching for manga: {self.name}.")
            try:
                if not self.search_and_process_manga():
                    break
            except (
                pymoe.utils.errors.serverError,  # pylint: disable=E1101
                IndexError,
                KeyError,
            ) as e:
                self.handle_search_errors(e)
                continue
            if not self.matches:
                self.app.update_terminal(
                    f"\nNo search results found for '{self.name}'."
                )
                Logger.WARNING(f"No search results found for '{self.name}'.")
                no_manga_found.append((self.name, self.last_chapter_read))
                Logger.DEBUG(f"Added '{self.name}' to the list of manga not found.")
                break
            self.get_id_list()
            self.print_details()
            self.handle_no_ids_found()
            if self.id_list:
                result = self.id_list
                Logger.DEBUG(f"Got list of IDs: {result}.")
                # Add the manga ID to the cache
                self.cache.set(self.name, result)
                break
        else:
            self.app.update_terminal("\nSkipping a title...")
            Logger.INFO("Skipping a title.")
            break
    else:
        self.app.update_terminal(
            f"Failed to get manga ID for '{self.name}' after {self.max_retries} retries."
        )
        Logger.ERROR(
            f"Failed to get manga ID for '{self.name}' after {self.max_retries} retries."
        )
    return result

handle_no_ids_found

handle_no_ids_found() -> None

Handles the case where no IDs are found.

This method prints a message and adds the name and the last chapter read to the list of manga not found if no IDs are found.

Source code in AnilistMangaUpdater/Manga/manga_search.py

def handle_no_ids_found(self) -> None:
    """
    Handles the case where no IDs are found.

    This method prints a message and adds the name and the last chapter read
    to the list of manga not found if no IDs are found.
    """
    Logger.INFO("Function handle_no_ids_found called.")
    if not self.id_list:
        self.app.update_terminal(f"\nNo manga found for '{self.name}'.")
        Logger.WARNING(f"No manga found for '{self.name}'.")
        no_manga_found.append((self.name, self.last_chapter_read))
        Logger.DEBUG(f"Added '{self.name}' to the list of manga not found.")

handle_search_errors

handle_search_errors(error: Exception) -> None

Handles errors that occur during the search.

PARAMETER	DESCRIPTION
error	The error that occurred. TYPE: Exception

Source code in AnilistMangaUpdater/Manga/manga_search.py

def handle_search_errors(self, error: Exception) -> None:
    """
    Handles errors that occur during the search.

    Parameters:
        error (Exception): The error that occurred.
    """
    if isinstance(error, pymoe.utils.errors.serverError):  # pylint: disable=E1101
        self.handle_server_error(error)
    elif isinstance(error, IndexError):
        self.app.update_terminal(f"\nNo search results found for '{self.name}'.")
        Logger.WARNING(f"No search results found for '{self.name}'.")
        no_manga_found.append((self.name, self.last_chapter_read))
        Logger.DEBUG(f"Added '{self.name}' to the list of manga not found.")
    elif isinstance(error, KeyError):
        self.app.update_terminal(
            f"\nFailed to get data for '{self.name}', retrying..."
        )
        Logger.ERROR(f"Failed to get data for '{self.name}', retrying.")
        self.retry_count += 1 if "Too Many Requests" in str(error) else 0
        Logger.DEBUG(f"Incremented retry count to {self.retry_count}.")

handle_server_error

handle_server_error(e: Exception) -> None

Handles server errors.

This method checks if the error is a "Too Many Requests" error. If so, it waits for a delay and increments the retry count. If the error is not a "Too Many Requests" error, it prints an error message.

PARAMETER	DESCRIPTION
e	The server error to handle. TYPE: Exception

Source code in AnilistMangaUpdater/Manga/manga_search.py

def handle_server_error(self, e: Exception) -> None:
    """
    Handles server errors.

    This method checks if the error is a "Too Many Requests" error.
    If so, it waits for a delay and increments the retry count.
    If the error is not a "Too Many Requests" error, it prints an error message.

    Parameters:
        e (Exception): The server error to handle.
    """
    Logger.INFO("Function handle_server_error called.")
    if "Too Many Requests" in str(e):
        self.app.update_terminal(
            f"\nToo Many Requests For Pymoe. Retrying in {self.delay} seconds..."
        )
        Logger.WARNING("Too Many Requests For Pymoe. Retrying.")
        time.sleep(self.delay)
        self.retry_count += 1
        Logger.DEBUG(f"Incremented retry count to {self.retry_count}.")
    else:
        self.app.update_terminal(
            f"An unexpected server error occurred for {self.name}: {e}"
        )
        Logger.ERROR(f"An unexpected server error occurred for {self.name}: {e}")

print_details

print_details() -> None

Prints the details of the matches.

This method prints the list of IDs, the romaji title, the English title, and the Anilist URL for the matches with a positive match score.

Source code in AnilistMangaUpdater/Manga/manga_search.py

def print_details(self) -> None:
    """
    Prints the details of the matches.

    This method prints the list of IDs, the romaji title, the English title,
    and the Anilist URL for the matches with a positive match score.
    """
    Logger.INFO("Function print_details called.")
    if self.id_list:
        self.app.update_terminal(f"\nList of IDs for {self.name} : {self.id_list}")
        Logger.DEBUG(f"Printed list of IDs for {self.name}.")
        romaji_title = self.matches[0][1]["title"]["romaji"]
        english_title = self.matches[0][1]["title"]["english"]
        self.app.update_terminal(f"Romaji Title: {romaji_title}")
        Logger.DEBUG(f"Printed Romaji title: {romaji_title}.")
        self.app.update_terminal(f"English Title: {english_title}")
        Logger.DEBUG(f"Printed English title: {english_title}.")
        for match, manga_item in self.matches:
            if match:
                self.app.update_terminal(f"Anilist URL: {manga_item['siteUrl']}")
                Logger.DEBUG(f"Printed Anilist URL: {manga_item['siteUrl']}.")

process_manga_item

process_manga_item(manga_item: dict) -> None

Processes a manga item from the search results.

This method gets the English and Romaji titles and the synonyms from the manga item. It processes them and checks if they match the name. If they do, it adds the manga item to the matches.

PARAMETER	DESCRIPTION
manga_item	The manga item to process. TYPE: dict

Source code in AnilistMangaUpdater/Manga/manga_search.py

def process_manga_item(self, manga_item: dict) -> None:
    """
    Processes a manga item from the search results.

    This method gets the English and Romaji titles and the synonyms from the manga item.
    It processes them and checks if they match the name.
    If they do, it adds the manga item to the matches.

    Parameters:
        manga_item (dict): The manga item to process.
    """
    Logger.INFO("Function process_manga_item called.")
    title = manga_item["title"]
    match = False
    if "english" in title and title["english"]:
        english_title = self.process_title(title["english"])
        match = match or self._check_title_match(english_title)
        Logger.DEBUG(f"Checked English title: {english_title}. Match: {match}")
    if "romaji" in title and title["romaji"]:
        romaji_title = self.process_title(title["romaji"])
        match = match or self._check_title_match(romaji_title)
        Logger.DEBUG(f"Checked Romaji title: {romaji_title}. Match: {match}")
    if "synonyms" in manga_item:
        for synonym in manga_item["synonyms"]:
            synonym = self.process_title(synonym)
            match = match or self._check_title_match(synonym)
            Logger.DEBUG(f"Checked synonym: {synonym}. Match: {match}")
    if match:
        self.matches.append((match, manga_item))
        Logger.INFO("Match found. Added to matches.")

process_title staticmethod

process_title(title: str) -> str

Processes the title by replacing certain characters.

PARAMETER	DESCRIPTION
title	The title to process. TYPE: str

RETURNS	DESCRIPTION
str	The processed title. TYPE: str

Source code in AnilistMangaUpdater/Manga/manga_search.py

@staticmethod
def process_title(title: str) -> str:
    """
    Processes the title by replacing certain characters.

    Parameters:
        title (str): The title to process.

    Returns:
        str: The processed title.
    """
    Logger.INFO("Function process_title called.")
    Logger.DEBUG(f"Processing title: {title}")
    title = title.replace("-", " ")
    title = title.replace("\u2019", "\u0060")
    title = title.replace("`", "'")
    Logger.DEBUG(f"Processed title: {title}")
    return title

search_and_process_manga

search_and_process_manga() -> bool

Searches for a manga and processes the search results.

RETURNS	DESCRIPTION
bool	True if the search was successful, False otherwise. TYPE: bool

Source code in AnilistMangaUpdater/Manga/manga_search.py

def search_and_process_manga(self) -> bool:
    """
    Searches for a manga and processes the search results.

    Returns:
        bool: True if the search was successful, False otherwise.
    """
    manga = self.search_manga()
    if manga:
        Logger.DEBUG(f"Search results for manga: {manga}.")
    if manga is None or not manga:
        Logger.DEBUG("No search results for manga.")
        return False
    for manga_item in manga:
        self.process_manga_item(manga_item)
    self.retry_count = 0  # Reset the retry count after a successful search
    Logger.DEBUG("Reset retry count after a successful search.")
    return True

search_manga

search_manga()

Searches for the manga on Anilist.

RETURNS	DESCRIPTION
list	A list of manga items from the search results. Returns None if an error occurs.

Source code in AnilistMangaUpdater/Manga/manga_search.py

def search_manga(self):  # pylint: disable=R1710
    """
    Searches for the manga on Anilist.

    Returns:
        list: A list of manga items from the search results.
            Returns None if an error occurs.
    """
    Logger.INFO("Function search_manga called.")
    max_retries = 5  # Maximum number of retries
    for attempt in range(max_retries):  # pylint: disable=W0612
        Logger.DEBUG(
            f"Attempt {attempt+1} of {max_retries} to search for manga: {self.name}"
        )
        try:
            result = pymoe.manga.search.anilist.manga(self.name)
            Logger.DEBUG(f"Search successful. Found {len(result)} results.")
            return result[:100]
        except (
            pymoe.utils.errors.serverError,
            KeyError,
        ) as e:  # pylint: disable=E1101
            # Handle server error
            Logger.ERROR(f"Error encountered: {e}")
            if "Too Many Requests" in str(e):
                self.app.update_terminal(
                    f"\nToo Many Requests For Pymoe. Retrying in {self.delay} seconds..."
                )
                Logger.WARNING("Too many requests. Delaying next attempt.")
                self.app.update_estimated_time_remaining(add_time=self.delay)
                time.sleep(self.delay)
                self.retry_count += 1
            else:
                self.app.update_terminal(
                    f"\nAn unexpected error occurred for {self.name}: {e}. "
                    "Retrying in 2 seconds..."
                )
                Logger.WARNING("Unexpected error. Retrying in 2 seconds.")
                time.sleep(2)
    self.app.update_terminal(
        f"Failed to search for {self.name} after {max_retries} attempts."
    )
    Logger.ERROR(f"Failed to search for {self.name} after {max_retries} attempts.")

check_title_match

check_title_match(title: str, name: str) -> bool

Checks if all words in the search name are in the title.

This function removes punctuation from the title and the search name, splits them into words, and checks if all words in the search name are in the title.

PARAMETER	DESCRIPTION
title	The title to check. TYPE: str
name	The search name. TYPE: str

RETURNS	DESCRIPTION
bool	True if all words in the search name are in the title, False otherwise. TYPE: bool

Source code in AnilistMangaUpdater/Manga/manga_search.py

def check_title_match(title: str, name: str) -> bool:
    """
    Checks if all words in the search name are in the title.

    This function removes punctuation from the title and the search name,
    splits them into words, and checks if all words in the search name
    are in the title.

    Parameters:
        title (str): The title to check.
        name (str): The search name.

    Returns:
        bool: True if all words in the search name are in the title, False otherwise.
    """
    Logger.INFO("Function check_title_match called.")
    Logger.DEBUG(f"Checking if all words in '{name}' are in '{title}'.")
    # Remove punctuation from the title and the search name
    title = title.translate(str.maketrans("", "", string.punctuation))
    name = name.translate(str.maketrans("", "", string.punctuation))
    Logger.DEBUG(f"Removed punctuation from '{title}' and '{name}'.")

    # Split the title and the search name into words
    title_words = set(title.lower().split())
    name_words = set(name.lower().split())
    Logger.DEBUG(f"Split '{title}' and '{name}' into words.")

    # Check if all words in the search name are in the title
    match = name_words.issubset(title_words)
    Logger.DEBUG(f"Match result: {match}")
    return match

return_no_manga_found

return_no_manga_found() -> list[tuple[str, Union[int, None]]]

Returns the list of manga not found.

RETURNS	DESCRIPTION
list	A list of tuples containing the name and the last chapter read of the manga not found. TYPE: list[tuple[str, Union[int, None]]]

Source code in AnilistMangaUpdater/Manga/manga_search.py

def return_no_manga_found() -> list[tuple[str, Union[int, None]]]:
    """
    Returns the list of manga not found.

    Returns:
        list: A list of tuples containing the name and the last chapter read of the manga not found.
    """
    Logger.INFO("Function return_no_manga_found called.")
    return no_manga_found