"""
Data models for AnimeScraper.
This module defines data structures for anime, characters, and related entities.
"""
__all__ = [
"Anime",
"AnimeCharacter",
"AnimeStats",
"Character"
]
from typing import Optional, List, Dict
from dataclasses import dataclass
import json
[docs]
@dataclass
class AnimeCharacter:
id: str
"""The MAL ID of the character."""
name: str
"""The name of the character. """
role: Optional[str]
"""The character's role in the anime."""
voice_actor: Dict[str, str]
"""Dictionary containing details about the voice actor."""
def dict(self):
return self.__dict__
@classmethod
def from_dict(cls, data):
return cls(**data)
[docs]
@dataclass
class Character:
id: str
"""The MAL ID of the character"""
name: str
"""The name of the Character."""
japanese_name: Optional[str]
"""Japanese name of the Character"""
about: Dict[str, str]
"""A dictionary containing character's details"""
description: str
"""The description about the character"""
img: str
"""An url of the character image"""
favorites: str
"""The number of MAL users favorite character"""
url: str
"""The MAL url of the Character page"""
def model_dump_json(self):
return json.dumps(self.__dict__)
@classmethod
def from_json(cls, data):
data = json.loads(data)
return cls(**data)
@classmethod
def from_dict(cls, data):
return cls(**data)
[docs]
@dataclass
class AnimeStats:
score: str
"""The score of the anime."""
scored_by: str
"""Number of people scored the anime."""
ranked: str
"""The rank of the anime."""
popularity: str
"""popularity of the anime."""
members: str
"""The member of the anime."""
favorites: str
"""The number people's favorite anime."""
def dict(self):
return self.__dict__
@classmethod
def from_dict(cls, data):
return cls(**data)
[docs]
@dataclass
class Anime:
id: str
"""The MAL ID of the anime."""
title: str
"""The title of the anime. """
english_title: Optional[str]
"""The English title of the anime."""
japanese_title: Optional[str]
"""# The Japanese title of the anime."""
anime_type: str
"""The type of the anime (e.g., TV, Movie, OVA)."""
episodes: Optional[str]
"""Episode number of the anime."""
status: str
"""The current status (e.g., Finished Airing)."""
aired: str
"""The airing date range."""
duration: str
"""Average duration of an episode."""
premiered: str
"""The premiered data of the anime."""
rating: str
"""The age rating (PG-13, R, etc..)."""
synopsis: str
"""The synopsis of the anime."""
genres: List[str]
"""The genres of the anime."""
studios: str
"""The studios that animated the anime."""
themes: List[str]
"""The themes of the anime (e.g., school, Isekei)"""
producers: List[str]
"""The producers of the anime."""
licensors: List[str]
"""The licensors of the anime."""
stats: AnimeStats
"""Statistics of the anime (score, popularity etc..)."""
characters: List[AnimeCharacter]
"""List of characters appearing in anime."""
related: List[dict[str, str]]
"""Related works (anime, movies, manga etc.)"""
def model_dump_json(self):
return json.dumps({
'id': self.id,
'title': self.title,
'english_title': self.english_title,
'japanese_title': self.japanese_title,
'anime_type': self.anime_type,
'episodes': self.episodes,
'status': self.status,
'aired': self.aired,
'duration': self.duration,
'premiered': self.premiered,
'rating': self.rating,
'synopsis': self.synopsis,
'genres': self.genres,
'studios': self.studios,
'themes': self.themes,
'producers': self.producers,
'licensors': self.licensors,
'stats': self.stats.dict(), # Call dict() of AnimeStats
'characters': [character.dict() for character in self.characters], # Call dict() for each character
'related': self.related
})
@classmethod
def from_json(cls, anime_data: str):
data: dict = json.loads(anime_data)
characters = [AnimeCharacter.from_dict(d) for d in data["characters"]]
return cls(
id=data["id"],
title=data["title"],
english_title=data["english_title"],
japanese_title=data["japanese_title"],
anime_type=data["anime_type"],
episodes=data["episodes"],
status=data["status"],
aired=data["aired"],
duration=data["duration"],
premiered=data["premiered"],
rating=data["rating"],
synopsis=data["synopsis"],
genres=data["genres"],
studios=data["studios"],
themes=data["themes"],
producers=data["producers"],
licensors=data["licensors"],
stats=AnimeStats.from_dict(data["stats"]),
characters=characters,
related=data["related"]
)