Merge pull request #6 from Dibakarroy1997/enable-ci-ww31.7

Enable CI

Author: debakarr

.github/workflows/pull-request.yml

@@ -0,0 +1,31 @@
+name: CI
+on: pull_request
+
+jobs:
+  ci:
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+        poetry-version: ["1.1.14"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run image
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Install dependencies
+        run: poetry install
+      - name: Virtual environment info
+        run: poetry env info
+      - name: Run flake8 (along with black, isort and bandit wrapper)
+        run: poetry run flake8 src tests
+      - name: Run mypy
+        run: poetry run mypy --install-types --non-interactive --ignore-missing-imports src
+      - name: Run pytest
+        run: poetry run pytest

.github/workflows/python-publish.yml

@@ -1,4 +1,4 @@
-name: Python package
+name: CD
 on:
   push:
     tags:

.gitignore

@@ -160,4 +160,4 @@ cython_debug/
 #.idea/
 
 # VS Code
-.vscode/
+.vscode/

poetry.lock

@@ -6,23 +6,24 @@ readme = "README.md"
 authors = ["Debakar Roy <[email protected]>"]
 
 [tool.poetry.dependencies]
-python = "^3.10"
-requests = "^2.28.1"
+python = "^3.8"
 click = "^8.1.3"
-validators = "^0.20.0"
+requests = "^2.28.1"
 pydantic = "^1.9.1"
+validators = "^0.20.0"
 yt-dlp = "^2022.7.18"
 
 [tool.poetry.dev-dependencies]
-pytest-cov = "^3.0.0"
+datamodel-code-generator = { extras = ["http"], version = "^0.13.0" }
 flake8 = "^4.0.1"
-black = "^22.6.0"
 flake8-bugbear = "^22.7.1"
+flake8-black = "^0.3.3"
+flake8-bandit = "^3.0.0"
 flake8-comprehensions = "^3.10.0"
-pep8-naming = "^0.13.0"
 flake8-isort = "^4.1.1"
-flake8-bandit = "^3.0.0"
-datamodel-code-generator = {extras = ["http"], version = "^0.13.0"}
+pep8-naming = "^0.13.0"
+pytest-cov = "^3.0.0"
+mypy = "^0.971"
 
 [tool.black]
 line-length = 120

pyproject.toml

@@ -1,5 +1,6 @@
 import sys
 from pathlib import Path
+from typing import List, Union
 from urllib.parse import parse_qs, urlparse
 
 import click
@@ -44,18 +45,22 @@ def dl(
     first: int,
     last: int,
     quality: str,
-    sub_langs: list[str],
-    output_dir: Path | str,
+    sub_langs: List[str],
+    output_dir: Union[Path, str],
 ) -> None:
     kisskh_api = KissKHApi()
     downloader = Downloader()
     if validators.url(drama_url_or_name):
         parsed_url = urlparse(drama_url_or_name)
-        drama_id = parse_qs(parsed_url.query)["id"][0]
+        drama_id = int(parse_qs(parsed_url.query)["id"][0])
         drama_name = parsed_url.path.split("/")[-1].replace("-", "_")
     else:
         drama = kisskh_api.get_drama_by_query(drama_url_or_name)
-        drama_id, drama_name = drama.id, drama.title
+        if drama is None:
+            print("No drama found with the query provided...")
+            return None
+        drama_id = drama.id
+        drama_name = drama.title
 
     episode_ids = kisskh_api.get_episode_ids(drama_id=drama_id, start=first, stop=last)
 

src/kisskh_downloader/cli.py

@@ -1,5 +1,6 @@
 import os
 from pathlib import Path
+from typing import List
 from urllib.parse import urlparse
 
 import requests
@@ -25,7 +26,7 @@ def download_video_from_stream_url(self, video_stream_url: str, filepath: str, q
         with yt_dlp.YoutubeDL(ydl_opts) as ydl:
             ydl.download(video_stream_url)
 
-    def download_subtitles(self, subtitles: list[SubItem], filepath: str) -> None:
+    def download_subtitles(self, subtitles: List[SubItem], filepath: str) -> None:
         """Download subtitles
 
         :param subtitles: list of all subtitles

src/kisskh_downloader/downloader.py

@@ -1,11 +1,12 @@
 import sys
+from typing import Dict, List, Optional
 from urllib.parse import urljoin
 
 import requests
 
 from kisskh_downloader.models.drama import Drama
 from kisskh_downloader.models.search import DramaInfo, Search
-from kisskh_downloader.models.sub import Sub
+from kisskh_downloader.models.sub import Sub, SubItem
 
 
 class KissKHApi:
@@ -61,7 +62,7 @@ def _request(self, url: str) -> requests.models.Response:
         response.raise_for_status()
         return response
 
-    def get_episode_ids(self, drama_id: int, start: int = 1, stop: int = sys.maxsize) -> dict[int, tuple[str, str]]:
+    def get_episode_ids(self, drama_id: int, start: int = 1, stop: int = sys.maxsize) -> Dict[int, int]:
         """Get episode ids for a specific drama
 
         :param drama_id: drama id
@@ -74,7 +75,7 @@ def get_episode_ids(self, drama_id: int, start: int = 1, stop: int = sys.maxsize
         drama = Drama.parse_obj(response.json())
         return drama.get_episodes_ids(start=start, stop=stop)
 
-    def get_subtitles(self, episode_id: int, *language_filter: str) -> list[str]:
+    def get_subtitles(self, episode_id: int, *language_filter: str) -> List[SubItem]:
         """Get subtitle details for a specific episode
 
         :param episode_id: episode id
@@ -84,13 +85,13 @@ def get_subtitles(self, episode_id: int, *language_filter: str) -> list[str]:
         """
         subtitle_api_url = self._subtitle_api_url(episode_id=episode_id)
         response = self._request(subtitle_api_url)
-        subtitles = Sub.parse_obj(response.json())
-        subtitle_urls = []
+        subtitles: Sub = Sub.parse_obj(response.json())
+        filtered_subtitles: List[SubItem] = []
         if "all" in language_filter:
-            subtitle_urls.extend(subtitle for subtitle in subtitles)
+            filtered_subtitles.extend(subtitle for subtitle in subtitles)
         elif language_filter:
-            subtitle_urls.extend(subtitle for subtitle in subtitles if subtitle.land in language_filter)
-        return subtitle_urls
+            filtered_subtitles.extend(subtitle for subtitle in subtitles if subtitle.land in language_filter)
+        return filtered_subtitles
 
     def search_dramas_by_query(self, query: str) -> Search:
         """Get all drama for a specific search query
@@ -112,7 +113,7 @@ def get_stream_url(self, episode_id: int) -> str:
         response = self._request(stream_api_url)
         return response.json().get("Video")
 
-    def get_drama_by_query(self, query: str) -> DramaInfo:
+    def get_drama_by_query(self, query: str) -> Optional[DramaInfo]:
         """Select specific drama from a search query
 
         :param query: search string
@@ -121,7 +122,7 @@ def get_drama_by_query(self, query: str) -> DramaInfo:
         dramas = self.search_dramas_by_query(query=query)
         if len(dramas) == 0:
             print(f"No drama with query {query} found! " "Make sure you spelled everything correct.")
-            return
+            return None
 
         user_selection = 0
         while user_selection < 1 or user_selection > len(dramas) + 1:

src/kisskh_downloader/kisskh_api.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, List
+from typing import Any, Dict, List
 
 from pydantic import BaseModel, Field
 
@@ -31,7 +31,7 @@ def __init__(self, **data: Any) -> None:
         data["episodes"] = sorted(data["episodes"], key=lambda episode: episode["number"])
         super().__init__(**data)
 
-    def get_episodes_ids(self, start: int, stop: int) -> dict[int, tuple[str, str]]:
+    def get_episodes_ids(self, start: int, stop: int) -> Dict[int, int]:
         episode_ids = {}
         if start < self.episodes[0].number or start > self.episodes[-1].number:
             start = self.episodes[0].number