refactor: update type imports to use collections.abc for Iterable and Callable

Author: thorwhalen

pdfdol/base.py

@@ -1,6 +1,6 @@
 """Base objects for pdfdol"""
 
-from typing import Iterable
+from collections.abc import Iterable
 from dol import Files, wrap_kvs, Pipe, KeyCodecs, add_ipython_key_completions
 from pypdf import PdfReader
 from io import BytesIO

pdfdol/examples/aggregations.py

@@ -34,7 +34,8 @@
 
 from pathlib import Path
 import os
-from typing import Iterable, Union, Callable, Optional
+from typing import Union, Optional
+from collections.abc import Iterable, Callable
 from ..util import concat_pdfs
 import base64
 import imghdr
@@ -63,17 +64,17 @@ def sorted_image_files(
 
 
 def images_to_pdf(
-    images: Union[str, Path, Iterable],
-    egress: Optional[Union[str, Path, Callable]] = None,
+    images: str | Path | Iterable,
+    egress: str | Path | Callable | None = None,
     *,
     sort_dir_files: Callable[[list], list] = sorted_image_files,
     _get_pdf_egress=None,
-    captions: Optional[Iterable[str]] = None,
+    captions: Iterable[str] | None = None,
     # Common layout controls forwarded to mk_image_and_caption_pdf_page
-    image_fraction: Optional[float] = None,
-    horizontal_margin: Optional[float] = None,
-    align: Optional[str] = None,
-    mk_page_kwargs: Optional[dict] = None,
+    image_fraction: float | None = None,
+    horizontal_margin: float | None = None,
+    align: str | None = None,
+    mk_page_kwargs: dict | None = None,
 ):
     """
     Aggregate a folder (or iterable) of images into a single PDF (one image per page).

pdfdol/tools.py

@@ -1,7 +1,8 @@
 """Pdf Tools."""
 
 from functools import partial
-from typing import Literal, Callable, Union
+from typing import Literal, Any
+from collections.abc import Callable
 import os
 import io
 
@@ -81,7 +82,7 @@ def _resolve_src_kind(src: str) -> SrcKind:
         return "text"
 
 
-def _resolve_bytes_egress(egress: Union[None, str, Callable]) -> Callable[[bytes], any]:
+def _resolve_bytes_egress(egress: None | str | Callable) -> Callable[[bytes], any]:
     """
     Return a callable that processes PDF bytes based on the given egress.
 
@@ -167,7 +168,7 @@ def add_css(html_text: str, css=dflt_css) -> str:
 
 def markdown_to_pdf(
     md_src: str,
-    egress: Union[None, str, Callable] = None,
+    egress: None | str | Callable = None,
     *,
     markdown_extensions=dflt_markdown_kwargs,
     **pdfkit_kwargs,
@@ -176,7 +177,7 @@ def markdown_to_pdf(
 
     if isinstance(md_src, str) and os.path.isfile(md_src):
         md_file = md_src
-        with open(md_file, "r", encoding="utf-8") as f:
+        with open(md_file, encoding="utf-8") as f:
             md_src = f.read()
 
     # Convert Markdown to HTML
@@ -194,7 +195,7 @@ def markdown_to_pdf(
 
 def get_pdf(
     src: str,
-    egress: Union[None, str, Callable] = None,
+    egress: None | str | Callable = None,
     *,
     src_kind: SrcKind = None,
     # extra options for pdfkit.from_* functions
@@ -206,7 +207,7 @@ def get_pdf(
     cover_first=False,
     verbose=False,
     **kwargs,
-) -> Union[bytes, any]:
+) -> bytes | Any:
     """
     Convert the given source to a PDF (bytes) and process it using the specified egress.
 

pdfdol/util.py

@@ -1,7 +1,8 @@
 """Utils for pdfdol"""
 
 from pypdf import PdfReader, PdfWriter, PageObject
-from typing import Iterable, Mapping, Union, Callable, Iterable
+from typing import Union
+from collections.abc import Iterable, Mapping, Callable, Iterable
 import io
 import os
 from pathlib import Path
@@ -113,7 +114,8 @@ def remove_empty_pages(
 
 # ---------------------------------------------------------------------------------
 # Sourcing pdfs
-from typing import Mapping, Union, Iterable
+from typing import Union
+from collections.abc import Mapping, Iterable
 import io
 from dol import written_bytes
 
@@ -128,7 +130,7 @@ def _html_bytes_to_pdf_bytes_writer(html_bytes, buffer):
     html_bytes_to_pdf_bytes = written_bytes(_html_bytes_to_pdf_bytes_writer)
 
     def html_to_pdf_w_weasyprint(
-        htmls: Union[Filepath, Iterable[Filepath]],
+        htmls: Filepath | Iterable[Filepath],
         save_filepath="htmls_to_pdf.pdf",
     ):
         """Convert one or several HTML files into a single PDF file."""
@@ -163,7 +165,7 @@ def html_to_pdf_w_weasyprint(
     }
 
     def html_to_pdf_w_pdfkit(
-        html_filepaths: Union[Filepath, Iterable[Filepath]],
+        html_filepaths: Filepath | Iterable[Filepath],
         save_filepath="htmls_to_pdf.pdf",
         *,
         options=DFLT_OPTIONS,
@@ -260,13 +262,13 @@ def concat_pdf_files(pdf_filepaths: Iterable[str], save_filepath=DFLT_SAVE_PDF_N
 
 # TODO: Generalize to allow pdf_source to be a mapping of any keys to pdf bytes (not necessarily filepaths)
 def concat_pdfs(
-    pdf_source: Union[Iterable[bytes], Mapping[str, bytes]],
+    pdf_source: Iterable[bytes] | Mapping[str, bytes],
     save_filepath=False,
     *,
     filter_extensions=False,
-    key_order: Union[Callable, Iterable] = None,
+    key_order: Callable | Iterable = None,
     **kwargs,
-) -> Union[str, bytes]:
+) -> str | bytes:
     """
     Concatenate multiple PDFs and/or images given as a mapping of filepaths to bytes.