UpdateManga

This module contains functions to update manga details such as status, progress, and privacy settings. It also includes functions to handle the updating process, including creating a dictionary of variables for updating, updating the status and progress of the manga, and sending the update request to the Anilist API.

Get_Chapters_Updated

Get_Chapters_Updated() -> int

Get the number of chapters updated.

This function returns the global variable chapters_updated which keeps track of the number of chapters updated.

RETURNS	DESCRIPTION
int	The number of chapters updated. TYPE: int

Source code in AnilistMangaUpdater/API/UpdateManga.py

def Get_Chapters_Updated() -> int:
    """
    Get the number of chapters updated.

    This function returns the global variable chapters_updated which keeps
    track of the number of chapters updated.

    Returns:
        int: The number of chapters updated.
    """
    Logger.INFO("Function Get_Chapters_Updated called.")
    Logger.DEBUG(f"Returning the number of chapters updated: {chapters_updated}")
    return chapters_updated

Set_Chapters_Updated

Set_Chapters_Updated() -> None

Set the number of chapters updated to zero.

This function sets the global variable chapters_updated to zero. It's typically used to reset the count of chapters updated.

Source code in AnilistMangaUpdater/API/UpdateManga.py

def Set_Chapters_Updated() -> None:
    """
    Set the number of chapters updated to zero.

    This function sets the global variable chapters_updated to zero.
    It's typically used to reset the count of chapters updated.
    """
    global chapters_updated
    Logger.INFO("Function Set_Chapters_Updated called.")
    chapters_updated = 0
    Logger.DEBUG("Set the number of chapters updated to zero.")

Update_Manga

Update_Manga(manga: object, app: object, chapter_anilist: int, manga_status: Union[int, str, None]) -> Optional[bool]

Updates the manga in the user's list.

This function gets the user ID if it's not already set, updates the status of the manga, updates the variables for the manga, and updates the progress of the manga.

PARAMETER	DESCRIPTION
manga	The manga to update. TYPE: object
app	The application instance. TYPE: object
chapter_anilist	The current progress of the manga in the user's list. TYPE: int
manga_status	The current status of the manga in the user's list. TYPE: Union[int, str, None]

RETURNS	DESCRIPTION
Optional[bool]	None

Source code in AnilistMangaUpdater/API/UpdateManga.py

def Update_Manga(
    manga: object,
    app: object,
    chapter_anilist: int,
    manga_status: Union[int, str, None],
) -> Optional[bool]:
    """
    Updates the manga in the user's list.

    This function gets the user ID if it's not already set, updates the status of the manga,
    updates the variables for the manga, and updates the progress of the manga.

    Args:
        manga: The manga to update.
        app: The application instance.
        chapter_anilist: The current progress of the manga in the user's list.
        manga_status: The current status of the manga in the user's list.

    Returns:
        None
    """
    global userId

    Logger.INFO("Function Update_Manga called.")
    # Get the user ID
    if userId is None:
        Logger.INFO("User ID is not set. Getting the user ID.")
        userId = Get_User(app)
        Logger.DEBUG(f"Got the user ID: {userId}")

    Logger.INFO("Updating the status of the manga.")
    manga.status = update_status(manga)
    Logger.DEBUG(f"Updated the status of the manga to: {manga.status}")

    Logger.INFO("Updating the variables for the manga.")
    variables_list = update_variables(manga, chapter_anilist, manga_status)
    Logger.DEBUG(f"Updated the variables for the manga: {variables_list}")

    Logger.INFO("Updating the progress of the manga.")
    updated = update_manga_progress(manga, app, variables_list, chapter_anilist)
    Logger.DEBUG("Updated the progress of the manga.")
    return updated

update_manga_progress

update_manga_progress(manga: object, app: object, variables_list: list, chapter_anilist: int) -> Optional[bool]

Updates the progress of the given manga.

This function sends a mutation request to the Anilist API to update the progress of the manga. It iterates over the list of variables, sends the request for each set of variables, and checks the response. If the response is successful and the last read is greater than the chapter from Anilist, updates the chapter progress and prints a message. If the response is not successful, it prints an error message and returns.

PARAMETER	DESCRIPTION
manga	The manga object whose progress is to be updated. The manga object should have 'name', 'id', and 'last_chapter_read' attributes. TYPE: object
app	The application instance. TYPE: object
variables_list	A list of dictionaries, each containing the variables for the mutation request. TYPE: list
chapter_anilist	The current chapter of the manga from Anilist. TYPE: int

