sticker-convert 2.7.2__py3-none-any.whl → 2.7.4__py3-none-any.whl

sticker_convert/utils/callback.py

@@ -1,16 +1,25 @@
 #!/usr/bin/env python3
 from multiprocessing import Event, Queue
-from typing import Any, Callable, Optional, Union
+from typing import Any, Callable, Dict, Optional, Tuple, Union
 
 from tqdm import tqdm
 
+CbQueueTupleType = Tuple[
+    Optional[str], Optional[Tuple[Any, ...]], Optional[Dict[str, Any]]
+]
+CbQueueItemType = Union[
+    CbQueueTupleType,
+    str,
+    None,
+]
+
 
 class CallbackReturn:
-    def __init__(self):
+    def __init__(self) -> None:
         self.response_event = Event()
         self.response_queue: Queue[Union[bool, str, None]] = Queue()
 
-    def set_response(self, response: Union[bool, str, None]):
+    def set_response(self, response: Union[bool, str, None]) -> None:
         self.response_queue.put(response)
         self.response_event.set()
 
@@ -34,7 +43,7 @@ class Callback:
         ask_str: Optional[Callable[..., str]] = None,
         silent: bool = False,
         no_confirm: bool = False,
-    ):
+    ) -> None:
         self.progress_bar: Optional[tqdm[Any]] = None
 
         if msg:
@@ -65,7 +74,7 @@ class Callback:
         self.silent = silent
         self.no_confirm = no_confirm
 
-    def cb_msg(self, *args: Any, **kwargs: Any):
+    def cb_msg(self, *args: Any, **kwargs: Any) -> None:
         if self.silent:
             return
 
@@ -88,7 +97,7 @@ class Callback:
         set_progress_mode: Optional[str] = None,
         steps: int = 0,
         update_bar: bool = False,
-    ):
+    ) -> None:
         if self.silent:
             return
 
@@ -103,7 +112,7 @@ class Callback:
         elif set_progress_mode == "determinate":
             self.progress_bar = tqdm(total=steps)
 
-    def cb_msg_block(self, *args: Any):
+    def cb_msg_block(self, *args: Any) -> None:
         if self.silent:
             return
         if len(args) > 0:
@@ -122,16 +131,15 @@ class Callback:
                 '"--no-confirm" flag is set. Continue with this run without asking questions'
             )
             return True
-        else:
-            self.msg(
-                '[If you do not want to get asked by this question, add "--no-confirm" flag]'
-            )
-            self.msg()
-            result = input("Continue? [y/N] > ")
-            if result.lower() != "y":
-                return False
-            else:
-                return True
+
+        self.msg(
+            '[If you do not want to get asked by this question, add "--no-confirm" flag]'
+        )
+        self.msg()
+        result = input("Continue? [y/N] > ")
+        if result.lower() != "y":
+            return False
+        return True
 
     def cb_ask_str(
         self,
@@ -155,29 +163,29 @@ class Callback:
     def put(
         self,
         i: Union[
-            tuple[Optional[str], Optional[tuple[Any, ...]], Optional[dict[str, Any]]],
+            CbQueueItemType,
             str,
         ],
     ) -> Union[str, bool, None]:
         if isinstance(i, tuple):
             action = i[0]
             if len(i) >= 2:
-                args: tuple[str, ...] = i[1] if i[1] else tuple()
+                args: Tuple[str, ...] = i[1] if i[1] else tuple()
             else:
                 args = tuple()
             if len(i) >= 3:
-                kwargs: dict[str, Any] = i[2] if i[2] else dict()
+                kwargs: Dict[str, Any] = i[2] if i[2] else {}
             else:
-                kwargs = dict()
+                kwargs = {}
         else:
             action = i
             args = tuple()
-            kwargs = dict()
+            kwargs = {}
 
         # Fake implementation for Queue.put()
         if action is None:
             return None
-        elif action == "msg":
+        if action == "msg":
             self.msg(*args, **kwargs)
         elif action == "bar":
             self.bar(**kwargs)

sticker_convert/utils/files/cache_store.py

@@ -2,7 +2,10 @@
 import os
 import platform
 import shutil
+from contextlib import contextmanager
 from pathlib import Path
+from tempfile import TemporaryDirectory
+from typing import Any, ContextManager, Generator, Optional, Union
 from uuid import uuid4
 
 if platform.system() == "Linux":
@@ -12,14 +15,10 @@ if platform.system() == "Linux":
 else:
     import tempfile
 
-from contextlib import contextmanager
-from tempfile import TemporaryDirectory
-from typing import ContextManager, Optional, Union
-
 
 def debug_cache_dir(path: str) -> ContextManager[Path]:
     @contextmanager
-    def generator():
+    def generator() -> Generator[Any, Any, Any]:
         path_random = Path(path, str(uuid4()))
         os.mkdir(path_random)
         try:
@@ -34,8 +33,7 @@ class CacheStore:
     @staticmethod
     def get_cache_store(
         path: Optional[str] = None,
-    ) -> Union[ContextManager[Path], TemporaryDirectory[str]]:
+    ) -> "Union[ContextManager[Path], TemporaryDirectory[str]]":
         if path:
             return debug_cache_dir(path)
