epub2text 0.2.3__tar.gz → 0.2.4__tar.gz

{epub2text-0.2.3 → epub2text-0.2.4}/.ruff.toml

@@ -1,5 +1,5 @@
 
-target-version = "py39"
+target-version = "py310"
 fix = true
 
 [lint]

{epub2text-0.2.3 → epub2text-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epub2text
-Version: 0.2.3
+Version: 0.2.4
 Summary: A simple tool to extract text from EPUB files.
 Author-email: Holger Nahrstaedt <nahrstaedt@gmail.com>
 License: MIT License
@@ -37,7 +37,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click>=8.0.0

{epub2text-0.2.3 → epub2text-0.2.4}/docs/make.py

@@ -20,7 +20,7 @@ import subprocess
 import sys
 
 
-def main():
+def main() -> int:
     """Run the script."""
     sphinx_build = "sphinx-build"
     build_dir = os.path.join("docs", "build")

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/__init__.py

@@ -136,7 +136,7 @@ def _download_epub(
     except Exception as exc:
         if tmp_path:
             Path(tmp_path).unlink(missing_ok=True)
-        if isinstance(exc, (urllib.error.URLError, socket.timeout)):
+        if isinstance(exc, urllib.error.URLError | socket.timeout):
             if isinstance(exc, socket.timeout) or isinstance(
                 getattr(exc, "reason", None), socket.timeout
             ):
@@ -152,7 +152,7 @@ def epub2txt(
     max_bytes: int = DEFAULT_MAX_DOWNLOAD_BYTES,
     user_agent: str | None = None,
     allowed_schemes: tuple[str, ...] = ("https", "http"),
-) -> Union[str, list[str]]:
+) -> str | list[str]:
     """
     Extract text from EPUB file (compatibility function for old epub2txt API).
 

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.3'
-__version_tuple__ = version_tuple = (0, 2, 3)
+__version__ = version = '0.2.4'
+__version_tuple__ = version_tuple = (0, 2, 4)
 
-__commit_id__ = commit_id = 'g82e1d316b'
+__commit_id__ = commit_id = 'ge900e4fef'

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/bookmarks.py

@@ -7,7 +7,7 @@ import tempfile
 from dataclasses import asdict, dataclass
 from datetime import datetime, timezone
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any, cast
 
 logger = logging.getLogger(__name__)
 
@@ -54,7 +54,7 @@ class Bookmark:
 class BookmarkManager:
     """Manages bookmarks for EPUB files."""
 
-    def __init__(self, bookmark_file: Optional[Path] = None) -> None:
+    def __init__(self, bookmark_file: Path | None = None) -> None:
         """
         Initialize bookmark manager.
 
@@ -119,11 +119,15 @@ class BookmarkManager:
         """Return the path for the bookmark backup file."""
         return self.bookmark_file.with_suffix(self.bookmark_file.suffix + ".bak")
 
-    def _read_bookmarks_file(self, path: Path) -> Optional[dict[str, Any]]:
+    def _read_bookmarks_file(self, path: Path) -> dict[str, Any] | None:
         """Read bookmarks JSON from disk."""
         try:
             with open(path, encoding="utf-8") as f:
-                return json.load(f)
+                data = json.load(f)
+            if isinstance(data, dict):
+                return cast(dict[str, Any], data)
+            logger.warning("Unexpected bookmark data structure in %s", path)
+            return None
         except (json.JSONDecodeError, OSError) as exc:
             logger.warning("Failed to load bookmarks from %s: %s", path, exc)
             return None
@@ -144,7 +148,7 @@ class BookmarkManager:
         self._bookmarks[key] = asdict(bookmark)
         self._save()
 
-    def load(self, epub_path: str) -> Optional[Bookmark]:
+    def load(self, epub_path: str) -> Bookmark | None:
         """
         Load bookmark for a specific EPUB file.
 

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/cleaner.py

@@ -96,7 +96,7 @@ class TextCleaner:
         markers = {}
         marker_count = [0]
 
-        def save_marker(match):
+        def save_marker(match: re.Match[str]) -> str:
             placeholder = f"___MARKER_{marker_count[0]}___"
             markers[placeholder] = match.group(0)
             marker_count[0] += 1
@@ -196,7 +196,7 @@ class TextCleaner:
         abbrev_map = {}
         abbrev_counter = [0]
 
-        def protect_abbrev(match):
+        def protect_abbrev(match: re.Match[str]) -> str:
             placeholder = f"__ABBREV_{abbrev_counter[0]}__"
             abbrev_map[placeholder] = match.group(0)
             abbrev_counter[0] += 1

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/cli.py

@@ -7,7 +7,6 @@ import sys
 from collections.abc import Iterator
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Optional
 
 import click
 from rich.console import Console
@@ -46,7 +45,7 @@ def spinner(task_description: str) -> Iterator[None]:
         yield
 
 
-def parse_range_tokens(range_str: str) -> list[tuple[str, Optional[str]]]:
+def parse_range_tokens(range_str: str) -> list[tuple[str, str | None]]:
     """
     Parse a range string into ordered tokens.
 
@@ -59,7 +58,7 @@ def parse_range_tokens(range_str: str) -> list[tuple[str, Optional[str]]]:
     if not range_str:
         raise ValueError("Range string cannot be empty")
 
-    tokens: list[tuple[str, Optional[str]]] = []
+    tokens: list[tuple[str, str | None]] = []
     parts = range_str.split(",")
 
     for part in parts:
@@ -205,7 +204,7 @@ def parse_page_range(range_str: str, pages: list[Page]) -> list[str]:
     result: list[str] = []
     seen: set[str] = set()
 
-    def parse_int(value: str) -> Optional[int]:
+    def parse_int(value: str) -> int | None:
         try:
             return int(value)
         except ValueError:
@@ -590,8 +589,8 @@ def list_pages(filepath: Path, page_size: int, use_words: bool) -> None:
 )
 def extract_pages_cmd(
     filepath: Path,
-    output: Optional[Path],
-    pages: Optional[str],
+    output: Path | None,
+    pages: str | None,
     page_size: int,
     use_words: bool,
     raw: bool,
@@ -786,13 +785,13 @@ def extract_pages_cmd(
 )
 def extract(
     filepath: Path,
-    output: Optional[Path],
-    chapters: Optional[str],
+    output: Path | None,
+    chapters: str | None,
     interactive: bool,
     paragraphs: bool,
     sentences: bool,
     comma: bool,
-    max_length: Optional[int],
+    max_length: int | None,
     empty_lines: bool,
     separator: str,
     raw: bool,
@@ -801,7 +800,7 @@ def extract(
     no_markers: bool,
     language_model: str,
     offset: int,
-    limit: Optional[int],
+    limit: int | None,
     line_numbers: bool,
 ) -> None:
     """
@@ -1012,8 +1011,8 @@ def extract(
 )
 def extract_gutenberg(
     filepath: Path,
-    output: Optional[Path],
-    chapters: Optional[str],
+    output: Path | None,
+    chapters: str | None,
     interactive: bool,
 ) -> None:
     """
@@ -1124,9 +1123,9 @@ def extract_gutenberg(
             # First, normalize the chapter text to help with splitting
             chapter_lines = chapter_text.split("\n")
 
-            current_title = None
-            current_content = []
-            chapters_list = []
+            current_title: str | None = None
+            current_content: list[str] = []
+            chapters_list: list[tuple[str, str]] = []
 
             i = 0
             while i < len(chapter_lines):
@@ -1418,11 +1417,11 @@ def info(filepath: Path, format: str) -> None:
 )
 def read(
     filepath: Path,
-    chapter: Optional[int],
-    line: Optional[int],
+    chapter: int | None,
+    line: int | None,
     resume: bool,
-    bookmark_file: Optional[Path],
-    page_size: Optional[int],
+    bookmark_file: Path | None,
+    page_size: int | None,
     no_header: bool,
     no_footer: bool,
     sentences: bool,
@@ -1432,7 +1431,7 @@ def read(
     raw: bool,
     keep_footnotes: bool,
     keep_page_numbers: bool,
-    width: Optional[int],
+    width: int | None,
 ) -> None:
     """
     Interactively read an EPUB file in the terminal.

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/models.py

@@ -2,7 +2,6 @@
 
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Optional
 
 
 class PageSource(Enum):
@@ -25,8 +24,8 @@ class Page:
     text: str
     char_count: int
     source: PageSource
-    chapter_id: Optional[str] = None  # Which chapter this page belongs to
-    chapter_title: Optional[str] = None  # Title of the chapter
+    chapter_id: str | None = None  # Which chapter this page belongs to
+    chapter_title: str | None = None  # Title of the chapter
 
     def __str__(self) -> str:
         source_str = "print" if self.source == PageSource.EPUB_PAGE_LIST else "syn"
@@ -41,7 +40,7 @@ class Chapter:
     title: str
     text: str
     char_count: int
-    parent_id: Optional[str] = None
+    parent_id: str | None = None
     level: int = 0
 
     def __str__(self) -> str:
@@ -52,18 +51,18 @@ class Chapter:
 class Metadata:
     """EPUB metadata."""
 
-    title: Optional[str] = None
+    title: str | None = None
     authors: list[str] = field(default_factory=list)
-    publisher: Optional[str] = None
-    publication_year: Optional[str] = None
-    description: Optional[str] = None
+    publisher: str | None = None
+    publication_year: str | None = None
+    description: str | None = None
     # Required EPUB3 metadata
-    identifier: Optional[str] = None
-    language: Optional[str] = None
+    identifier: str | None = None
+    language: str | None = None
     # Optional Dublin Core metadata
     contributors: list[str] = field(default_factory=list)
-    rights: Optional[str] = None
-    coverage: Optional[str] = None
+    rights: str | None = None
+    coverage: str | None = None
 
     def __str__(self) -> str:
         lines = []

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/parser.py

@@ -7,7 +7,7 @@ import logging
 import re
 import urllib.parse
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any
 
 import ebooklib  # type: ignore[import-untyped]
 from bs4 import BeautifulSoup, NavigableString  # type: ignore[import-untyped]
@@ -54,11 +54,11 @@ class EPUBParser:
         self.content_texts: dict[str, str] = {}
         self.content_lengths: dict[str, int] = {}
         self.processed_nav_structure: list[dict[str, Any]] = []
-        self._metadata: Optional[Metadata] = None
-        self._page_list_nav: Optional[tuple[Any, str]] = None
+        self._metadata: Metadata | None = None
+        self._page_list_nav: tuple[Any, str] | None = None
         self._page_list_nav_checked = False
         self._nav_processed = False
-        self._upper_title_cache: Optional[set[str]] = None
+        self._upper_title_cache: set[str] | None = None
 
         self._load_epub()
 
@@ -84,7 +84,7 @@ class EPUBParser:
         except Exception as e:
             raise ValueError(f"Failed to read EPUB file: {e}") from e
 
-    def _get_single_metadata(self, field: str) -> Optional[str]:
+    def _get_single_metadata(self, field: str) -> str | None:
         """Extract a single metadata value from Dublin Core field."""
         try:
             items = self.book.get_metadata("DC", field)
@@ -163,7 +163,7 @@ class EPUBParser:
         self,
         nav_structure: list[dict[str, Any]],
         chapters: list[Chapter],
-        parent_id: Optional[str] = None,
+        parent_id: str | None = None,
         level: int = 1,
         include_text: bool = True,
     ) -> None:
@@ -178,7 +178,7 @@ class EPUBParser:
             include_text: If True, include full text; if False, only metadata
         """
         for entry in nav_structure:
-            src: Optional[str] = entry.get("src")
+            src: str | None = entry.get("src")
             title: str = entry.get("title", "Untitled")
             children: list[dict[str, Any]] = entry.get("children", [])
 
@@ -438,12 +438,12 @@ class EPUBParser:
 
                 # Handle ordered lists
                 for ol in slice_soup.find_all("ol"):
-                    start_attr = ol.get("start")  # type: ignore[union-attr]
-                    start_num = int(start_attr) if start_attr else 1  # type: ignore[arg-type]
+                    start_attr = ol.get("start")
+                    start_num = int(start_attr) if start_attr else 1
                     for li_idx, li in enumerate(ol.find_all("li", recursive=False)):
                         number_text = f"{start_num + li_idx}) "
                         if li.string:
-                            li.string.replace_with(number_text + str(li.string))  # type: ignore[union-attr]
+                            li.string.replace_with(number_text + str(li.string))
                         else:
                             li.insert(0, NavigableString(number_text))
 
@@ -510,7 +510,7 @@ class EPUBParser:
         base_href: str,
         doc_order: dict[str, int],
         doc_order_decoded: dict[str, int],
-    ) -> tuple[Optional[str], Optional[int]]:
+    ) -> tuple[str | None, int | None]:
         """Find the best matching doc_key for a given base_href."""
         import os
 
@@ -606,7 +606,7 @@ class EPUBParser:
         link = li_element.find("a", recursive=False)
         span_text = li_element.find("span", recursive=False)
         title = "Untitled Section"
-        src: Optional[str] = None
+        src: str | None = None
         current_entry_node: dict[str, Any] = {"children": []}
 
         if link and "href" in link.attrs:
@@ -673,7 +673,7 @@ class EPUBParser:
                 )
         tree_structure_list.append(current_entry_node)
 