RETURNS	DESCRIPTION
Optional[bool]	None

Source code in AnilistMangaUpdater/API/UpdateManga.py

def update_manga_progress(
    manga: object, app: object, variables_list: list, chapter_anilist: int
) -> Optional[bool]:
    """
    Updates the progress of the given manga.

    This function sends a mutation request to the Anilist API to update the progress
    of the manga. It iterates over the list of variables, sends the request for each
    set of variables, and checks the response. If the response is successful and the
    last read is greater than the chapter from Anilist, updates the chapter progress
    and prints a message. If the response is not successful, it prints an error message
    and returns.

    Args:
        manga: The manga object whose progress is to be updated. The manga object
            should have 'name', 'id', and 'last_chapter_read' attributes.
        app: The application instance.
        variables_list: A list of dictionaries, each containing the variables for
            the mutation request.
        chapter_anilist: The current chapter of the manga from Anilist.

    Returns:
        None
    """
    global chapters_updated
    variables_mediaId = None

    query = """
    mutation ($mediaId: Int, $status: MediaListStatus, $progress: Int, $private: Boolean) {
        SaveMediaListEntry (mediaId: $mediaId, status: $status, progress: $progress, private: $private) {
            id
            status
            progress
            private
        }
    }
    """

    update_sent = False

    Logger.INFO("Function update_manga_progress called.")
    for variables in variables_list:
        Logger.DEBUG(f"Processing variables: {variables}")
        previous_mediaId = variables.get("mediaId")
        response = api_request(query, app, variables)
        Logger.DEBUG(f"Received response: {response}")
        if response:
            Logger.INFO("Response is successful.")
            if manga.last_chapter_read is not None and (
                manga.last_chapter_read > chapter_anilist or chapter_anilist is None
            ):
                Logger.DEBUG(
                    "Last read chapter is greater than AniList chapter or AniList chapter is None."
                )
                if previous_mediaId != variables_mediaId:
                    Logger.DEBUG("Previous mediaId is not equal to variables_mediaId.")
                    variables_mediaId = previous_mediaId
                    message = (
                        f"Manga: {manga.name}({manga.id}) Has been set to chapter "
                        f"{manga.last_chapter_read} from {chapter_anilist}\n"
                    )
                    Logger.INFO(message)
                    app.update_terminal(message)
                    chapters_updated += manga.last_chapter_read - chapter_anilist
                    Logger.DEBUG(f"Updated chapters_updated to: {chapters_updated}")
                    update_sent = True
            else:
                message = f"Manga: {manga.name}({manga.id}) Status has been set to {manga.status}\n"
                Logger.DEBUG(message)
                app.update_terminal(message)
                break
        else:
            Logger.ERROR("Response is not successful.")
            app.update_terminal("Failed to alter data.")
            return None
    if not update_sent:
        return False

    return True

update_manga_variables

update_manga_variables(manga_id: int, progress: Optional[Union[int, None]] = None, status: Optional[Union[str, None]] = None, private: Optional[Union[bool, None]] = None) -> dict

Creates a dictionary of variables for updating a manga.

PARAMETER	DESCRIPTION
manga_id	The ID of the manga to update. TYPE: int
progress	The progress of the manga. Default is None. TYPE: int DEFAULT: None
status	The status of the manga. Default is None. TYPE: str DEFAULT: None
private	The privacy setting of the manga. Default is None. TYPE: bool DEFAULT: None

RETURNS	DESCRIPTION
dict	A dictionary of variables for updating a manga, excluded if their value is None. TYPE: dict

Source code in AnilistMangaUpdater/API/UpdateManga.py

def update_manga_variables(
    manga_id: int,
    progress: Optional[Union[int, None]] = None,
    status: Optional[Union[str, None]] = None,
    private: Optional[Union[bool, None]] = None,
) -> dict:
    """
    Creates a dictionary of variables for updating a manga.

    Parameters:
        manga_id (int): The ID of the manga to update.
        progress (int): The progress of the manga. Default is None.
        status (str): The status of the manga. Default is None.
        private (bool): The privacy setting of the manga. Default is None.

    Returns:
        dict: A dictionary of variables for updating a manga,
            excluded if their value is None.
    """
    Logger.INFO("Function update_manga_variables called.")
    variables = {
        "mediaId": manga_id,
        "progress": progress,
        "status": status,
        "private": private,
    }
    Logger.DEBUG(f"Created the variables dictionary: {variables}")
    # Only return variables that are not None
    filtered_variables = {k: v for k, v in variables.items() if v is not None}
    Logger.DEBUG(f"Filtered the variables dictionary: {filtered_variables}")
    return filtered_variables