-        else:
-            return tempfile.TemporaryDirectory()  # type: ignore
+        return tempfile.TemporaryDirectory()  # type: ignore

sticker_convert/utils/files/json_manager.py

@@ -1,20 +1,19 @@
 #!/usr/bin/env python3
 import json
 from pathlib import Path
-from typing import Any
+from typing import Any, Dict
 
 
 class JsonManager:
     @staticmethod
-    def load_json(path: Path) -> dict[Any, Any]:
+    def load_json(path: Path) -> Dict[Any, Any]:
         if not path.is_file():
             raise RuntimeError(f"{path} cannot be found")
-        else:
-            with open(path, encoding="utf-8") as f:
-                data = json.load(f)
-            return data
+        with open(path, encoding="utf-8") as f:
+            data = json.load(f)
+        return data
 
     @staticmethod
-    def save_json(path: Path, data: dict[Any, Any]):
+    def save_json(path: Path, data: Dict[Any, Any]) -> None:
         with open(path, "w+", encoding="utf-8") as f:
             json.dump(data, f, indent=4)

sticker_convert/utils/files/json_resources_loader.py

@@ -0,0 +1,12 @@
+from typing import Dict
+
+from sticker_convert.definitions import ROOT_DIR
+from sticker_convert.utils.files.json_manager import JsonManager
+
+HELP_JSON: Dict[str, Dict[str, str]] = JsonManager.load_json(
+    ROOT_DIR / "resources/help.json"
+)
+INPUT_JSON = JsonManager.load_json(ROOT_DIR / "resources/input.json")
+COMPRESSION_JSON = JsonManager.load_json(ROOT_DIR / "resources/compression.json")
+OUTPUT_JSON = JsonManager.load_json(ROOT_DIR / "resources/output.json")
+EMOJI_JSON = JsonManager.load_json(ROOT_DIR / "resources/emoji.json")

sticker_convert/utils/files/metadata_handler.py

@@ -3,12 +3,57 @@ from __future__ import annotations
 
 import json
 from pathlib import Path
-from typing import Optional
+from typing import Dict, List, Optional, Tuple
 
-from sticker_convert.definitions import ROOT_DIR
-from sticker_convert.utils.files.json_manager import JsonManager
+from sticker_convert.utils.files.json_resources_loader import INPUT_JSON, OUTPUT_JSON
 from sticker_convert.utils.media.codec_info import CodecInfo
 
