Add enums

Author: MrArkon

docs/models.rst

@@ -1,7 +1,7 @@
 API Models
 ==========
 
-.. currentmodule:: kitsu.models
+.. currentmodule:: kitsu
 
 Anime
 -----
@@ -17,4 +17,123 @@ Manga
 -----
 
 .. autoclass:: Manga()
-    :members:
+    :members:
+
+Enumerations
+------------
+
+.. class:: AgeRating
+    :canonical: kitsu.enums.AgeRating
+
+    Denotes the age rating of a Media.
+
+    .. attribute:: G
+
+        Rated for general audiences.
+    
+    .. attribute:: PG
+
+        Rated as parental guidance suggested.
+    
+    .. attribute:: R
+
+        Rated as restricted.
+    
+    .. attribute:: R18
+
+        Rated as explicit.
+
+
+.. class:: Status
+    :canonical: kitsu.enums.Status
+
+    Denotes the status of an Anime or Manga.
+
+    .. attribute:: current
+
+        The media is currently releasing.
+    
+    .. attribute:: finished
+
+        The media has finished releasing.
+    
+    .. attribute:: tba
+
+        The media is tba (to be announced).
+    
+    .. attribute:: unreleased
+
+        The media is unreleased.
+    
+    .. attribute:: upcoming
+
+        The media is upcoming.
+
+.. class:: Season
+    :canonical: kitsu.enums.Season
+
+    Denotes the release season of an Anime or Manga.
+
+    .. attribute:: spring
+
+        The media was released/will release in spring.
+
+    .. attribute:: summer
+
+        The media was released/will release in summer.
+    
+    .. attribute:: fall
+
+        The media was released/will release in fall.
+    
+    .. attribute:: winter
+
+        The media was released/will release in winter.
+
+.. class:: AnimeSubtype
+    :canonical: kitsu.enums.AnimeSubtype
+
+    Denotes the subtype of an Anime.
+
+    .. attribute:: ONA
+
+        The anime is an ONA (Original Net Animation).
+    
+    .. attribute:: OVA
+
+        The anime is an OVA (Original Video Animation).
+    
+    .. attribute:: TV
+
+        The anime is a TV series.
+
+    .. attribute:: movie
+
+        The anime is a movie.
+    
+    .. attribute:: music
+
+        The anime is a music.
+    
+    .. attribute:: special
+
+        The anime is a special.
+
+.. class:: MangaSubtype
+    :canonical: kitsu.enums.MangaSubtype
+
+    Denotes the subtype of a Manga.
+
+    .. attribute:: doujin
+    
+    .. attribute:: manga
+
+    .. attribute:: manhua
+    
+    .. attribute:: manwha
+    
+    .. attribute:: novel
+
+    .. attribute:: oel
+    
+    .. attribute:: oneshot

kitsu/client.py

@@ -28,6 +28,7 @@
 import aiohttp
 
 from . import __version__
+from .enums import AgeRating, AnimeSubtype, Season
 from .errors import BadRequest, HTTPException, NotFound
 from .models import Anime, Manga
 
@@ -110,9 +111,9 @@ async def search_anime(
         text: Optional[str] = None,
         after_year: Optional[int] = None,
         before_year: Optional[int] = None,
-        season: Optional[List[Literal["spring", "summer", "fall", "winter"]]] = None,
-        age_rating: Optional[List[Literal["G", "PG", "R", "R18"]]] = None,
-        subtype: Optional[List[Literal["ONA", "OVA", "TV", "movie", "music", "special"]]] = None,
+        season: Optional[List[Season]] = None,
+        age_rating: Optional[List[AgeRating]] = None,
+        subtype: Optional[List[AnimeSubtype]] = None,
         categories: Optional[List[str]] = None,
     ) -> List[Anime]:
         """
@@ -130,11 +131,11 @@ async def search_anime(
             The upper limit of the release year of the Anime to use for filtering the results.
         before_year: Optional[:class:`int`]
             The upper limit of the release year of the Anime to use for filtering the results.
-        season: Optional[List[Literal["spring", "summer", "fall", "winter"]]]
+        season: Optional[List[:class:`Season`]]
             The release season(s) of the Anime to use for filtering the results.
-        age_rating: Optional[List[Literal["G", "PG", "R", "R18"]]]
+        age_rating: Optional[List[:class:`AgeRating`]]
             The age rating(s) of the Anime to use for filtering the results.
-        subtype: Optional[List[Literal["ONA", "OVA", "TV", "movie", "music", "special"]]]
+        subtype: Optional[List[:class:`AnimeSubtype`]]
             The subtype(s) of the Anime to use for filtering the results.
         categories: Optional[List[:class:`str`]]
             The categories of the Anime to use for filtering the results.
@@ -152,13 +153,13 @@ async def search_anime(
             params["filter[seasonYear]"] = f"{after_year or ''}..{before_year or ''}"
 
         if season is not None:
-            params["filter[season]"] = ",".join(season)
+            params["filter[season]"] = ",".join(str(season))
 
         if age_rating is not None:
-            params["filter[ageRating]"] = ",".join(age_rating)
+            params["filter[ageRating]"] = ",".join(str(age_rating))
 
         if subtype is not None:
-            params["fiter[subtype]"] = ",".join(subtype)
+            params["fiter[subtype]"] = ",".join(str(subtype))
 
         if categories is not None:
             params["filter[categories]"] = ",".join(categories)

kitsu/enums.py

@@ -0,0 +1,81 @@
+"""
+MIT License
+
+Copyright (c) 2021-present MrArkon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from enum import Enum
+
+
+class AgeRating(Enum):
+    G = "G"
+    PG = "PG"
+    R = "R"
+    R18 = "R18"
+
+    def __str__(self) -> str:
+        return self.value
+
+
+class Status(Enum):
+    current = "current"
+    finished = "finished"
+    tba = "tba"
+    unreleased = "unreleased"
+    upcoming = "upcoming"
+
+    def __str__(self) -> str:
+        return self.value
+
+
+class Season(Enum):
+    spring = "spring"
+    summer = "summer"
+    fall = "fall"
+    winter = "winter"
+
+    def __str__(self) -> str:
+        return self.value
+
+
+class AnimeSubtype(Enum):
+    ONA = "ONA"
+    OVA = "OVA"
+    TV = "TV"
+    movie = "movie"
+    music = "music"
+    special = "special"
+
+    def __str__(self) -> str:
+        return self.value
+
+
+class MangaSubtype(Enum):
+    doujin = "doujin"
+    manga = "manga"
+    manhua = "manhua"
+    manhwa = "manhwa"
+    novel = "novel"
+    oel = "oel"
+    oneshot = "oneshot"
+
+    def __str__(self) -> str:
+        return self.value