-    def _find_position_robust(self, doc_href: str, fragment_id: Optional[str]) -> int:
+    def _find_position_robust(self, doc_href: str, fragment_id: str | None) -> int:
         """
         Find the position of a fragment ID within a document.
 
@@ -835,7 +835,7 @@ class EPUBParser:
 
     def extract_chapters(
         self,
-        chapter_ids: Optional[list[str]] = None,
+        chapter_ids: list[str] | None = None,
         deduplicate_chapter_titles: bool = True,
         skip_toc: bool = False,
         include_chapter_title: bool = False,
@@ -881,7 +881,7 @@ class EPUBParser:
             selected = filtered
 
         # Combine text with chapter titles
-        parts = []
+        parts: list[str] = []
         for i, chapter in enumerate(selected):
             if chapter.text:
                 # Remove duplicate title if requested
@@ -944,7 +944,7 @@ class EPUBParser:
         """
         return bool(self._find_page_list_nav())
 
-    def _find_page_list_nav(self) -> Optional[tuple[Any, str]]:
+    def _find_page_list_nav(self) -> tuple[Any, str] | None:
         """
         Find the page-list navigation element in the EPUB.
 
@@ -1155,8 +1155,8 @@ class EPUBParser:
         page_num = 1
         current_sentences: list[str] = []
         current_size = 0  # Current size in chars or words
-        current_chapter_id: Optional[str] = None
-        current_chapter_title: Optional[str] = None
+        current_chapter_id: str | None = None
+        current_chapter_title: str | None = None
 
         def get_size(text: str) -> int:
             """Get size of text in chars or words."""
@@ -1362,15 +1362,15 @@ class EPUBParser:
         doc_href: str,
         position: int,
         chapter_map: list[tuple[str, int, str, str]],
-    ) -> tuple[Optional[str], Optional[str]]:
+    ) -> tuple[str | None, str | None]:
         """
         Find which chapter a given position belongs to.
 
         Returns:
             Tuple of (chapter_id, chapter_title) or (None, None)
         """
-        result_id: Optional[str] = None
-        result_title: Optional[str] = None
+        result_id: str | None = None
+        result_title: str | None = None
 
         for ch_doc, ch_pos, ch_id, ch_title in chapter_map:
             if ch_doc == doc_href and ch_pos <= position:
@@ -1381,7 +1381,7 @@ class EPUBParser:
 
         return result_id, result_title
 
-    def _get_spine_index(self, doc_href: str, spine_docs: list[str]) -> Optional[int]:
+    def _get_spine_index(self, doc_href: str, spine_docs: list[str]) -> int | None:
         """Get the index of a document in the spine, logging if missing."""
         try:
             return spine_docs.index(doc_href)
@@ -1393,8 +1393,8 @@ class EPUBParser:
         self,
         current_doc: str,
         current_pos: int,
-        next_doc: Optional[str],
-        next_pos: Optional[int],
+        next_doc: str | None,
+        next_pos: int | None,
         spine_docs: list[str],
         *,
         allow_wraparound: bool,
@@ -1439,7 +1439,7 @@ class EPUBParser:
     def _extract_text_between_positions(
         self,
         current: dict[str, Any],
-        next_entry: Optional[dict[str, Any]],
+        next_entry: dict[str, Any] | None,
         spine_docs: list[str],
     ) -> str:
         """