+RELATED_EXTENSIONS = (
+    ".png",
+    ".apng",
+    ".jpg",
+    ".jpeg",
+    ".gif",
+    ".tgs",
+    ".lottie",
+    ".json",
+    ".mp4",
+    ".mkv",
+    ".mov",
+    ".webm",
+    ".webp",
+    ".avi",
+    ".m4a",
+    ".wastickers",
+)
+RELATED_NAME = (
+    "title.txt",
+    "author.txt",
+    "emoji.txt",
+    "export-result.txt",
+    ".DS_Store",
+    "._.DS_Store",
+)
+
+BLACKLIST_PREFIX = ("cover",)
+BLACKLIST_SUFFIX = (".txt", ".m4a", ".wastickers", ".DS_Store", "._.DS_Store")
+
+XCODE_IMESSAGE_ICONSET = {
+    "App-Store-1024x1024pt.png": (1024, 1024),
+    "iPad-Settings-29pt@2x.png": (58, 58),
+    "iPhone-settings-29pt@2x.png": (58, 58),
+    "iPhone-settings-29pt@3x.png": (87, 87),
+    "Messages27x20pt@2x.png": (54, 40),
+    "Messages27x20pt@3x.png": (81, 60),
+    "Messages32x24pt@2x.png": (64, 48),
+    "Messages32x24pt@3x.png": (96, 72),
+    "Messages-App-Store-1024x768pt.png": (1024, 768),
+    "Messages-iPad-67x50pt@2x.png": (134, 100),
+    "Messages-iPad-Pro-74x55pt@2x.png": (148, 110),
+    "Messages-iPhone-60x45pt@2x.png": (120, 90),
+    "Messages-iPhone-60x45pt@3x.png": (180, 135),
+}
+
 
 def check_if_xcodeproj(path: Path) -> bool:
     if not path.is_dir():
@@ -22,44 +67,14 @@ def check_if_xcodeproj(path: Path) -> bool:
 class MetadataHandler:
     @staticmethod
     def get_files_related_to_sticker_convert(
-        dir: Path, include_archive: bool = True
-    ) -> list[Path]:
-        from sticker_convert.uploaders.xcode_imessage import XcodeImessageIconset
-
-        xcode_iconset = XcodeImessageIconset().iconset
-        related_extensions = (
-            ".png",
-            ".apng",
-            ".jpg",
-            ".jpeg",
-            ".gif",
-            ".tgs",
-            ".lottie",
-            ".json",
-            ".mp4",
-            ".mkv",
-            ".mov",
-            ".webm",
-            ".webp",
-            ".avi",
-            ".m4a",
-            ".wastickers",
-        )
-        related_name = (
-            "title.txt",
-            "author.txt",
-            "emoji.txt",
-            "export-result.txt",
-            ".DS_Store",
-            "._.DS_Store",
-        )
-
+        directory: Path, include_archive: bool = True
+    ) -> List[Path]:
         files = [
             i
-            for i in sorted(dir.iterdir())
-            if i.stem in related_name
-            or i.name in xcode_iconset
-            or i.suffix in related_extensions
+            for i in sorted(directory.iterdir())
+            if i.stem in RELATED_NAME
+            or i.name in XCODE_IMESSAGE_ICONSET
+            or i.suffix in RELATED_EXTENSIONS
             or (include_archive and i.name.startswith("archive_"))
             or check_if_xcodeproj(i)
         ]
@@ -67,51 +82,45 @@ class MetadataHandler:
         return files
 
     @staticmethod
-    def get_stickers_present(dir: Path) -> list[Path]:
-        from sticker_convert.uploaders.xcode_imessage import XcodeImessageIconset
-
-        blacklist_prefix = ("cover",)
-        blacklist_suffix = (".txt", ".m4a", ".wastickers", ".DS_Store", "._.DS_Store")
-        xcode_iconset = XcodeImessageIconset().iconset
-
+    def get_stickers_present(directory: Path) -> List[Path]:
         stickers_present = [
             i
-            for i in sorted(dir.iterdir())
-            if Path(dir, i.name).is_file()
-            and not i.name.startswith(blacklist_prefix)
-            and i.suffix not in blacklist_suffix
-            and i.name not in xcode_iconset
+            for i in sorted(directory.iterdir())
+            if Path(directory, i.name).is_file()
+            and not i.name.startswith(BLACKLIST_PREFIX)
+            and i.suffix not in BLACKLIST_SUFFIX
+            and i.name not in XCODE_IMESSAGE_ICONSET
         ]
 
         return stickers_present
 
     @staticmethod
