sticker-convert 2.10.7__py3-none-any.whl → 2.10.9__py3-none-any.whl

sticker_convert/job.py

@@ -216,7 +216,6 @@ class Job:
         self.cb_ask_bool = cb_ask_bool
         self.cb_ask_str = cb_ask_str
 
-        self.compress_fails: List[str] = []
         self.out_urls: List[str] = []
 
         self.executor = Executor(
@@ -236,19 +235,21 @@ class Job:
 
         self.executor.cb("msg", kwargs={"cls": True})
 
-        tasks = (
+        tasks: Tuple[Callable[..., Tuple[bool, Optional[str]]], ...] = (
             self.verify_input,
             self.cleanup,
             self.download,
             self.compress,
             self.export,
-            self.report,
         )
 
         code = 0
+        summaries: List[str] = []
         for task in tasks:
             self.executor.cb("bar", kwargs={"set_progress_mode": "indeterminate"})
-            success = task()
+            success, summary = task()
+            if summary is not None:
+                summaries.append(summary)
 
             if self.executor.is_cancel_job.value == 1:  # type: ignore
                 code = 2
@@ -258,6 +259,22 @@ class Job:
                 self.executor.cb("An error occured during this run.")
                 break
 
+        msg = "##########\n"
+        msg += "Summary:\n"
+        msg += "##########\n"
+
+        msg += "\n"
+        msg += "\n".join(summaries)
+        msg += "\n"
+
+        if self.out_urls:
+            msg += "Export results:\n"
+            msg += "\n".join(self.out_urls)
+        else:
+            msg += "Export result: None"
+
+        self.executor.cb(msg)
+
         self.executor.cleanup()
 
         return code
@@ -265,7 +282,7 @@ class Job:
     def cancel(self, *_: Any, **_kwargs: Any) -> None:
         self.executor.kill_workers()
 
-    def verify_input(self) -> bool:
+    def verify_input(self) -> Tuple[bool, None]:
         info_msg = ""
         error_msg = ""
 
@@ -352,7 +369,7 @@ class Job:
 
         if error_msg != "":
             self.executor.cb(error_msg)
-            return False
+            return False, None
 
         # Check if preset not equal to export option
         # Only warn if the compression option is available in export preset
@@ -372,7 +389,7 @@ class Job:
             response = self.executor.cb_return.get_response()
 
             if response is False:
-                return False
+                return False, None
 
         for param, value in (
             ("fps_power", self.opt_comp.fps_power),
@@ -431,7 +448,7 @@ class Job:
             response = self.executor.cb_return.get_response()
 
             if response is False:
-                return False
+                return False, None
 
         # Warn about in/output directories that might contain other files
         # Directory is safe if the name is stickers_input/stickers_output, or
@@ -468,13 +485,13 @@ class Job:
                 response = self.executor.cb_return.get_response()
 
                 if response is False:
-                    return False
+                    return False, None
 
                 break
 
-        return True
+        return True, None
 
-    def cleanup(self) -> bool:
+    def cleanup(self) -> Tuple[bool, None]:
         # If input is 'From local directory', then we should keep files in input/output directory as it maybe edited by user
         # If input is not 'From local directory', then we should move files in input/output directory as new files will be downloaded
         # Output directory should be cleanup unless no_compress is true (meaning files in output directory might be edited by user)
@@ -523,10 +540,10 @@ class Job:
                 new_path = Path(archive_dir, old_path.name)
                 old_path.rename(new_path)
 
-        return True
+        return True, None
 
-    def download(self) -> bool:
-        downloaders: List[Callable[..., bool]] = []
+    def download(self) -> Tuple[bool, str]:
+        downloaders: List[Callable[..., Tuple[int, int]]] = []
 
         if self.opt_input.option == "signal":
             downloaders.append(DownloadSignal.start)
@@ -549,8 +566,8 @@ class Job:
         if len(downloaders) > 0:
             self.executor.cb("Downloading...")
         else:
-            self.executor.cb("Nothing to download")
-            return True
+            self.executor.cb("Skipped download (No files to download)")
+            return True, "Download: Skipped (No files to download)"
 
         self.executor.start_workers(processes=1)
 
@@ -563,15 +580,24 @@ class Job:
         self.executor.join_workers()
 
         # Return False if any of the job returns failure
+        stickers_ok = 0
+        stickers_total = 0
+        success = True
         for result in self.executor.results_list:
-            if result is False:
-                return False
+            stickers_ok += result[0]
+            stickers_total += result[1]
+            success = (
+                success if stickers_ok == stickers_total and stickers_ok > 0 else False
+            )
 
-        return True
+        return (
+            success,
+            f"Download: {stickers_ok}/{stickers_total} stickers success",
+        )
 
-    def compress(self) -> bool:
+    def compress(self) -> Tuple[bool, str]:
         if self.opt_comp.no_compress is True:
-            self.executor.cb("no_compress is set to True, skip compression")
+            self.executor.cb("Skipped compression (no_compress is set to True)")
             in_dir_files = [
                 i
                 for i in sorted(self.opt_input.dir.iterdir())
@@ -598,7 +624,7 @@ class Job:
                     src_f = Path(self.opt_input.dir, i.name)
                     dst_f = Path(self.opt_output.dir, i.name)
                     shutil.copy(src_f, dst_f)
-            return True
+            return True, "Compress: Skipped (no_compress is set to True)"
         msg = "Compressing..."
 
         input_dir = Path(self.opt_input.dir)
@@ -620,8 +646,8 @@ class Job:
 
         in_fs_count = len(in_fs)
         if in_fs_count == 0:
-            self.executor.cb("No files to compress")
-            return True
+            self.executor.cb("Skipped compression (No files to compress)")
+            return True, "Compress: Skipped (No files to compress)"
 
         self.executor.cb(msg)
         self.executor.cb(
@@ -640,21 +666,35 @@ class Job:
 
         self.executor.join_workers()
 
-        # Return False if any of the job returns failure
+        success = True
+        stickers_ok = 0
+        stickers_total = 0
+        fails: List[str] = []
         for result in self.executor.results_list:
+            stickers_total += 1
             if result[0] is False:
-                return False
+                success = False
+                fails.append(str(result[1]))
+            else:
+                stickers_ok += 1
+
+        msg_append = ""
+        if success is False:
+            msg_append = " (Failed: " + ", ".join(fails) + ")"
 
-        return True
+        return (
+            success,
+            f"Compress: {stickers_ok}/{stickers_total} stickers success" + msg_append,
+        )
 
-    def export(self) -> bool:
+    def export(self) -> Tuple[bool, str]:
         if self.opt_output.option == "local":
-            self.executor.cb("Saving to local directory only, nothing to export")
-            return True
+            self.executor.cb("Skipped export (Saving to local directory only)")
+            return True, "Export: Skipped (Saving to local directory only)"
 
         self.executor.cb("Exporting...")
 
-        exporters: List[Callable[..., List[str]]] = []
+        exporters: List[Callable[..., Tuple[int, int, List[str]]]] = []
 
         if self.opt_output.option == "whatsapp":
             exporters.append(CompressWastickers.start)
@@ -684,8 +724,12 @@ class Job:
 
         self.executor.join_workers()
 
+        stickers_ok = 0
+        stickers_total = 0
         for result in self.executor.results_list:
-            self.out_urls.extend(result)
+            stickers_ok += result[0]
+            stickers_total += result[1]
+            self.out_urls.extend(result[2])
 
         if self.out_urls:
             with open(
@@ -694,29 +738,6 @@ class Job:
                 f.write("\n".join(self.out_urls))
         else:
             self.executor.cb("An error occured while exporting stickers")
-            return False
-
-        return True
-
-    def report(self) -> bool:
-        msg = "##########\n"
-        msg += "Summary:\n"
-        msg += "##########\n"
-        msg += "\n"
-
-        if self.compress_fails:
-            msg += f'Warning: Could not compress the following {len(self.compress_fails)} file{"s" if len(self.compress_fails) > 1 else ""}:\n'
-            msg += "\n".join(self.compress_fails)
-            msg += "\n"
-            msg += "\nConsider adjusting compression parameters"
-            msg += "\n"
-
-        if self.out_urls:
-            msg += "Export results:\n"
-            msg += "\n".join(self.out_urls)
-        else:
-            msg += "Export result: None"
-
-        self.executor.cb(msg)
+            return False, f"Export: {stickers_ok}/{stickers_total} stickers success"
 
-        return True
+        return True, f"Export: {stickers_ok}/{stickers_total} stickers success"

sticker_convert/uploaders/compress_wastickers.py

@@ -3,7 +3,7 @@ import copy
 import shutil
 import zipfile
 from pathlib import Path
-from typing import Any, List
+from typing import Any, List, Tuple
 
 from sticker_convert.converter import StickerConvert
 from sticker_convert.job_option import CompOption, CredOption, OutputOption
@@ -47,7 +47,7 @@ class CompressWastickers(UploadBase):
         self.opt_comp_merged = copy.deepcopy(self.opt_comp)
         self.opt_comp_merged.merge(self.base_spec)
 
-    def compress_wastickers(self) -> List[str]:
+    def compress_wastickers(self) -> Tuple[int, int, List[str]]:
         urls: List[str] = []
         title, author, _ = MetadataHandler.get_metadata(
             self.opt_output.dir,
@@ -56,10 +56,10 @@ class CompressWastickers(UploadBase):
         )
         if not title:
             self.cb.put("Title is required for compressing .wastickers")
-            return urls
+            return 0, 0, urls
         if not author:
             self.cb.put("Author is required for compressing .wastickers")
-            return urls
+            return 0, 0, urls
         packs = MetadataHandler.split_sticker_packs(
             self.opt_output.dir,
             title=title,
@@ -67,7 +67,9 @@ class CompressWastickers(UploadBase):
             separate_image_anim=not self.opt_comp.fake_vid,
         )
 
+        stickers_total = 0
         for pack_title, stickers in packs.items():
+            stickers_total += len(stickers)
             # Originally the Sticker Maker application name the files with int(time.time())
             with CacheStore.get_cache_store(path=self.opt_comp.cache_dir) as tempdir:
                 for num, src in enumerate(stickers):
@@ -106,7 +108,7 @@ class CompressWastickers(UploadBase):
             self.cb.put((out_f))
             urls.append(out_f)
 
-        return urls
+        return stickers_total, stickers_total, urls
 
     def add_metadata(self, pack_dir: Path, title: str, author: str) -> None:
         opt_comp_merged = copy.deepcopy(self.opt_comp)
@@ -150,6 +152,6 @@ class CompressWastickers(UploadBase):
         opt_cred: CredOption,
         cb: CallbackProtocol,
         cb_return: CallbackReturn,
-    ) -> List[str]:
+    ) -> Tuple[int, int, List[str]]:
         exporter = CompressWastickers(opt_output, opt_comp, opt_cred, cb, cb_return)
         return exporter.compress_wastickers()

sticker_convert/uploaders/upload_signal.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 import copy
 from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Tuple
 
 import anyio
 from signalstickers_client.errors import SignalException
@@ -91,15 +91,15 @@ class UploadSignal(UploadBase):
 
             pack._addsticker(sticker)  # type: ignore
 
-    def upload_stickers_signal(self) -> List[str]:
+    def upload_stickers_signal(self) -> Tuple[int, int, List[str]]:
         urls: List[str] = []
 
         if not self.opt_cred.signal_uuid:
             self.cb.put("uuid required for uploading to Signal")
-            return urls
+            return 0, 0, urls
         if not self.opt_cred.signal_password:
             self.cb.put("password required for uploading to Signal")
-            return urls
+            return 0, 0, urls
 
         title, author, emoji_dict = MetadataHandler.get_metadata(
             self.opt_output.dir,
@@ -138,7 +138,10 @@ class UploadSignal(UploadBase):
             file_per_pack=200,
             separate_image_anim=False,
         )
+        stickers_total = 0
+        stickers_ok = 0
         for pack_title, stickers in packs.items():
+            stickers_total += len(stickers)
             pack = LocalStickerPack()
             pack.title = pack_title
             pack.author = author
@@ -155,11 +158,12 @@ class UploadSignal(UploadBase):
                 )
                 self.cb.put((result))
                 urls.append(result)
+                stickers_ok += len(stickers)
 
             except SignalException as e:
                 self.cb.put(f"Failed to upload pack {pack_title} due to {repr(e)}")
 
-        return urls
+        return stickers_ok, stickers_total, urls
 
     @staticmethod
     def start(
@@ -168,6 +172,6 @@ class UploadSignal(UploadBase):
         opt_cred: CredOption,
         cb: CallbackProtocol,
         cb_return: CallbackReturn,
-    ) -> List[str]:
+    ) -> Tuple[int, int, List[str]]:
         exporter = UploadSignal(opt_output, opt_comp, opt_cred, cb, cb_return)
         return exporter.upload_stickers_signal()

sticker_convert/uploaders/upload_telegram.py

@@ -2,7 +2,7 @@
 import copy
 import re
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Union, cast
+from typing import Any, Dict, List, Optional, Tuple, Union, cast
 
 import anyio
 from telegram import InputSticker, Sticker
@@ -153,9 +153,9 @@ class UploadTelegram(UploadBase):
                 sticker_type = Sticker.REGULAR
 
             init_input_stickers: List[InputSticker] = []
+            extra_input_stickers: List[Tuple[InputSticker, Path]] = []
             sticker_format = None
-            sticker_format_prev = None
-            for count, src in enumerate(stickers):
+            for src in stickers:
                 self.cb.put(f"Verifying {src} for uploading to telegram")
 
                 emoji = extract_emojis(emoji_dict.get(Path(src).stem, ""))
@@ -205,54 +205,55 @@ class UploadTelegram(UploadBase):
                     format=sticker_format,
                 )
 
-                if sticker_set is None:
-                    if count < 50 and (
-                        sticker_format_prev is None
-                        or sticker_format_prev == sticker_format
-                    ):
-                        init_input_stickers.append(input_sticker)
-                    else:
-                        start_msg = f"Creating pack and bulk uploading {count} stickers with same format of {pack_short_name}"
-                        finish_msg = f"Created pack and bulk uploaded {count} stickers with same format of {pack_short_name}"
-                        error_msg = f"Cannot create pack and bulk upload {count} stickers with same format of {pack_short_name} due to"
-                        self.cb.put(start_msg)
-                        try:
-                            await bot.create_new_sticker_set(
-                                user_id=self.telegram_userid,
-                                name=pack_short_name,
-                                title=pack_title,
-                                stickers=init_input_stickers,
-                                sticker_type=sticker_type,
-                            )
-                            sticker_set = True
-                            self.cb.put(finish_msg)
-                        except TelegramError as e:
-                            self.cb.put(f"{error_msg} {e}")
-                            return None
+                if sticker_set is None and len(init_input_stickers) < 50:
+                    init_input_stickers.append(input_sticker)
                 else:
-                    try:
-                        # We could use tg.start_soon() here
-                        # But this would disrupt the order of stickers
-                        await bot.add_sticker_to_set(
-                            user_id=self.telegram_userid,
-                            name=pack_short_name,
-                            sticker=input_sticker,
-                        )
-                        self.cb.put(f"Uploaded sticker {src} of {pack_short_name}")
-                    except BadRequest as e:
-                        self.cb.put(
-                            f"Cannot upload sticker {src} of {pack_short_name} due to {e}"
-                        )
-                        if str(e) == "Stickerpack_not_found":
-                            self.cb.put(
-                                "Hint: You might had deleted and recreated pack too quickly. Wait about 3 minutes and try again."
-                            )
-                    except TelegramError as e:
+                    extra_input_stickers.append((input_sticker, src))
+
+            if len(init_input_stickers) > 0:
+                self.cb.put(
+                    f"Creating pack and bulk uploading {len(init_input_stickers)} stickers of {pack_short_name}"
+                )
+                try:
+                    await bot.create_new_sticker_set(
+                        user_id=self.telegram_userid,
+                        name=pack_short_name,
+                        title=pack_title,
+                        stickers=init_input_stickers,
+                        sticker_type=sticker_type,
+                    )
+                    sticker_set = True
+                    self.cb.put(
+                        f"Created pack and bulk uploaded {len(init_input_stickers)} stickers of {pack_short_name}"
+                    )
+                except TelegramError as e:
+                    self.cb.put(
+                        f"Cannot create pack and bulk upload {len(init_input_stickers)} stickers of {pack_short_name} due to {e}"
+                    )
+                    return None
+
+            for input_sticker, src in extra_input_stickers:
+                try:
+                    # We could use tg.start_soon() here
+                    # But this would disrupt the order of stickers
+                    await bot.add_sticker_to_set(
+                        user_id=self.telegram_userid,
+                        name=pack_short_name,
+                        sticker=input_sticker,
+                    )
+                    self.cb.put(f"Uploaded sticker {src} of {pack_short_name}")
+                except BadRequest as e:
+                    self.cb.put(
+                        f"Cannot upload sticker {src} of {pack_short_name} due to {e}"
+                    )
+                    if str(e) == "Stickerpack_not_found":
                         self.cb.put(
-                            f"Cannot upload sticker {src} of {pack_short_name} due to {e}"
+                            "Hint: You might had deleted and recreated pack too quickly. Wait about 3 minutes and try again."
                         )
-
-                sticker_format_prev = sticker_format
+                except TelegramError as e:
+                    self.cb.put(
+                        f"Cannot upload sticker {src} of {pack_short_name} due to {e}"
+                    )
 
             cover_path = MetadataHandler.get_cover(self.opt_output.dir)
             if cover_path:
@@ -306,18 +307,18 @@ class UploadTelegram(UploadBase):
             result = f"https://t.me/addstickers/{pack_short_name}"
         return result
 
-    def upload_stickers_telegram(self) -> List[str]:
+    def upload_stickers_telegram(self) -> Tuple[int, int, List[str]]:
         urls: List[str] = []
 
         if not (self.opt_cred.telegram_token and self.opt_cred.telegram_userid):
             self.cb.put("Token and userid required for uploading to telegram")
-            return urls
+            return 0, 0, urls
 
         if self.opt_cred.telegram_userid.isnumeric():
             self.telegram_userid = int(self.opt_cred.telegram_userid)
         else:
             self.cb.put("Invalid userid, should contain numbers only")
-            return urls
+            return 0, 0, urls
 
         title, _, emoji_dict = MetadataHandler.get_metadata(
             self.opt_output.dir,
@@ -361,14 +362,18 @@ class UploadTelegram(UploadBase):
             separate_image_anim=not self.opt_comp.fake_vid,
         )
 
+        stickers_total = 0
+        stickers_ok = 0
         for pack_title, stickers in packs.items():
+            stickers_total += len(stickers)
             self.cb.put(f"Uploading pack {pack_title}")
             result = anyio.run(self.upload_pack, pack_title, stickers, emoji_dict)
             if result:
                 self.cb.put((result))
                 urls.append(result)
+                stickers_ok += len(stickers)
 
-        return urls
+        return stickers_ok, stickers_total, urls
 
     @staticmethod
     def start(
@@ -377,7 +382,7 @@ class UploadTelegram(UploadBase):
         opt_cred: CredOption,
         cb: CallbackProtocol,
         cb_return: CallbackReturn,
-    ) -> List[str]:
+    ) -> Tuple[int, int, List[str]]:
         exporter = UploadTelegram(
             opt_output,
             opt_comp,

sticker_convert/uploaders/upload_viber.py

@@ -4,7 +4,7 @@ import json
 import shutil
 import zipfile
 from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Tuple
 
 import requests
 
@@ -35,12 +35,12 @@ class UploadViber(UploadBase):
         self.opt_comp_merged = copy.deepcopy(self.opt_comp)
         self.opt_comp_merged.merge(self.png_spec)
 
-    def upload_stickers_viber(self) -> List[str]:
+    def upload_stickers_viber(self) -> Tuple[int, int, List[str]]:
         urls: List[str] = []
 
         if not self.opt_cred.viber_auth:
             self.cb.put("Viber auth required for uploading to viber")
-            return urls
+            return 0, 0, urls
 
         upload_data_base: Dict[str, str] = {}
         for i in self.opt_cred.viber_auth.split(";"):
@@ -49,13 +49,13 @@ class UploadViber(UploadBase):
 
         if upload_data_base.get("member_id") is None:
             self.cb.put("Invalid Viber auth: Missing member_id")
-            return urls
+            return 0, 0, urls
         if upload_data_base.get("m_token") is None:
             self.cb.put("Invalid Viber auth: Missing m_token")
-            return urls
+            return 0, 0, urls
         if upload_data_base.get("m_ts") is None:
             self.cb.put("Invalid Viber auth: Missing m_ts")
-            return urls
+            return 0, 0, urls
 
         title, author, _ = MetadataHandler.get_metadata(
             self.opt_output.dir,
@@ -92,7 +92,10 @@ class UploadViber(UploadBase):
                 self.cb_return,
             )
 
+        stickers_total = 0
+        stickers_ok = 0
         for pack_title, stickers in packs.items():
+            stickers_total += len(stickers)
             with CacheStore.get_cache_store(path=self.opt_comp.cache_dir) as tempdir:
                 for num, src in enumerate(stickers):
                     self.cb.put(f"Verifying {src} for uploading to Viber")
@@ -141,6 +144,7 @@ class UploadViber(UploadBase):
                     url = f"https://stickers.viber.com/pages/custom-sticker-packs/{pack_id}"
                     urls.append(url)
                     self.cb.put(f"Uploaded {pack_title}")
+                    stickers_ok += len(stickers)
                 else:
                     self.cb.put(
                         f"Failed to upload {pack_title}: {r.status_code} {r.text}"
@@ -152,7 +156,7 @@ class UploadViber(UploadBase):
             else:
                 self.cb.put(f"Failed to upload {pack_title}: {r.status_code} {r.text}")
 
-        return urls
+        return stickers_ok, stickers_total, urls
 
     @staticmethod
     def start(
@@ -161,6 +165,6 @@ class UploadViber(UploadBase):
         opt_cred: CredOption,
         cb: CallbackProtocol,
         cb_return: CallbackReturn,
-    ) -> List[str]:
+    ) -> Tuple[int, int, List[str]]:
         exporter = UploadViber(opt_output, opt_comp, opt_cred, cb, cb_return)
         return exporter.upload_stickers_viber()