ASMRManager 2.2.7__tar.gz → 2.2.8__tar.gz

{asmrmanager-2.2.7 → asmrmanager-2.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ASMRManager
-Version: 2.2.7
+Version: 2.2.8
 Summary: download, manage and play the voices on asmr.one
 Keywords: asmr,downloader,music,player,manager,cli,tui,commandline,terminal
 Author-Email: SLQY <sqiyel@gmail.com>
@@ -163,6 +163,8 @@ pip install ASMRManager[依赖]
 - `pl add` 将某个音声添加到用户的云端播放列表(配合 `pl create` 使用)
 - `review` 为某个作品评分并评论(本地)
 
+更多使用示例可参考[这一小节](#使用示例)。
+
 > 使用命令时，如果不输入 RJID ，将会自动使用上一次命令的RJID。
 
 另外本工具提供基于 `trogon` 的可视化命令行界面，在安装`tui`依赖后使用 `asmr tui` 即可打开。
@@ -182,11 +184,59 @@ _ASMR_COMPLETE=zsh_source asmr > ~/.asmr-complete.zsh
 echo '. ~/.asmr-complete.zsh' >> ~/.zshrc
 ```
 
+## 使用示例
+搜索最近更新的40个(一页)作品并下载：
+```shell
+asmr dl search -o release --desc  # 选择并下载
+asmr dl search -o release --desc --all  # 下载全部
+```
+
+下载`治愈`标签下销量大于等于5000的全部的作品：
+```shell
+asmr dl search --tags 治愈 --sell 5000: --page 0 --all  # --page 0 会遍历下载所有页，否则默认只会下载第一页
+```
+
+下载某个社团下的全年龄并包含中文字幕的作品：
+```shell
+asmr dl search --circle Yostar --age general --subtitle
+```
+
+根据RJ/VJ/BJ号下载（下述输入格式适用于一切需要输入单个或多个ID的场合）：
+```shell
+asmr dl get RJ299717
+asmr dl get 299717  # RJ可以省略；对于8位RJ号，第一位的0也可以省略
+asmr dl get VJ015443
+asmr dl get 100000029  # 对于BJ与VJ，网站为了兼容RJ所使用的特殊ID
+asmr dl get 300015443  # 本项目存储VJ与BJ所使用的ID（"3" + 8位VJ号，BJ则为"4" + 8位BJ号）
+```
+
+检查下载目录下文件是否下载完全（只验证文件存在，不保证文件完整性）
+```shell
+asmr file check
+asmr file check --list | xargs asmr dl get --force   # 重新下载所有不完整的文件，以linux shell为例
+```
+
+将下载的文件转移到存储目录(STORAGE_PATH)，并执行相应文件格式转换(详情见config.toml的before_store字段)
+```shell
+asmr file store --all
+```
+
+比较本地文件与服务器文件的差异：
+
+![diff](./assets/diff.png)
+
+简单的关键词搜索（本地数据库）：
+```shell
+asmr query 治愈 --limit 3  # 搜索字段有：标题，社团名和标签名
+asmr query 治愈 --limit 3 --raw | jq .[].id | xargs -n1 asmr info # 输出为json格式，获取详细信息
+```
+
+
 ## 关于`dl search/get`的使用
 命令执行过程中会进行如下的检查与过滤操作：
 1. 开始下载前：检查RJ号是否应该下载，如果本地文件不存在或者数据库无记录都会执行下载操作。可以通过 `--force` 强制执行下载。
 1. 获取音声信息后：检查音声的tags，如果包含tag_filters里指定的tag，则跳过下载。可以通过 `--ignore-tag` 来强制下载。
-1. 获取下载文件后：检查文件的名称和路径，如果不符合filename_filters里指定的规则，则跳过下载。可以通过`ignore-name`来强制下载。
+1. 获取下载文件后：检查文件的名称和路径，如果不符合filename_filters里指定的规则，则跳过下载。可以通过`--ignore-name`来强制下载。
 1. 添加下载任务时：如果检测到本地有同名文件，则跳过该文件的下载。可以通过`--replace`来强制覆盖存在的文件。
 
 ## 其他

{asmrmanager-2.2.7 → asmrmanager-2.2.8}/README.md

@@ -121,6 +121,8 @@ pip install ASMRManager[依赖]
 - `pl add` 将某个音声添加到用户的云端播放列表(配合 `pl create` 使用)
 - `review` 为某个作品评分并评论(本地)
 
+更多使用示例可参考[这一小节](#使用示例)。
+
 > 使用命令时，如果不输入 RJID ，将会自动使用上一次命令的RJID。
 
 另外本工具提供基于 `trogon` 的可视化命令行界面，在安装`tui`依赖后使用 `asmr tui` 即可打开。
@@ -140,11 +142,59 @@ _ASMR_COMPLETE=zsh_source asmr > ~/.asmr-complete.zsh
 echo '. ~/.asmr-complete.zsh' >> ~/.zshrc
 ```
 
+## 使用示例
+搜索最近更新的40个(一页)作品并下载：
+```shell
+asmr dl search -o release --desc  # 选择并下载
+asmr dl search -o release --desc --all  # 下载全部
+```
+
+下载`治愈`标签下销量大于等于5000的全部的作品：
+```shell
+asmr dl search --tags 治愈 --sell 5000: --page 0 --all  # --page 0 会遍历下载所有页，否则默认只会下载第一页
+```
+
+下载某个社团下的全年龄并包含中文字幕的作品：
+```shell
+asmr dl search --circle Yostar --age general --subtitle
+```
+
+根据RJ/VJ/BJ号下载（下述输入格式适用于一切需要输入单个或多个ID的场合）：
+```shell
+asmr dl get RJ299717
+asmr dl get 299717  # RJ可以省略；对于8位RJ号，第一位的0也可以省略
+asmr dl get VJ015443
+asmr dl get 100000029  # 对于BJ与VJ，网站为了兼容RJ所使用的特殊ID
+asmr dl get 300015443  # 本项目存储VJ与BJ所使用的ID（"3" + 8位VJ号，BJ则为"4" + 8位BJ号）
+```
+
+检查下载目录下文件是否下载完全（只验证文件存在，不保证文件完整性）
+```shell
+asmr file check
+asmr file check --list | xargs asmr dl get --force   # 重新下载所有不完整的文件，以linux shell为例
+```
+
+将下载的文件转移到存储目录(STORAGE_PATH)，并执行相应文件格式转换(详情见config.toml的before_store字段)
+```shell
+asmr file store --all
+```
+
+比较本地文件与服务器文件的差异：
+
+![diff](./assets/diff.png)
+
+简单的关键词搜索（本地数据库）：
+```shell
+asmr query 治愈 --limit 3  # 搜索字段有：标题，社团名和标签名
+asmr query 治愈 --limit 3 --raw | jq .[].id | xargs -n1 asmr info # 输出为json格式，获取详细信息
+```
+
+
 ## 关于`dl search/get`的使用
 命令执行过程中会进行如下的检查与过滤操作：
 1. 开始下载前：检查RJ号是否应该下载，如果本地文件不存在或者数据库无记录都会执行下载操作。可以通过 `--force` 强制执行下载。
 1. 获取音声信息后：检查音声的tags，如果包含tag_filters里指定的tag，则跳过下载。可以通过 `--ignore-tag` 来强制下载。
-1. 获取下载文件后：检查文件的名称和路径，如果不符合filename_filters里指定的规则，则跳过下载。可以通过`ignore-name`来强制下载。
+1. 获取下载文件后：检查文件的名称和路径，如果不符合filename_filters里指定的规则，则跳过下载。可以通过`--ignore-name`来强制下载。
 1. 添加下载任务时：如果检测到本地有同名文件，则跳过该文件的下载。可以通过`--replace`来强制覆盖存在的文件。
 
 ## 其他

asmrmanager-2.2.8/asmrmanager/_version.py

@@ -0,0 +1 @@
+__version__ = "2.2.8"

{asmrmanager-2.2.7 → asmrmanager-2.2.8}/asmrmanager/cli/dl.py

@@ -28,7 +28,7 @@ def dl():
 @multi_rj_argument("remote")
 @download_param_options
 def get(source_ids: List[RemoteSourceID], download_params: DownloadParams):
-    """get ASMR by RJ ids"""
+    """get ASMR by RJ/VJ/BJ ids"""
     if not source_ids:
         logger.error("You must give at least one source id!")
         return

{asmrmanager-2.2.7 → asmrmanager-2.2.8}/asmrmanager/cli/file.py

@@ -290,11 +290,19 @@ def check(list_: bool):
                 print(source_id)
             continue
 
-        local_files = fm.get_all_files(source_id)
+        # local_files = fm.get_all_files(source_id)
         remote_files_should_down = set(
             [Path(i["path"]) for i in recovers if i["should_download"]]
         )
-        should_download_but_missing = remote_files_should_down - local_files
+        # should_download_but_missing = remote_files_should_down - local_files
+        should_download_but_missing = set(
+            filter(
+                lambda p: not any(
+                    fm.check_exists(f"{id2source_name(source_id)}/{str(p)}")
+                ),
+                remote_files_should_down,
+            )
+        )
         if len(should_download_but_missing):
             logger.error(
                 f"source_id {source_id} has missing files:\n"

{asmrmanager-2.2.7 → asmrmanager-2.2.8}/asmrmanager/cli/utils.py

@@ -51,7 +51,7 @@ def convert(
 
     fm = FileManager.get_fm()
 
-    path = fm.get_path(source_id, dst)
+    path = fm.get_path(source_id, prefer=dst)
     if path is None:
         logger.error("Source not found")
         exit(-1)

{asmrmanager-2.2.7 → asmrmanager-2.2.8}/asmrmanager/filemanager/manager.py

@@ -1,7 +1,16 @@
 import os
 import shutil
 from pathlib import Path
-from typing import Callable, Iterable, List, Literal, NamedTuple, Set, Tuple
+from typing import (
+    Callable,
+    Iterable,
+    List,
+    Literal,
+    NamedTuple,
+    Set,
+    Tuple,
+    overload,
+)
 
 import toml
 
@@ -301,20 +310,25 @@ class FileManager:
     def get_path(
         self,
         source_id: LocalSourceID,
+        rel: str = "",
         prefer: Literal["storage", "download"] = "storage",
     ) -> Path | None:
         """get rj file path"""
-        res = self.get_location(source_id, prefer=prefer)
-
-        match res:
-            case "download":
-                return self.download_path / id2source_name(source_id)
-            case "storage":
-                return self.storage_path / id2source_name(source_id)
-            case _:
-                return None
+        source_name = id2source_name(source_id)
+        path = f"{source_name}/{rel}"
+        res = self.check_exists(path)
+        # res = self.get_location(source_id, prefer=prefer)
+        if not any(res):
+            return None
+
+        return (
+            self.download_path / path
+            if res.__getattribute__(prefer)
+            else self.storage_path / path
+        )
 
-    def check_exists(self, rel_path: str):
+    def check_exists(self, rel_path: str, check_duplicate=True):
+        """rel_path = source_name/rel"""
         download, storage = False, False
         download_file_path = self.download_path / rel_path
         storage_file_path = self.storage_path / rel_path
@@ -322,39 +336,63 @@ class FileManager:
             download = True
         if storage_file_path.exists():
             storage = True
-        if (not download) and self.check_wav_flac_duplicate(
-            download_file_path
-        ):
-            download = True
-        if (not storage) and self.check_wav_flac_duplicate(storage_file_path):
-            storage = True
+
+        if check_duplicate:
+            if (not download) and self.check_file_duplicate(
+                download_file_path
+            ):
+                download = True
+            if (not storage) and self.check_file_duplicate(storage_file_path):
+                storage = True
 
         return NamedTuple(
             "ExistInfo", [("download", bool), ("storage", bool)]
         )(download, storage)
 
     @staticmethod
-    def check_wav_flac_duplicate(file_path: Path) -> bool:
-        """if file duplicate or already exists, return True"""
+    def check_file_duplicate(file_path: Path) -> bool:
+        """if file duplicate or already exists in a different type, return True"""
         if file_path.exists():
-            logger.error(
+            logger.warning(
                 f"file already exists: {file_path}, please "
                 "check for the existence of the download files first"
             )
             return True
-        match file_path.suffix.lower():
-            case ".wav":
-                another_file_path = file_path.with_suffix(".flac")
+
+        audio_formats = [".wav", ".flac", ".mp3", ".m4a"]
+        if file_path.suffix.lower() in audio_formats:
+            for audio_format in audio_formats:
+                another_file_path = file_path.with_suffix(audio_format)
                 if another_file_path.exists():
-                    logger.info(f"Detected {file_path} for same flac exists")
+                    logger.debug(
+                        f"Detected {file_path} duplicated for a same name {audio_format} exists"
+                    )
                     return True
-            case ".flac":
-                another_file_path = file_path.with_suffix(".wav")
+
+        lyrics_formats = [".lrc", ".vtt", ".mp3.vtt", ".wav.vtt"]
+        if file_path.suffix.lower() in lyrics_formats:
+            file_name = file_path.stem
+            for lyrics_format in lyrics_formats:
+                another_file_path = file_path.with_name(
+                    file_name + lyrics_format
+                )
                 if another_file_path.exists():
-                    logger.info(f"Detected {file_path} for same wav exists")
+                    logger.info(f"Detected {file_path} for same lyrics exists")
                     return True
-            case _:
-                pass
+
+        # match file_path.suffix.lower():
+        #     case ".wav":
+        #         another_file_path = file_path.with_suffix(".flac")
+        #         if another_file_path.exists():
+        #             logger.info(f"Detected {file_path} for same flac exists")
+        #             return True
+        #     case ".flac":
+        #         another_file_path = file_path.with_suffix(".wav")
+        #         if another_file_path.exists():
+        #             logger.info(f"Detected {file_path} for same wav exists")
+        #             return True
+        #     case _:
+        #         pass
 
         return False
 
@@ -362,13 +400,10 @@ class FileManager:
         self, source_id: LocalSourceID
     ) -> List[RecoverRecord] | None:
         """load recover file of source ID(choose download path first)"""
-        rj_path = self.get_path(source_id, prefer="download")
-        if rj_path is None:
-            logger.error(f"item {source_id} does not exist")
-            return
-
-        recover_path = rj_path / ".recover"
-        if not recover_path.exists():
+        recover_path = self.get_path(
+            source_id, rel=".recover", prefer="download"
+        )
+        if recover_path is None:
             logger.error(
                 f"item {source_id} does not have recover file, please update this"
                 " rj id first"

{asmrmanager-2.2.7 → asmrmanager-2.2.8}/pyproject.toml

@@ -33,7 +33,7 @@ dependencies = [
 ]
 requires-python = ">=3.10"
 readme = "README.md"
-version = "2.2.7"
+version = "2.2.8"
 
 [project.license]
 text = "MIT"

asmrmanager-2.2.7/asmrmanager/_version.py

@@ -1 +0,0 @@
-__version__ = "2.2.7"