@@ -1488,7 +1488,7 @@ class EPUBParser:
 
     def extract_pages(
         self,
-        page_numbers: Optional[list[str]] = None,
+        page_numbers: list[str] | None = None,
         deduplicate_chapter_titles: bool = True,
         skip_toc: bool = False,
     ) -> str:
@@ -1518,8 +1518,8 @@ class EPUBParser:
         # Note: We don't filter out entire pages here anymore
         # Instead, we strip TOC content from pages below
 
-        parts = []
-        current_chapter: Optional[str] = None
+        parts: list[str] = []
+        current_chapter: str | None = None
 
         for page in selected:
             if not page.text:

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text/reader.py

@@ -3,7 +3,6 @@
 import signal
 import sys
 from dataclasses import dataclass
-from typing import Optional
 
 import click
 from rich.align import Align
@@ -71,13 +70,13 @@ class EpubReader:
         chapters: list[Chapter],
         title: str,
         epub_path: str,
-        page_size: Optional[int] = None,
+        page_size: int | None = None,
         show_header: bool = True,
         show_footer: bool = True,
         start_line: int = 0,
-        start_chapter: Optional[int] = None,
-        bookmark_manager: Optional[BookmarkManager] = None,
-        width: Optional[int] = None,
+        start_chapter: int | None = None,
+        bookmark_manager: BookmarkManager | None = None,
+        width: int | None = None,
     ) -> None:
         """
         Initialize the EPUB reader.
@@ -120,7 +119,7 @@ class EpubReader:
 
         # State
         self._show_help = False
-        self._message: Optional[str] = None
+        self._message: str | None = None
         self._message_style: str = "green"
         self._running = False
 
@@ -402,7 +401,7 @@ class EpubReader:
 
         return True
 
-    def _get_effective_width(self) -> Optional[int]:
+    def _get_effective_width(self) -> int | None:
         """Get effective content width, capped by terminal width."""
         if self._width is None:
             return None

{epub2text-0.2.3 → epub2text-0.2.4}/epub2text.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epub2text
-Version: 0.2.3
+Version: 0.2.4
 Summary: A simple tool to extract text from EPUB files.
 Author-email: Holger Nahrstaedt <nahrstaedt@gmail.com>
 License: MIT License
@@ -37,7 +37,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click>=8.0.0

{epub2text-0.2.3 → epub2text-0.2.4}/examples/demo.py

@@ -16,9 +16,8 @@ Run with: python -m examples.demo
 import tempfile
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
 
-import pypub  # type: ignore[import-untyped]
+import pypub
 
 from epub2text import (
     Bookmark,
@@ -43,7 +42,7 @@ from epub2text.formatters import (
 # =============================================================================
 
 
-def create_sample_epub(output_path: Optional[Path] = None) -> Path:
+def create_sample_epub(output_path: Path | None = None) -> Path:
     """
     Create a sample EPUB file for demonstration purposes.
 