update_status

update_status(manga: object) -> str

Updates the status of the given manga.

PARAMETER	DESCRIPTION
manga	The manga object whose status is to be updated. The manga object should TYPE: object

RETURNS	DESCRIPTION
str	The updated status of the manga. TYPE: str

Source code in AnilistMangaUpdater/API/UpdateManga.py

def update_status(manga: object) -> str:
    """
    Updates the status of the given manga.

    Args:
        manga: The manga object whose status is to be updated. The manga object should
        have 'status', 'months', and 'last_read_at' attributes.

    Returns:
        str: The updated status of the manga.
    """
    if manga.last_read_at is None:
        time_difference = timedelta.max
    else:
        time_difference = datetime.now() - manga.last_read_at

    return (
        "PAUSED"
        if manga.status != "plan_to_read"
        and int(manga.months) != 0
        and time_difference >= timedelta(days=30 * int(manga.months))
        else status_mapping.get(manga.status.lower(), manga.status)
    )

update_variables

update_variables(manga: object, chapter_anilist: Union[str, int, None], manga_status: Union[str, int, None]) -> list[dict]

Updates the variables for the given manga.

PARAMETER	DESCRIPTION
manga	The manga object whose variables are to be updated. The manga object should TYPE: object
chapter_anilist	The current chapter of the manga from Anilist. TYPE: Union[str, int, None]
manga_status	The current status of the manga in the user's list. TYPE: Union[str, int, None]

RETURNS	DESCRIPTION
list	A list of dictionaries, each containing the variables for the mutation request. TYPE: list[dict]

Source code in AnilistMangaUpdater/API/UpdateManga.py

def update_variables(
    manga: object,
    chapter_anilist: Union[str, int, None],
    manga_status: Union[str, int, None],
) -> list[dict]:
    """
    Updates the variables for the given manga.

    Args:
        manga: The manga object whose variables are to be updated. The manga object should
        have 'status', 'last_chapter_read', 'id', and 'private_bool' attributes.
        chapter_anilist: The current chapter of the manga from Anilist.
        manga_status: The current status of the manga in the user's list.

    Returns:
        list: A list of dictionaries, each containing the variables for the mutation request.
    """
    variables_list = []
    manga.last_chapter_read = (
        0
        if manga.last_chapter_read is None and manga.last_chapter_read
        else manga.last_chapter_read
    )
    if manga_status == "COMPLETED":
        pass
    elif manga.status == "PLANNING" or (
        manga.status != manga_status
        and (
            manga.last_chapter_read is None
            or manga.last_chapter_read <= chapter_anilist
            or chapter_anilist is None
        )
    ):
        manga.last_chapter_read = (
            0 if manga.status == "PLANNING" else manga.last_chapter_read
        )
        first_variables = update_manga_variables(
            manga.id,
            status=manga.status,
            progress=(
                0
                if manga.status == "PLANNING"
                else int(chapter_anilist)
                if chapter_anilist is not None
                else None
            ),
            private=manga.private_bool,
        )
        variables_list.append(first_variables)
    elif manga.last_chapter_read is not None and (
        manga.last_chapter_read > chapter_anilist or chapter_anilist is None
    ):
        first_variables = update_manga_variables(
            manga.id,
            progress=((int(chapter_anilist) if chapter_anilist is not None else 0) + 1),
            private=manga.private_bool,
        )
        third_variables = None
        second_variables = None
        if (
            manga.status == "PLANNING"
            and ((int(chapter_anilist) if chapter_anilist is not None else 0) + 1)
            != manga.last_chapter_read
        ):
            second_variables = update_manga_variables(
                manga.id, progress=manga.last_chapter_read
            )
            third_variables = update_manga_variables(manga.id, status=manga.status)
        elif (
            (int(chapter_anilist) if chapter_anilist is not None else 0) + 1
        ) != manga.last_chapter_read:
            second_variables = update_manga_variables(
                manga.id, status=manga.status, progress=manga.last_chapter_read
            )
        variables_list.extend(
            [
                v
                for v in [first_variables, second_variables, third_variables]
                if v is not None
            ]
        )
    return variables_list