-    def get_cover(dir: Path) -> Optional[Path]:
-        stickers_present = sorted(dir.iterdir())
+    def get_cover(directory: Path) -> Optional[Path]:
+        stickers_present = sorted(directory.iterdir())
         for i in stickers_present:
             if Path(i).stem == "cover":
-                return Path(dir, i.name)
+                return Path(directory, i.name)
 
         return None
 
     @staticmethod
     def get_metadata(
-        dir: Path,
+        directory: Path,
         title: Optional[str] = None,
         author: Optional[str] = None,
-        emoji_dict: Optional[dict[str, str]] = None,
-    ) -> tuple[Optional[str], Optional[str], Optional[dict[str, str]]]:
-        title_path = Path(dir, "title.txt")
+        emoji_dict: Optional[Dict[str, str]] = None,
+    ) -> Tuple[Optional[str], Optional[str], Optional[Dict[str, str]]]:
+        title_path = Path(directory, "title.txt")
         if not title and title_path.is_file():
             with open(title_path, encoding="utf-8") as f:
                 title = f.read().strip()
 
-        author_path = Path(dir, "author.txt")
+        author_path = Path(directory, "author.txt")
         if not author and author_path.is_file():
             with open(author_path, encoding="utf-8") as f:
                 author = f.read().strip()
 
-        emoji_path = Path(dir, "emoji.txt")
+        emoji_path = Path(directory, "emoji.txt")
         if not emoji_dict and emoji_path.is_file():
             with open(emoji_path, "r", encoding="utf-8") as f:
                 emoji_dict = json.load(f)
@@ -120,22 +129,22 @@ class MetadataHandler:
 
     @staticmethod
     def set_metadata(
-        dir: Path,
+        directory: Path,
         title: Optional[str] = None,
         author: Optional[str] = None,
-        emoji_dict: Optional[dict[str, str]] = None,
-    ):
-        title_path = Path(dir, "title.txt")
+        emoji_dict: Optional[Dict[str, str]] = None,
+    ) -> None:
+        title_path = Path(directory, "title.txt")
         if title is not None:
             with open(title_path, "w+", encoding="utf-8") as f:
                 f.write(title)
 
-        author_path = Path(dir, "author.txt")
+        author_path = Path(directory, "author.txt")
         if author is not None:
             with open(author_path, "w+", encoding="utf-8") as f:
                 f.write(author)
 
-        emoji_path = Path(dir, "emoji.txt")
+        emoji_path = Path(directory, "emoji.txt")
         if emoji_dict is not None:
             with open(emoji_path, "w+", encoding="utf-8") as f:
                 json.dump(emoji_dict, f, indent=4, ensure_ascii=False)