{epub2text-0.2.3 → epub2text-0.2.4}/pyproject.toml

@@ -10,7 +10,7 @@ include = ["epub2text*"]
 name = "epub2text"
 description = "A simple tool to extract text from EPUB files."
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 license = {file = "LICENSE"}
 authors = [
     {name = "Holger Nahrstaedt", email = "nahrstaedt@gmail.com"}
@@ -67,7 +67,7 @@ commands =
 """
 
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.10"
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = true
@@ -80,8 +80,21 @@ warn_no_return = true
 warn_unreachable = true
 strict_equality = true
 exclude = [
+    "^build/",
+    "^epub2text\\.egg-info/",
 ]
 
+[[tool.mypy.overrides]]
+module = [
+    "defusedxml",
+    "defusedxml.*",
+    "phrasplit",
+    "pypub",
+    "pypub.*",
+    "setuptools",
+]
+ignore_missing_imports = true
+
 [tool.git-cliff.changelog]
 # A Tera template to be rendered as the changelog's header.
 # See https://keats.github.io/tera/docs/#introduction

{epub2text-0.2.3 → epub2text-0.2.4}/tests/test_epub_download.py

@@ -11,7 +11,7 @@ from functools import partial
 from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer
 from pathlib import Path
 
-import pypub  # type: ignore[import-untyped]
+import pypub
 import pytest
 
 from epub2text import epub2txt
@@ -42,7 +42,8 @@ def serve_directory(
     thread.start()
     try:
         host, port = server.server_address[:2]
-        yield f"http://{host}:{port}"
+        host_value = host.decode() if isinstance(host, bytes) else host
+        yield f"http://{host_value}:{port}"
     finally:
         # Stop the loop, then close the listening socket to avoid FD/memory growth
         with contextlib.suppress(Exception):
@@ -68,6 +69,7 @@ def test_epub2txt_downloads_from_url(tmp_path: Path) -> None:
 
     with serve_directory(tmp_path) as base_url:
         text = epub2txt(f"{base_url}/{epub_path.name}")
+        assert isinstance(text, str)
 
     assert "downloadable epub" in text.lower()
 

{epub2text-0.2.3 → epub2text-0.2.4}/tests/test_epub_generation.py

@@ -9,7 +9,7 @@ from datetime import datetime
 from pathlib import Path
 from typing import cast
 
-import pypub  # type: ignore[import-untyped]
+import pypub
 import pytest
 
 from epub2text import EPUBParser, epub2txt

{epub2text-0.2.3 → epub2text-0.2.4}/tests/test_page_extraction_improvements.py

@@ -9,7 +9,7 @@ Tests the new features:
 
 from pathlib import Path
 
-import pypub  # type: ignore[import-untyped]
+import pypub
 import pytest
 
 from epub2text import EPUBParser

{epub2text-0.2.3 → epub2text-0.2.4}/tests/test_title_deduplication.py

@@ -7,7 +7,7 @@ parameter in extract_chapters().
 
 from pathlib import Path
 
-import pypub  # type: ignore[import-untyped]
+import pypub
 import pytest
 
 from epub2text import EPUBParser