Merge pull request #31 from LEv145:dev

v 1.0.10

aiontai/api.py

@@ -68,12 +68,12 @@ async def get_doujin(self, doujin_id: int) -> Dict[str, Any]:
         Args:
             doujin_id: ID of doujin.
 
+        Returns:
+            Doujin raw data from responce.
+
         Raises:
             DoujinDoesNotExistError: If doujin does not exit.
             ClientResponseError: Error from response.
-
-        Returns:
-            Doujin raw data from responce.
         """
         url = f"https://nhentai.net/api/gallery/{doujin_id}"
 
@@ -97,6 +97,9 @@ async def is_exist(self, doujin_id: int) -> bool:
 
         Returns:
             Doujin is exists.
+
+        Raises:
+            ClientResponseError: Error from response.
         """
         try:
             await self.get_doujin(doujin_id)
@@ -110,6 +113,9 @@ async def get_random_doujin(self) -> Dict[str, Any]:
 
         Returns:
             Doujin raw data from responce.
+
+        Raises:
+            ClientResponseError: Error from response.
         """
         url = "https://nhentai.net/random/"
 
@@ -140,12 +146,13 @@ async def search(
             sort_by: Sort options for search.
                 Defaults to SortOptions.DATE.
 
+        Returns:
+            Doujins raw data result from responce.
+
         Raises:
             WrongPageError: If number of page is invalid.
             EmptyAPIResultError: If api result is empty.
-
-        Returns:
-            Doujins raw data result from responce.
+            ClientResponseError: Error from response.
         """
         if page < 1:
             raise WrongPageError("Page can not be less than 1")
@@ -182,13 +189,14 @@ async def search_by_tag(
             sort_by: Sort options for search.
                 Defaults to SortOptions.DATE.
 
+        Returns:
+            Doujins raw data result from responce.
+
         Raises:
             WrongPageError: If number of page is invalid.
             WrongTagError: If tag ID is invalid.
             EmptyAPIResultError: If api result is empty.
-
-        Returns:
-            Doujins raw data result from responce.
+            ClientResponseError: Error from response.
         """
         if page < 1:
             raise WrongPageError("Page can not be less than 1")
@@ -223,11 +231,12 @@ async def get_homepage_doujins(
             page: Number of page from which we return results.
                 Defaults to 1.
 
-        Raises:
-            EmptyAPIResultError: If api result is empty.
-
         Returns:
             Doujins raw data result from responce.
+
+        Raises:
+            EmptyAPIResultError: If api result is empty.
+            ClientResponseError: Error from response.
         """
         url = "https://nhentai.net/api/galleries/all"
 

aiontai/client.py

@@ -67,6 +67,10 @@ async def get_doujin(self, doujin_id: int) -> Doujin:
 
         Returns:
             Doujin model.
+
+        Raises:
+            DoujinDoesNotExistError: If doujin does not exit.
+            ClientResponseError: Error from response.
         """
         raw_data = await self.api.get_doujin(doujin_id)
 
@@ -81,6 +85,9 @@ async def is_exist(self, doujin_id: int) -> bool:
 
         Returns:
             Doujin is exists.
+
+        Raises:
+            ClientResponseError: Error from response.
         """
         raw_data = await self.api.is_exist(doujin_id)
 
@@ -92,6 +99,9 @@ async def get_random_doujin(self) -> Doujin:
 
         Returns:
             Doujin model.
+
+        Raises:
+            ClientResponseError: Error from response.
         """
         raw_data = await self.api.get_random_doujin()
 
@@ -116,6 +126,11 @@ async def search(
 
         Returns:
             Doujins result model.
+
+        Raises:
+            WrongPageError: If number of page is invalid.
+            EmptyAPIResultError: If api result is empty.
+            ClientResponseError: Error from response.
         """
         result = await self.api.search(
             query=query,
@@ -144,6 +159,12 @@ async def search_by_tag(
 
         Returns:
             Doujins result model.
+
+        Raises:
+            WrongPageError: If number of page is invalid.
+            WrongTagError: If tag ID is invalid.
+            EmptyAPIResultError: If api result is empty.
+            ClientResponseError: Error from response.
         """
         result = await self.api.search_by_tag(
             tag_id=tag_id,
@@ -167,6 +188,10 @@ async def get_homepage_doujins(
 
         Returns:
             Doujins result model.
+
+        Raises:
+            EmptyAPIResultError: If api result is empty.
+            ClientResponseError: Error from response.
         """
         result = await self.api.get_homepage_doujins(
             page=page,

aiontai/converter.py

@@ -118,7 +118,7 @@ def convert_title(
         Convert raw data to title model.
 
         Args:
-            raw_data: model raw data.
+            raw_data: Model raw data.
 
         Returns:
             Title model.

aiontai/models.py

@@ -106,7 +106,10 @@ def __getitem__(self, index: int) -> Image:
             index: List index.
 
         Returns:
-            Model.
+            Image model.
+
+        Raises:
+            IndexError: If page index out of range.
         """
         return self.images[index]
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aiontai"
-version = "1.0.9"
+version = "1.0.10"
 description = "Async wrapper for nhentai API"
 authors = ["LEv145"]
 license = "MIT"
@@ -21,7 +21,6 @@ mkinit = "^0.3.4"
 black = "^21.12b0"
 coverage = {extras = ["toml"], version = "^6.2"}
 attrs = "^21.4.0"
-pydocstyle = {extras = ["toml"], version = "^6.1.1"}
 flake8-commas = {git = "https://github.com/LEv145/flake8-commas"}
 flake9 = "^3.8.3"
 poethepoet = "^0.11.0"