Version 3.0.8

* Corrected file handling behaviours.
* Type hint corrections.

Author: Augus1999

pypdfeditor_core/__init__.py

@@ -15,7 +15,7 @@
 
 __system__ = platform.system()
 __author__ = "Nianze A. TAO (Omozawa SUENO)"
-__version__ = "3.0.7"
+__version__ = "3.0.8"
 __all__ = ["main", "reset", "remove"]
 
 

pypdfeditor_core/application.py

@@ -10,11 +10,11 @@
 import getpass
 import subprocess as sp
 from pathlib import Path
-from typing import Dict
+from typing import List, Dict, Union, Optional
 import pymupdf as fitz
 from PyQt6 import QtCore
 from PyQt6.QtGui import QColor, QPixmap, QCloseEvent
-from PyQt6.QtWidgets import QColorDialog
+from PyQt6.QtWidgets import QColorDialog, QWidget
 from .language import set_language, lag_s, lag_p
 from .windows import (
     MainR,
@@ -158,7 +158,7 @@ def __init__(self, system: str, version: str):
         if not self.settings.value("windowState") == None:
             self.restoreState(self.settings.value("windowState"))
 
-    def closeEvent(self, event: QCloseEvent) -> None:
+    def closeEvent(self, event: Optional[QCloseEvent]) -> None:
         """
         write settings to settings.json
         """
@@ -212,7 +212,12 @@ def enable_perm_set(self) -> None:
             self.tab3.button6.clicked.disconnect()
             self.perm_int = 4028  # value of all permissions
 
-    def view(self, index=None, widget=None, f_name=None) -> None:
+    def view(
+        self,
+        index: Optional[int] = None,
+        widget: Optional[QWidget] = None,
+        f_name: Optional[str] = None,
+    ) -> None:
         """
         open file outside the application
 
@@ -381,7 +386,7 @@ def add1(self) -> None:
         f_name, _ = add(
             self,
             "PDF files (*.pdf);;"
-            "images (*.png *.jpg *.jpeg *.bmp *.tiff *.svg);;"
+            "images (*.png *.jpg *.jpeg *.bmp *.tiff *.svg *.JPG);;"
             "ebooks (*.epub *.xps *.fb2 *.cbz)",
         )
         if _:
@@ -460,7 +465,7 @@ def add4(self) -> None:
             del doc, state
         return
 
-    def get_data(self, par1, par2, par3, par5) -> None:
+    def get_data(self, par1: str, par2: str, par3: bool, par5: str) -> None:
         """
         obtain settings from setting window
         """
@@ -472,7 +477,7 @@ def get_data(self, par1, par2, par3, par5) -> None:
         set_language(self)
         self.setCurrentIndex(i)
 
-    def get_font_dir(self, par) -> None:
+    def get_font_dir(self, par: str) -> None:
         """
         obtain font file directory from font window
         """
@@ -560,7 +565,7 @@ def preview(self) -> None:
             del doc
 
     @staticmethod
-    def show_index(par, widget):
+    def show_index(par: List[int], widget: QWidget):
         """
         show recent clicked page number
         """
@@ -576,7 +581,7 @@ class Setting(SettingR):
 
     signal = QtCore.pyqtSignal(str, str, bool, str)
 
-    def __init__(self, set_dict: dict):
+    def __init__(self, set_dict: Dict[str, Union[str, bool]]):
         super().__init__()
         self.s_dir = set_dict["start dir"]
         self.o_dir = set_dict["save dir"]
@@ -620,7 +625,7 @@ def _enable_select(self):
             self.line1.setReadOnly(False)
             self.line2.setReadOnly(False)
 
-    def closeEvent(self, event: QCloseEvent) -> None:
+    def closeEvent(self, event: Optional[QCloseEvent]) -> None:
         """
         re-write closeEvent
         """
@@ -647,7 +652,7 @@ def set_language(self, language: str) -> None:
         """
         lag_p(self, language)
 
-    def closeEvent(self, event: QCloseEvent) -> None:
+    def closeEvent(self, event: Optional[QCloseEvent]) -> None:
         """
         close event
         """
@@ -723,7 +728,7 @@ def change_text_font(self) -> None:
         fitz.TOOLS.store_shrink(100)  # delete MuPDF cache
         del cover, shape, page, r1, doc
 
-    def closeEvent(self, event: QCloseEvent) -> None:
+    def closeEvent(self, event: Optional[QCloseEvent]) -> None:
         """
         close event
         """

pypdfeditor_core/functions.py

@@ -8,7 +8,7 @@
 import sys
 import json
 import time
-from typing import Union, Optional, Tuple, List
+from typing import Union, Optional, Tuple, List, Dict
 from pathlib import Path
 from pymupdf.mupdf import FzErrorFormat, FzErrorLibrary
 from pymupdf import Document, Page, Pixmap, Rect, Point, Font
@@ -38,7 +38,7 @@ class Doc(Document):
     """
 
     pass_word: Optional[str] = None
-    rotatedPages = {}
+    rotatedPages: Dict[int, int] = {}
 
 
 def copy(doc: Doc) -> Doc:
@@ -76,7 +76,10 @@ def open_pdf(file_name: str, parent: QWidget) -> Tuple[Optional[Doc], bool]:
     except RuntimeError:
         return _open_warning(parent)
     if not doc.is_pdf:
-        if file_name.endswith(SUPPORT_IMG_FORMAT[:-1]):
+        _support_img_format = SUPPORT_IMG_FORMAT[:-1] + tuple(
+            i.upper() for i in SUPPORT_IMG_FORMAT[:-1]
+        )
+        if file_name.endswith(_support_img_format):
             try:  # handle wrong image formats
                 pdf_bites = Pixmap(file_name).tobytes()
                 doc = Doc("png", pdf_bites)
@@ -106,7 +109,7 @@ def open_pdf(file_name: str, parent: QWidget) -> Tuple[Optional[Doc], bool]:
     return doc, True
 
 
-def render_pdf_page(page_data: Doc.load_page) -> QtGui.QPixmap:
+def render_pdf_page(page_data: Page) -> QtGui.QPixmap:
     """
     render PDF page
 
@@ -131,7 +134,7 @@ def render_pdf_page(page_data: Doc.load_page) -> QtGui.QPixmap:
     return pixmap
 
 
-def pdf_split(doc: Doc) -> List:
+def pdf_split(doc: Doc) -> List[int]:
     """
     split the selected PDF file into pages;
 
@@ -190,7 +193,7 @@ def add_watermark(
     return doc
 
 
-def setting_warning(set_file_name: str, parent: QWidget) -> dict:
+def setting_warning(set_file_name: str, parent: QWidget) -> Dict[str, Union[str, bool]]:
     """
     import settings from the JSON file
 
@@ -327,7 +330,7 @@ def set_icon(
     TOOLS.store_shrink(100)  # delete MuPDF cache
 
 
-def add(main: QWidget, _format: str) -> Tuple[str]:
+def add(main: QWidget, _format: str) -> Tuple[str, str]:
     """
     add a file
 
@@ -336,14 +339,15 @@ def add(main: QWidget, _format: str) -> Tuple[str]:
     :return: [f_name, state]
     """
     f_name, state = QFileDialog.getOpenFileName(main, "Open files", main.s_dir, _format)
-    if state and not f_name.endswith(SUPPORT_FORMAT):
+    _support_format = SUPPORT_FORMAT + tuple(i.upper() for i in SUPPORT_FORMAT)
+    if state and not f_name.endswith(_support_format):
         return "", ""
     if state and main.dir_store_state:
         main.s_dir = os.path.dirname(f_name)
     return f_name, state
 
 
-def save(main: QWidget, _format: str) -> Tuple[str]:
+def save(main: QWidget, _format: str) -> Tuple[str, str]:
     """
     save a file
 
@@ -645,7 +649,7 @@ def choose(widget: QtWidgets.QLineEdit, c_dir: str) -> None:
         widget.setText(root)
 
 
-def remove_invalid_xref_key(metadata: dict) -> dict:
+def remove_invalid_xref_key(metadata: Dict[str, str]) -> Dict[str, str]:
     """
     remove invalid xref key(s)
     """
@@ -697,8 +701,8 @@ def set_metadata0(doc: Doc, author: Optional[str]) -> None:
 
 
 def set_metadata1(
-    metadata: dict, title: str, author: str, subject: str, keywords: str
-) -> dict:
+    metadata: Dict[str, str], title: str, author: str, subject: str, keywords: str
+) -> Dict[str, str]:
     """
     set metadata to pdf document
 
@@ -731,7 +735,7 @@ def set_metadata1(
     return metadata
 
 
-def toc2plaintext(toc: List) -> str:
+def toc2plaintext(toc: List[List[Union[str, int]]]) -> str:
     """
     :param toc: table of content <- DOCUMENT.get_toc()
     :return: plaintext
@@ -744,7 +748,7 @@ def toc2plaintext(toc: List) -> str:
     return plaintext
 
 
-def plaintext2toc(plaintext: str) -> List[List]:
+def plaintext2toc(plaintext: str) -> List[List[Union[str, int]]]:
     """
     :param plaintext: plaintext
     :return: table of content -> DOCUMENT.get_toc()
@@ -759,7 +763,7 @@ def plaintext2toc(plaintext: str) -> List[List]:
     return toc
 
 
-def find_font(font_dirs: List) -> Tuple[dict]:
+def find_font(font_dirs: List[str]) -> Tuple[Dict[str, str], Dict[str, str]]:
     """
     find all TrueType font files (.ttf): all their font name and file addresses
     then write their directories to a json file
@@ -785,7 +789,7 @@ def find_font(font_dirs: List) -> Tuple[dict]:
     return name_dict, dir_dict
 
 
-def store_font_path(name_dict: dict, cache_file_name: str) -> None:
+def store_font_path(name_dict: Dict[str, str], cache_file_name: str) -> None:
     """
     store the font file dict
 
@@ -796,7 +800,7 @@ def store_font_path(name_dict: dict, cache_file_name: str) -> None:
         json.dump(name_dict, f, sort_keys=True, indent=4, separators=(",", ": "))
 
 
-def read_from_font_cache(cache_file_name: str) -> Tuple[dict]:
+def read_from_font_cache(cache_file_name: str) -> Tuple[Dict[str, str], Dict[str, str]]:
     """
     read font directories from json file
 

pypdfeditor_core/window_effect.py

@@ -5,6 +5,7 @@
 """
 from ctypes import POINTER, c_int, WinDLL, Structure, byref, cast
 from ctypes.wintypes import RECT, UINT, HWND, MSG
+from PyQt6.QtCore import QRect
 
 
 class PWindowPOS(Structure):
@@ -69,7 +70,7 @@ def add_shadow_effect(self, h_wnd: int) -> None:
         self._extend(h_wnd, byref(margins))
 
     @staticmethod
-    def monitorNCCALCSIZE(_msg: MSG, geometry) -> None:
+    def monitorNCCALCSIZE(_msg: MSG, geometry: QRect) -> None:
         """
         resize the window to fit the screen
 

pypdfeditor_core/windows.py

@@ -4,7 +4,7 @@
 application window forms
 """
 import re
-from typing import Tuple, Union
+from typing import Tuple, Union, Optional
 from PyQt6.sip import voidptr
 from PyQt6.QtGui import (
     QIcon,
@@ -60,7 +60,7 @@ class SwitchBtn(QWidget):
 
     stateChanged = QtCore.pyqtSignal(bool)
 
-    def __init__(self, parent=None):
+    def __init__(self, parent: Optional[QWidget] = None):
         super().__init__(parent)
         self.checked = False
         self.bgColorOff = QColor("#e2e2dd")
@@ -80,10 +80,11 @@ def __init__(self, parent=None):
         self.timer.timeout.connect(self.update_value)
         self.setFont(QFont("calibri", 14))
 
-    def setStyleSheet(self, style_sheet: str) -> None:
+    def setStyleSheet(self, style_sheet: Optional[str]) -> None:
         """
         define set-style-sheet behaviour
         """
+        assert style_sheet is not None
         style_sheet = re.sub(r"\s+", "", style_sheet)
         on_style = str(re.findall(r"SwitchBtn:on{.+?}", style_sheet))
         off_style = str(re.findall(r"SwitchBtn:off{.+?}", style_sheet))
@@ -122,7 +123,7 @@ def update_value(self) -> None:
                 self.timer.stop()
         self.update()
 
-    def mousePressEvent(self, event: QMouseEvent) -> None:
+    def mousePressEvent(self, event: Optional[QMouseEvent]) -> None:
         """
         mousePressEvent
         """
@@ -154,7 +155,7 @@ def isChecked(self) -> bool:
         """
         return self.checked
 
-    def paintEvent(self, event: QPaintEvent) -> None:
+    def paintEvent(self, event: Optional[QPaintEvent]) -> None:
         """
         paintEvent
         """
@@ -251,7 +252,7 @@ class TableWidget(QTableWidget):
 
     Index = QtCore.pyqtSignal(tuple)
 
-    def mousePressEvent(self, event: QMouseEvent) -> None:
+    def mousePressEvent(self, event: Optional[QMouseEvent]) -> None:
         """
         re-write mousePressEvent
         """
@@ -468,7 +469,7 @@ def restoreState(self, state: QtCore.QByteArray) -> None:
         x, y = [int(i) for i in str(state)[2:-1].split(",")]
         self.move(x, y)
 
-    def paintEvent(self, event: QPaintEvent) -> None:
+    def paintEvent(self, event: Optional[QPaintEvent]) -> None:
         """
         re-write paintEvent
         """
@@ -486,7 +487,7 @@ def paintEvent(self, event: QPaintEvent) -> None:
 
     # -------well, why do the following ugly codes exist?-------
     # -------they are used to re-enable the window animations under Windows platform-------
-    def mouseMoveEvent(self, event: QMouseEvent) -> None:
+    def mouseMoveEvent(self, event: Optional[QMouseEvent]) -> None:
         """
         re-write mouseMoveEvent
         move the frameless window
@@ -499,7 +500,7 @@ def mouseMoveEvent(self, event: QMouseEvent) -> None:
                 self.windowEffect.move_window(int(self.winId()))
         return QTabWidget.mouseMoveEvent(self, event)
 
-    def mouseDoubleClickEvent(self, event: QMouseEvent) -> None:
+    def mouseDoubleClickEvent(self, event: Optional[QMouseEvent]) -> None:
         """
         re-write mouseDoubleClickEvent
         """
@@ -566,7 +567,7 @@ def nativeEvent(
 
     # -------here ends the ugly code-------
 
-    def resizeEvent(self, event: QResizeEvent) -> None:
+    def resizeEvent(self, event: Optional[QResizeEvent]) -> None:
         """
         re-write resizeEvent
         """