@@ -150,7 +159,7 @@ class MetadataHandler:
         Does not check if metadata provided via user input in GUI or flag options
         metadata = 'title' or 'author'
         """
-        input_presets = JsonManager.load_json(ROOT_DIR / "resources/input.json")
+        input_presets = INPUT_JSON
         assert input_presets
 
         if input_option == "local":
@@ -158,7 +167,7 @@ class MetadataHandler:
             metadata_provided = metadata_file_path.is_file()
             if metadata_provided:
                 with open(metadata_file_path, encoding="utf-8") as f:
-                    metadata_provided = True if f.read() else False
+                    metadata_provided = bool(f.read())
         else:
             metadata_provided = input_presets[input_option]["metadata_provides"][
                 metadata
@@ -169,21 +178,21 @@ class MetadataHandler:
     @staticmethod
     def check_metadata_required(output_option: str, metadata: str) -> bool:
         # metadata = 'title' or 'author'
-        output_presets = JsonManager.load_json(ROOT_DIR / "resources/output.json")
+        output_presets = OUTPUT_JSON
         assert output_presets
         return output_presets[output_option]["metadata_requirements"][metadata]
 
     @staticmethod
-    def generate_emoji_file(dir: Path, default_emoji: str = ""):
-        emoji_path = Path(dir, "emoji.txt")
+    def generate_emoji_file(directory: Path, default_emoji: str = "") -> None:
+        emoji_path = Path(directory, "emoji.txt")
         emoji_dict = None
         if emoji_path.is_file():
             with open(emoji_path, "r", encoding="utf-8") as f:
                 emoji_dict = json.load(f)
 
         emoji_dict_new = {}
-        for file in sorted(dir.iterdir()):
-            if not Path(dir, file).is_file() and CodecInfo.get_file_ext(file) in (
+        for file in sorted(directory.iterdir()):
+            if not Path(directory, file).is_file() and CodecInfo.get_file_ext(file) in (
                 ".txt",
                 ".m4a",
             ):
@@ -199,15 +208,15 @@ class MetadataHandler:
 
     @staticmethod
     def split_sticker_packs(
-        dir: Path,
+        directory: Path,
         title: str,
         file_per_pack: Optional[int] = None,
         file_per_anim_pack: Optional[int] = None,
         file_per_image_pack: Optional[int] = None,
         separate_image_anim: bool = True,
-    ) -> dict[str, list[Path]]:
+    ) -> Dict[str, List[Path]]:
         # {pack_1: [sticker1_path, sticker2_path]}
-        packs: dict[str, list[Path]] = {}
+        packs: Dict[str, List[Path]] = {}
 
         if file_per_pack is None:
             file_per_pack = (
@@ -219,13 +228,13 @@ class MetadataHandler:
             file_per_anim_pack = file_per_pack
             file_per_image_pack = file_per_pack
 
-        stickers_present = MetadataHandler.get_stickers_present(dir)
+        stickers_present = MetadataHandler.get_stickers_present(directory)
 
         processed = 0
 
         if separate_image_anim is True:
-            image_stickers: list[Path] = []
-            anim_stickers: list[Path] = []
+            image_stickers: List[Path] = []
+            anim_stickers: List[Path] = []
 
             image_pack_count = 0
             anim_pack_count = 0
@@ -234,7 +243,7 @@ class MetadataHandler:
             image_present = False
 
             for processed, file in enumerate(stickers_present):
-                file_path = dir / file
+                file_path = directory / file
 
                 if CodecInfo.is_anim(file_path):
                     anim_stickers.append(file_path)
@@ -244,7 +253,7 @@ class MetadataHandler:
                 anim_present = anim_present or len(anim_stickers) > 0
                 image_present = image_present or len(image_stickers) > 0
 
-                finished_all = True if processed == len(stickers_present) - 1 else False
+                finished_all = processed == len(stickers_present) - 1
 
                 if len(anim_stickers) == file_per_anim_pack or (
                     finished_all and len(anim_stickers) > 0
@@ -264,15 +273,15 @@ class MetadataHandler:
                     image_pack_count += 1
 
         else:
-            stickers: list[Path] = []
+            stickers: List[Path] = []
             pack_count = 0
 
             for processed, file in enumerate(stickers_present):
-                file_path = Path(dir, file)
+                file_path = Path(directory, file)
 
                 stickers.append(file_path)
 
-                finished_all = True if processed == len(stickers_present) - 1 else False
+                finished_all = processed == len(stickers_present) - 1
 
                 if len(stickers) == file_per_pack or (
                     finished_all and len(stickers) > 0

sticker_convert/utils/files/run_bin.py

@@ -3,32 +3,32 @@ import platform
 import shutil
 import subprocess
 from pathlib import Path
-from typing import Any, Callable, Union
+from typing import Any, Callable, List, Tuple, Union
 
 
 class RunBin:
     @staticmethod
     def get_bin(
-        bin: str, silent: bool = False, cb_msg: Callable[..., Any] = print
+        executable: str, silent: bool = False, cb_msg: Callable[..., Any] = print
     ) -> Union[str, None]:
-        if Path(bin).is_file():
-            return bin
+        if Path(executable).is_file():
+            return executable
 
         if platform.system() == "Windows":
-            bin = bin + ".exe"
+            executable = executable + ".exe"
 
-        which_result = shutil.which(bin)
+        which_result = shutil.which(executable)
         if which_result is not None:
             return str(Path(which_result).resolve())
-        elif silent is False:
-            cb_msg(f"Warning: Cannot find binary file {bin}")
+        if silent is False:
+            cb_msg(f"Warning: Cannot find binary file {executable}")
 
         return None
 
     @staticmethod
     def run_cmd(
-        cmd_list: list[str], silence: bool = False, cb_msg: Callable[..., Any] = print
-    ) -> tuple[bool, str]:
+        cmd_list: List[str], silence: bool = False, cb_msg: Callable[..., Any] = print
+    ) -> Tuple[bool, str]:
         bin_path = RunBin.get_bin(cmd_list[0])
 
         if bin_path:
@@ -46,6 +46,7 @@ class RunBin:
             stdin=subprocess.PIPE,
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
+            check=False,
         )
 
         output_str = sp.stdout.decode()

sticker_convert/utils/files/sanitize_filename.py

@@ -2,6 +2,32 @@
 import re
 import unicodedata
 
+BLACKLIST_CHAR = ("\\", "/", ":", "*", "?", '"', "<", ">", "|", "\0")
+RESERVED_FILENAME = (
+    "CON",
+    "PRN",
+    "AUX",
+    "NUL",
+    "COM1",
+    "COM2",
+    "COM3",
+    "COM4",
+    "COM5",
+    "COM6",
+    "COM7",
+    "COM8",
+    "COM9",
+    "LPT1",
+    "LPT2",
+    "LPT3",
+    "LPT4",
+    "LPT5",
+    "LPT6",
+    "LPT7",
+    "LPT8",
+    "LPT9",
+)  # Reserved words on Windows
+
 
 def sanitize_filename(filename: str) -> str:
     # Based on https://gitlab.com/jplusplus/sanitize-filename/-/blob/master/sanitize_filename/sanitize_filename.py
@@ -13,40 +39,16 @@ def sanitize_filename(filename: str) -> str:
     and make sure we do not exceed Windows filename length limits.
     Hence a less safe blacklist, rather than a whitelist.
     """
