Merge pull request '[2.2.19] - 2023-02-11' (#38) from dev into master

Reviewed-on: https://git.44net.ch/olofvndrhr/manga-dlp/pulls/38

.gitignore

@@ -13,6 +13,7 @@ mangas.txt
 .idea/
 venv
 test.sh
+.ruff_cache/
 
 ### Python template
 # Byte-compiled / optimized / DLL files

.tool-versions

@@ -1,5 +1,5 @@
 python 3.9.13 3.10.5 3.8.13
+shellcheck 0.9.0
 shfmt 3.6.0
-shellcheck 0.8.0
-just 1.13.0
-direnv 2.32.1
+direnv 2.32.2
+just 1.13.0

CHANGELOG.md

@@ -9,6 +9,20 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Add support for more sites
 
+## [2.2.19] - 2023-02-11
+
+### Added
+
+- First version of the chapter cache (very basic functionality)
+
+### Fixed
+
+- Fixed all exception re-raises to include the original stack trace
+
+### Changed
+
+- Simplified chapter download loop
+
 ## [2.2.18] - 2023-01-21
 
 ### Fixed

README.md

@@ -96,27 +96,27 @@ Script to download mangas from various sites
 Options:
 --help                          Show this message and exit.
 --version                       Show the version and exit.
-
 source: [mutually_exclusive, required]
--u, --url, --uuid TEXT          URL or UUID of the manga
---read FILE                     Path of file with manga links to download. One per line
-
+-u, --url, --uuid TEXT        URL or UUID of the manga
+--read FILE                   Path of file with manga links to download. One per line
 verbosity: [mutually_exclusive]
---loglevel INTEGER              Custom log level  [default: 20]
---warn                          Only log warnings and higher
---debug                         Debug logging. Log EVERYTHING
-
+--loglevel INTEGER            Custom log level
+--warn                        Only log warnings and higher
+--debug                       Debug logging. Log EVERYTHING
 -c, --chapters TEXT             Chapters to download
 -p, --path PATH                 Download path  [default: downloads]
 -l, --language TEXT             Manga language  [default: en]
 --list                          List all available chapters
---format TEXT                   Archive format to create. An empty string means dont archive the folder  [default: cbz]
+--format [cbz|cbr|zip|pdf|]     Archive format to create. An empty string means dont archive the folder  [default: cbz]
+--name-format TEXT              Naming format to use when saving chapters. See docs for more infos  [default: {default}]
+--name-format-none TEXT         String to use when the variable of the custom name format is empty
 --forcevol                      Force naming of volumes. For mangas where chapters reset each volume
 --wait FLOAT                    Time to wait for each picture to download in seconds(float)  [default: 0.5]
 --hook-manga-pre TEXT           Commands to execute before the manga download starts
 --hook-manga-post TEXT          Commands to execute after the manga download finished
 --hook-chapter-pre TEXT         Commands to execute before the chapter download starts
 --hook-chapter-post TEXT        Commands to execute after the chapter download finished
+--cache-path PATH               Where to store the cache-db. If no path is given, cache is disabled
 ```
 
 ## Contribution / Bugs

docker/Dockerfile.amd64

@@ -1,8 +1,8 @@
-FROM cr.44net.ch/baseimages/debian-s6:11.5-linux-amd64
+FROM cr.44net.ch/baseimages/debian-s6:11.6-linux-amd64
 
 # set version label
 ARG BUILD_VERSION
-ENV MDLP_VERSION=${BUILD_VERSION}
+ENV IMAGE_VERSION=${BUILD_VERSION}
 LABEL version="${BUILD_VERSION}"
 LABEL maintainer="Ivan Schaller"
 LABEL description="A CLI manga downloader"

docker/Dockerfile.arm64

@@ -1,8 +1,8 @@
-FROM cr.44net.ch/baseimages/debian-s6:11.5-linux-arm64
+FROM cr.44net.ch/baseimages/debian-s6:11.6-linux-arm64
 
 # set version label
 ARG BUILD_VERSION
-ENV MDLP_VERSION=${BUILD_VERSION}
+ENV IMAGE_VERSION=${BUILD_VERSION}
 LABEL version="${BUILD_VERSION}"
 LABEL maintainer="Ivan Schaller"
 LABEL description="A CLI manga downloader"

docs/pages/download.md

@@ -159,3 +159,11 @@ link3
 `python3 manga-dlp.py --read mangas.txt --list`
 
 This will list all available chapters for link1, link2 and link3.
+
+## Create basic cache
+
+With the `--cache-path <cache file>` option you can let the script create a very basic json cache. Your downloaded
+chapters will be
+tracked there, and the script doesn't have to check on disk if you already downloaded it.
+
+If the option is unset (default), then no caching will be done.

docs/pages/index.md

@@ -94,27 +94,27 @@ Script to download mangas from various sites
 Options:
 --help                          Show this message and exit.
 --version                       Show the version and exit.
-
 source: [mutually_exclusive, required]
--u, --url, --uuid TEXT          URL or UUID of the manga
---read FILE                     Path of file with manga links to download. One per line
-
+-u, --url, --uuid TEXT        URL or UUID of the manga
+--read FILE                   Path of file with manga links to download. One per line
 verbosity: [mutually_exclusive]
---loglevel INTEGER              Custom log level  [default: 20]
---warn                          Only log warnings and higher
---debug                         Debug logging. Log EVERYTHING
-
+--loglevel INTEGER            Custom log level
+--warn                        Only log warnings and higher
+--debug                       Debug logging. Log EVERYTHING
 -c, --chapters TEXT             Chapters to download
 -p, --path PATH                 Download path  [default: downloads]
 -l, --language TEXT             Manga language  [default: en]
 --list                          List all available chapters
---format TEXT                   Archive format to create. An empty string means dont archive the folder  [default: cbz]
+--format [cbz|cbr|zip|pdf|]     Archive format to create. An empty string means dont archive the folder  [default: cbz]
+--name-format TEXT              Naming format to use when saving chapters. See docs for more infos  [default: {default}]
+--name-format-none TEXT         String to use when the variable of the custom name format is empty
 --forcevol                      Force naming of volumes. For mangas where chapters reset each volume
 --wait FLOAT                    Time to wait for each picture to download in seconds(float)  [default: 0.5]
 --hook-manga-pre TEXT           Commands to execute before the manga download starts
 --hook-manga-post TEXT          Commands to execute after the manga download finished
 --hook-chapter-pre TEXT         Commands to execute before the chapter download starts
 --hook-chapter-post TEXT        Commands to execute after the chapter download finished
+--cache-path PATH               Where to store the cache-db. If no path is given, cache is disabled
 ```
 
 ## Contribution / Bugs

mangadlp/__about__.py

@@ -1 +1 @@
-__version__ = "2.2.18"
+__version__ = "2.2.19"

mangadlp/api/mangadex.py

@@ -45,14 +45,11 @@ def __init__(self, url_uuid: str, language: str, forcevol: bool):
         self.api_additions = f"{self.api_language}&{self.api_content_ratings}"
 
         # infos from functions
-        try:
-            self.manga_uuid = self.get_manga_uuid()
-            self.manga_data = self.get_manga_data()
-            self.manga_title = self.get_manga_title()
-            self.manga_chapter_data = self.get_chapter_data()
-            self.chapter_list = self.create_chapter_list()
-        except Exception as exc:
-            raise RuntimeError from exc
+        self.manga_uuid = self.get_manga_uuid()
+        self.manga_data = self.get_manga_data()
+        self.manga_title = self.get_manga_title()
+        self.manga_chapter_data = self.get_chapter_data()
+        self.chapter_list = self.create_chapter_list()
 
     # get the uuid for the manga
     def get_manga_uuid(self) -> str:
@@ -65,7 +62,7 @@ def get_manga_uuid(self) -> str:
             uuid = uuid_regex.search(self.url_uuid)[0]  # type: ignore
         except Exception as exc:
             log.error("No valid UUID found")
-            raise KeyError("No valid UUID found") from exc
+            raise exc
 
         return uuid
 
@@ -81,7 +78,7 @@ def get_manga_data(self) -> dict:
             except Exception as exc:
                 if counter >= 3:
                     log.error("Maybe the MangaDex API is down?")
-                    raise ConnectionError("Maybe the MangaDex API is down?") from exc
+                    raise exc
                 log.error("Mangadex API not reachable. Retrying")
                 sleep(2)
                 counter += 1
@@ -90,7 +87,7 @@ def get_manga_data(self) -> dict:
         # check if manga exists
         if response.json()["result"] != "ok":
             log.error("Manga not found")
-            raise KeyError("Manga not found")
+            raise KeyError
 
         return response.json()["data"]
 
@@ -101,7 +98,7 @@ def get_manga_title(self) -> str:
         # try to get the title in requested language
         try:
             title = attributes["title"][self.language]
-        except Exception:
+        except KeyError:
             log.info("Manga title not found in requested language. Trying alt titles")
         else:
             log.debug(f"Language={self.language}, Title='{title}'")
@@ -115,7 +112,7 @@ def get_manga_title(self) -> str:
                     alt_title = item
                     break
             title = alt_title[self.language]
-        except Exception:
+        except (KeyError, UnboundLocalError):
             log.warning(
                 "Manga title also not found in alt titles. Falling back to english title"
             )
@@ -140,7 +137,7 @@ def check_chapter_lang(self) -> int:
             log.error(
                 "Error retrieving the chapters list. Did you specify a valid language code?"
             )
-            raise KeyError from exc
+            raise exc
         else:
             if total_chapters == 0:
                 log.error("No chapters available to download in specified language")