AnimeTrace

Classes

AnimeTraceItem

Bases: BaseSearchItem

Represents a single AnimeTrace search result item.

This class processes and structures individual search results from AnimeTrace, providing easy access to various metadata about the found character.

Attributes:

Name	Type	Description
origin	dict	The raw JSON data of the search result.
box	list[float]	Bounding box coordinates of the detected character [x1, y1, x2, y2].
box_id	str	Unique identifier for the detected box.
characters	list[Character]	List of possible character matches with their source works.

Source code in PicImageSearch/model/anime_trace.py

class AnimeTraceItem(BaseSearchItem):
    """Represents a single AnimeTrace search result item.

    This class processes and structures individual search results from AnimeTrace,
    providing easy access to various metadata about the found character.

    Attributes:
        origin (dict): The raw JSON data of the search result.
        box (list[float]): Bounding box coordinates of the detected character [x1, y1, x2, y2].
        box_id (str): Unique identifier for the detected box.
        characters (list[Character]): List of possible character matches with their source works.
    """

    def __init__(self, data: dict[str, Any], **kwargs: Any):
        """Initializes an AnimeTraceItem with data from a search result.

        Args:
            data (dict[str, Any]): A dictionary containing the search result data.
            **kwargs (Any): Additional keyword arguments passed to the parent class.
        """
        super().__init__(data, **kwargs)

    @override
    def _parse_data(self, data: dict[str, Any], **kwargs: Any) -> None:
        """Parse search result data.

        Args:
            data (dict[str, Any]): The data to parse.
            **kwargs (Any): Additional keyword arguments (unused).
        """
        self.box: list[float] = data["box"]
        self.box_id: str = data["box_id"]

        # Parse character data
        character_data = data["character"]
        self.characters: list[Character] = []

        for char_info in character_data:
            character = Character(char_info["character"], char_info["work"])
            self.characters.append(character)

Functions

__init__(data, **kwargs)

Initializes an AnimeTraceItem with data from a search result.

Parameters:

Name	Type	Description	Default
data	dict[str, Any]	A dictionary containing the search result data.	required
**kwargs	Any	Additional keyword arguments passed to the parent class.	{}

Source code in PicImageSearch/model/anime_trace.py

def __init__(self, data: dict[str, Any], **kwargs: Any):
    """Initializes an AnimeTraceItem with data from a search result.

    Args:
        data (dict[str, Any]): A dictionary containing the search result data.
        **kwargs (Any): Additional keyword arguments passed to the parent class.
    """
    super().__init__(data, **kwargs)

AnimeTraceResponse

Bases: BaseSearchResponse[AnimeTraceItem]

Encapsulates a complete AnimeTrace API response.

This class processes and structures the full response from an AnimeTrace search, including all detected characters and their information.

Attributes:

Name	Type	Description
raw	list[AnimeTraceItem]	List of processed search result items.
origin	dict[str, Any]	The raw JSON response data.
code	int	API response code (0 for success).
ai	bool	Whether the result was generated by AI.
trace_id	str	Unique identifier for the trace request.

Source code in PicImageSearch/model/anime_trace.py

class AnimeTraceResponse(BaseSearchResponse[AnimeTraceItem]):
    """Encapsulates a complete AnimeTrace API response.

    This class processes and structures the full response from an AnimeTrace search,
    including all detected characters and their information.

    Attributes:
        raw (list[AnimeTraceItem]): List of processed search result items.
        origin (dict[str, Any]): The raw JSON response data.
        code (int): API response code (0 for success).
        ai (bool): Whether the result was generated by AI.
        trace_id (str): Unique identifier for the trace request.
    """

    def __init__(self, resp_data: dict[str, Any], resp_url: str, **kwargs: Any) -> None:
        """Initializes with the response data.

        Args:
            resp_data (dict[str, Any]): A dictionary containing the parsed response data from AnimeTrace.
            resp_url (str): URL to the search result page.
            **kwargs (Any): Additional keyword arguments passed to the parent class.
        """
        super().__init__(resp_data, resp_url, **kwargs)

    @override
    def _parse_response(self, resp_data: dict[str, Any], **kwargs: Any) -> None:
        """Parse search response data.

        Args:
            resp_data (dict[str, Any]): The response data to parse.
            **kwargs (Any): Additional keyword arguments.
        """
        self.code: int = resp_data["code"]
        self.ai: bool = resp_data.get("ai", False)
        self.trace_id: str = resp_data["trace_id"]

        # Process results
        results = resp_data["data"]
        self.raw: list[AnimeTraceItem] = [AnimeTraceItem(item) for item in results]

Functions

__init__(resp_data, resp_url, **kwargs)

Initializes with the response data.

Parameters:

Name	Type	Description	Default
resp_data	dict[str, Any]	A dictionary containing the parsed response data from AnimeTrace.	required
resp_url	str	URL to the search result page.	required
**kwargs	Any	Additional keyword arguments passed to the parent class.	{}

Source code in PicImageSearch/model/anime_trace.py

def __init__(self, resp_data: dict[str, Any], resp_url: str, **kwargs: Any) -> None:
    """Initializes with the response data.

    Args:
        resp_data (dict[str, Any]): A dictionary containing the parsed response data from AnimeTrace.
        resp_url (str): URL to the search result page.
        **kwargs (Any): Additional keyword arguments passed to the parent class.
    """
    super().__init__(resp_data, resp_url, **kwargs)

Character

Bases: NamedTuple

Represents a character identified in AnimeTrace search results.

Contains information about the character's name and the work they appear in.

Attributes:

Name	Type	Description
name	str	The name of the character.
work	str	The title of the work the character appears in.

Source code in PicImageSearch/model/anime_trace.py

class Character(NamedTuple):
    """Represents a character identified in AnimeTrace search results.

    Contains information about the character's name and the work they appear in.

    Attributes:
        name (str): The name of the character.
        work (str): The title of the work the character appears in.
    """

    name: str
    work: str

Attributes

name instance-attribute

work instance-attribute