-    blacklist = ["\\", "/", ":", "*", "?", '"', "<", ">", "|", "\0"]
-    reserved = [
-        "CON",
-        "PRN",
-        "AUX",
-        "NUL",
-        "COM1",
-        "COM2",
-        "COM3",
-        "COM4",
-        "COM5",
-        "COM6",
-        "COM7",
-        "COM8",
-        "COM9",
-        "LPT1",
-        "LPT2",
-        "LPT3",
-        "LPT4",
-        "LPT5",
-        "LPT6",
-        "LPT7",
-        "LPT8",
-        "LPT9",
-    ]  # Reserved words on Windows
-    filename = "".join(c if c not in blacklist else "_" for c in filename)
+
+    filename = "".join(c if c not in BLACKLIST_CHAR else "_" for c in filename)
     # Remove all charcters below code point 32
     filename = "".join(c if 31 < ord(c) else "_" for c in filename)
     filename = unicodedata.normalize("NFKD", filename)
     filename = filename.rstrip(". ")  # Windows does not allow these at end
     filename = filename.strip()
-    if all([x == "." for x in filename]):
+    if all(x == "." for x in filename):
         filename = "__" + filename
-    if filename in reserved:
+    if filename in RESERVED_FILENAME:
         filename = "__" + filename
     if len(filename) == 0:
         filename = "__"

sticker_convert/utils/media/apple_png_normalize.py

@@ -3,6 +3,7 @@
 Required for pack_id < 775 (https://github.com/star-39/moe-sticker-bot/blob/ef2f06f3eb7a833e011e0a5201e007fc130978e7/pkg/msbimport/import_line.go#L68)
 Reference: https://stackoverflow.com/a/53622211
 """
+
 import struct
 import zlib
 
@@ -55,8 +56,8 @@ class ApplePngNormalize:
 
                 assert width
                 assert height
-                bufSize = width * height * 4 + height
-                chunk_data = zlib.decompress(chunk_d, -8, bufSize)
+                buf_size = width * height * 4 + height
+                chunk_data = zlib.decompress(chunk_d, -8, buf_size)
 
                 # Swapping red & blue bytes for each pixel
                 chunk_data = bytearray(chunk_data)