kitsu/models.py

@@ -26,6 +26,8 @@
 from datetime import datetime
 from typing import TYPE_CHECKING, List, Optional
 
+from .enums import AgeRating, AnimeSubtype, MangaSubtype, Status
+
 if TYPE_CHECKING:
     from .client import Client
     from .types import AnimeData, EpisodeCollection, EpisodeData
@@ -181,13 +183,13 @@ class Anime:
         The popularity rank of this Anime on Kitsu.
     rating_rank: :class:`int`
         The rating rank of this Anime on Kitsu.
-    age_rating: Literal["G", "PG", "R", "R18"]
+    age_rating: :class:`AgeRating`
         The age rating of this Anime.
     age_rating_guide: :class:`str`
         A string describing the age rating of this Anime.
-    subtype: Literal["ONA", "OVA", "TV", "movie", "music", "special"]
+    subtype: :class:`AnimeSubtype`
         The subtype of this Anime.
-    status: Literal["current", "finished", "tba", "unreleased", "upcoming"]
+    status: :class:`Status`
         The status of this Anime.
     episode_count: :class:`int`
         The number of episodes in this Anime.
@@ -247,10 +249,10 @@ def __init__(self, payload: AnimeData, client: Client, *, included: Optional[Lis
         self.favorites_count = self._attributes["favoritesCount"]
         self.popularity_rank = self._attributes["popularityRank"]
         self.rating_rank = self._attributes["ratingRank"]
-        self.age_rating = self._attributes["ageRating"]
+        self.age_rating = AgeRating(self._attributes["ageRating"])
         self.age_rating_guide = self._attributes["ageRatingGuide"]
-        self.subtype = self._attributes["subtype"]
-        self.status = self._attributes["status"]
+        self.subtype = AnimeSubtype(self._attributes["subtype"])
+        self.status = Status(self._attributes["status"])
         self.episode_count = self._attributes["episodeCount"]
         self.episode_length = self._attributes["episodeLength"]
         self.youtube_video_id = self._attributes["youtubeVideoId"]
@@ -386,13 +388,13 @@ class Manga:
         The popularity rank of this Manga on Kitsu.
     rating_rank: :class:`int`
         The rating rank of this Manga on Kitsu.
-    age_rating: Optional[Literal["G", "PG", "R", "R18"]]
+    age_rating: :class:`AgeRating`
         The age rating of this Manga.
     age_rating_guide: Optional[:class:`str`]
         A string describing the age rating of this Manga.
-    subtype: Literal["doujin", "manga", "manhua", "manhwa", "novel", "oel", "oneshot"]
+    subtype: :class:`MangaSubtype`
         The subtype of this Manga.
-    status: Literal["current", "finished", "tba", "unreleased", "upcoming"]
+    status: :class:`Status`
         The status of this Manga.
     chapter_count: :class:`int`
         The number of chapters in the Manga.
@@ -446,10 +448,10 @@ def __init__(self, payload: MangaData, client: Client) -> None:
         self.favorites_count = self._attributes["favoritesCount"]
         self.popularity_rank = self._attributes["popularityRank"]
         self.rating_rank = self._attributes["ratingRank"]
-        self.age_rating = self._attributes["ageRating"]
+        self.age_rating = AgeRating(self._attributes["ageRating"])
         self.age_rating_guide = self._attributes["ageRatingGuide"]
-        self.subtype = self._attributes["subtype"]
-        self.status = self._attributes["status"]
+        self.subtype = MangaSubtype(self._attributes["subtype"])
+        self.status = Status(self._attributes["status"])
         self.chapter_count = self._attributes["chapterCount"]
         self.volume_count = self._attributes["volumeCount"]
         self.serialization = self._attributes["serialization"]