[fpdf2] Update to 2.8.3 (#13871)

Author: srittau

stubs/fpdf2/METADATA.toml

@@ -1,4 +1,4 @@
-version = "2.8.2"
+version = "2.8.3"
 upstream_repository = "https://github.com/PyFPDF/fpdf2"
 requires = ["Pillow>=10.3.0"]
 

stubs/fpdf2/fpdf/_fonttools_shims.pyi

@@ -2,7 +2,7 @@
 from abc import ABCMeta, abstractmethod
 from collections.abc import Mapping
 from logging import Logger
-from typing import Protocol
+from typing import Any, Protocol
 from typing_extensions import TypeAlias
 
 # from fonttools.ttLib.ttGlyphSet
@@ -13,6 +13,9 @@ class _TTGlyph(Protocol):
 
 _TTGlyphSet: TypeAlias = Mapping[str, _TTGlyph]  # Simplified for our needs
 
+# fonttools.ttLib.TTFont
+_TTFont: TypeAlias = Any  # noqa: Y047
+
 # from fontTools.misc.loggingTools
 
 class LogMixin:

stubs/fpdf2/fpdf/enums.pyi

@@ -56,6 +56,7 @@ class TextEmphasis(CoerciveIntFlag):
     B = 1
     I = 2
     U = 4
+    S = 8
 
     @property
     def style(self) -> str: ...
@@ -296,6 +297,11 @@ class TextDirection(CoerciveEnum):
     TTB = "TTB"
     BTT = "BTT"
 
+class OutputIntentSubType(CoerciveEnum):
+    PDFX = "GTS_PDFX"
+    PDFA = "GTS_PDFA1"
+    ISOPDF = "ISO_PDFE1"
+
 class PageLabelStyle(CoerciveEnum):
     NUMBER = "D"
     UPPER_ROMAN = "R"
@@ -322,3 +328,13 @@ class PageOrientation(CoerciveEnum):
 
     @classmethod
     def coerce(cls, value: Self | str) -> Self: ...  # type: ignore[override]
+
+class PDFResourceType(Enum):
+    EXT_G_STATE = "ExtGState"
+    COLOR_SPACE = "ColorSpace"
+    PATTERN = "Pattern"
+    SHADDING = "Shading"
+    X_OBJECT = "XObject"
+    FONT = "Font"
+    PROC_SET = "ProcSet"
+    PROPERTIES = "Properties"

stubs/fpdf2/fpdf/fonts.pyi

@@ -1,14 +1,19 @@
 import dataclasses
-from _typeshed import Incomplete
+from _typeshed import Incomplete, Unused
+from collections import defaultdict
 from collections.abc import Generator
 from dataclasses import dataclass
+from logging import Logger
 from typing import Final, overload
 from typing_extensions import Self, deprecated
 
+from ._fonttools_shims import _TTFont
 from .drawing import DeviceGray, DeviceRGB, Number
 from .enums import Align, TextEmphasis
 from .syntax import PDFObject
 
+LOGGER: Logger
+
 # Only defined if harfbuzz is installed.
 class HarfBuzzFont(Incomplete):  # derives from uharfbuzz.Font
     def __deepcopy__(self, _memo: object) -> Self: ...
@@ -73,37 +78,48 @@ class TitleStyle(TextStyle): ...
 
 __pdoc__: Final[dict[str, bool]]
 
-class _FontMixin:
+class CoreFont:
     i: int
     type: str
     name: str
     up: int
     ut: int
+    sp: int
+    ss: int
     cw: int
     fontkey: str
     emphasis: TextEmphasis
-    def encode_text(self, text: str): ...
-
-class CoreFont(_FontMixin):
     def __init__(self, fpdf, fontkey: str, style: int) -> None: ...
-    def get_text_width(self, text: str, font_size_pt: int, _): ...
+    def get_text_width(self, text: str, font_size_pt: int, _: Unused) -> float: ...
+    def encode_text(self, text: str) -> str: ...
 
-class TTFFont(_FontMixin):
+class TTFFont:
+    i: int
+    type: str
     ttffile: Incomplete
-    ttfont: Incomplete
-    scale: Incomplete
-    desc: Incomplete
+    fontkey: str
+    ttfont: _TTFont
+    scale: float
+    desc: PDFFontDescriptor
+    cw: defaultdict[str, int]
     cmap: Incomplete
-    glyph_ids: Incomplete
-    missing_glyphs: Incomplete
-    subset: Incomplete
+    glyph_ids: dict[Incomplete, Incomplete]
+    missing_glyphs: list[Incomplete]
+    name: str
+    up: int
+    ut: int
+    sp: int
+    ss: int
+    emphasis: TextEmphasis
+    subset: SubsetMap
     hbfont: HarfBuzzFont | None  # Not always defined.
     def __init__(self, fpdf, font_file_path, fontkey: str, style: int) -> None: ...
     def close(self) -> None: ...
-    def get_text_width(self, text: str, font_size_pt: int, text_shaping_parms): ...
-    def shaped_text_width(self, text: str, font_size_pt: int, text_shaping_parms): ...
-    def perform_harfbuzz_shaping(self, text: str, font_size_pt: int, text_shaping_parms): ...
-    def shape_text(self, text: str, font_size_pt: int, text_shaping_parms): ...
+    def get_text_width(self, text: str, font_size_pt: int, text_shaping_params): ...
+    def shaped_text_width(self, text: str, font_size_pt: int, text_shaping_params): ...
+    def perform_harfbuzz_shaping(self, text: str, font_size_pt: int, text_shaping_params): ...
+    def encode_text(self, text: str) -> str: ...
+    def shape_text(self, text: str, font_size_pt: int, text_shaping_params): ...
 
 class PDFFontDescriptor(PDFObject):
     type: Incomplete
@@ -128,7 +144,7 @@ class Glyph:
 
 class SubsetMap:
     font: TTFFont
-    def __init__(self, font: TTFFont, identities: list[int]) -> None: ...
+    def __init__(self, font: TTFFont) -> None: ...
     def __len__(self) -> int: ...
     def items(self) -> Generator[Incomplete, None, None]: ...
     def pick(self, unicode: int): ...

stubs/fpdf2/fpdf/fpdf.pyi

@@ -23,6 +23,7 @@ from .enums import (
     EncryptionMethod,
     FileAttachmentAnnotationName,
     MethodReturnValue,
+    OutputIntentSubType,
     PageLabelStyle,
     PageLayout,
     PageMode,
@@ -53,7 +54,7 @@ from .image_datastructures import (
     VectorImageInfo as VectorImageInfo,
     _TextAlign,
 )
-from .output import OutputProducer, PDFPage
+from .output import OutputProducer, PDFICCProfile, PDFPage
 from .recorder import FPDFRecorder
 from .structure_tree import StructureTreeBuilder
 from .syntax import DestinationXYZ
@@ -77,7 +78,35 @@ __all__ = [
 _Orientation: TypeAlias = Literal["", "portrait", "p", "P", "landscape", "l", "L"]
 _Format: TypeAlias = Literal["", "a3", "A3", "a4", "A4", "a5", "A5", "letter", "Letter", "legal", "Legal"]
 _FontStyle: TypeAlias = Literal["", "B", "I", "BI"]
-_FontStyles: TypeAlias = Literal["", "B", "I", "U", "BU", "UB", "BI", "IB", "IU", "UI", "BIU", "BUI", "IBU", "IUB", "UBI", "UIB"]
+_FontStyles: TypeAlias = Literal[
+    "",
+    "B",
+    "I",
+    "U",
+    "S",
+    "BU",
+    "UB",
+    "BI",
+    "IB",
+    "IU",
+    "UI",
+    "BS",
+    "SB",
+    "IS",
+    "SI",
+    "BIU",
+    "BUI",
+    "IBU",
+    "IUB",
+    "UBI",
+    "UIB",
+    "BIS",
+    "BSI",
+    "IBS",
+    "ISB",
+    "SBI",
+    "SIB",
+]
 
 FPDF_VERSION: Final[str]
 PAGE_FORMATS: dict[_Format, tuple[float, float]]
@@ -88,12 +117,14 @@ class ToCPlaceholder(NamedTuple):
     y: int
     page_orientation: str
     pages: int = 1
+    reset_page_indices: bool = True
 
 def get_page_format(format: _Format | tuple[float, float], k: float | None = None) -> tuple[float, float]: ...
 
 class FPDF(GraphicsStateMixin):
     MARKDOWN_BOLD_MARKER: ClassVar[str]
     MARKDOWN_ITALICS_MARKER: ClassVar[str]
+    MARKDOWN_STRIKETHROUGH_MARKER: ClassVar[str]
     MARKDOWN_UNDERLINE_MARKER: ClassVar[str]
     MARKDOWN_ESCAPE_CHARACTER: ClassVar[str]
     MARKDOWN_LINK_REGEX: ClassVar[Pattern[str]]
@@ -145,7 +176,6 @@ class FPDF(GraphicsStateMixin):
     compress: bool
     pdf_version: str
     creation_date: datetime.datetime
-    graphics_style_names_per_page_number: dict[int, set[str]]
 
     buffer: bytearray | None
 
@@ -179,6 +209,19 @@ class FPDF(GraphicsStateMixin):
     def is_ttf_font(self) -> bool: ...
     @property
     def page_mode(self) -> PageMode: ...
+    @page_mode.setter
+    def page_mode(self, page_mode: PageMode) -> None: ...
+    @property
+    def output_intents(self): ...
+    def add_output_intent(
+        self,
+        subtype: OutputIntentSubType,
+        output_condition_identifier: str | None = None,
+        output_condition: str | None = None,
+        registry_name: str | None = None,
+        dest_output_profile: PDFICCProfile | None = None,
+        info: str | None = None,
+    ) -> None: ...
     @property
     def epw(self) -> float: ...
     @property
@@ -336,14 +379,15 @@ class FPDF(GraphicsStateMixin):
         closed: bool = False,
         style: RenderStyle | Literal["D", "F", "DF", "FD"] | None = None,
     ) -> None: ...
+    def use_pattern(self, shading) -> _GeneratorContextManager[None]: ...
     def add_font(
         self,
         family: str | None = None,
         style: _FontStyle = "",
         fname: str | PurePath | None = None,
         uni: bool | Literal["DEPRECATED"] = "DEPRECATED",
     ) -> None: ...
-    def set_font(self, family: str | None = None, style: _FontStyles = "", size: int = 0) -> None: ...
+    def set_font(self, family: str | None = None, style: _FontStyles | TextEmphasis = "", size: int = 0) -> None: ...
     def set_font_size(self, size: float) -> None: ...
     def set_char_spacing(self, spacing: float) -> None: ...
     def set_stretching(self, stretching: float) -> None: ...
@@ -618,7 +662,11 @@ class FPDF(GraphicsStateMixin):
     def unbreakable(self) -> _GeneratorContextManager[FPDFRecorder]: ...
     def offset_rendering(self) -> _GeneratorContextManager[FPDFRecorder]: ...
     def insert_toc_placeholder(
-        self, render_toc_function: Callable[[FPDF, list[OutlineSection]], object], pages: int = 1, allow_extra_pages: bool = False
+        self,
+        render_toc_function: Callable[[FPDF, list[OutlineSection]], object],
+        pages: int = 1,
+        allow_extra_pages: bool = False,
+        reset_page_indices: bool = True,
     ) -> None: ...
     def set_section_title_styles(
         self,

stubs/fpdf2/fpdf/graphics_state.pyi

@@ -1,4 +1,4 @@
-from typing import Any, ClassVar, Literal, TypedDict, type_check_only
+from typing import Any, ClassVar, Final, Literal, TypedDict, type_check_only
 
 from .drawing import DeviceGray, DeviceRGB
 from .enums import TextMode
@@ -36,6 +36,10 @@ class GraphicsStateMixin:
     @underline.setter
     def underline(self, v: bool) -> None: ...
     @property
+    def strikethrough(self) -> bool: ...
+    @strikethrough.setter
+    def strikethrough(self, v: bool) -> None: ...
+    @property
     def font_style(self) -> str: ...
     @font_style.setter
     def font_style(self, v: str) -> None: ...
@@ -64,6 +68,10 @@ class GraphicsStateMixin:
     @current_font.setter
     def current_font(self, v: dict[str, Any]) -> None: ...
     @property
+    def current_font_is_set_on_page(self) -> bool: ...
+    @current_font_is_set_on_page.setter
+    def current_font_is_set_on_page(self, v: bool) -> None: ...
+    @property
     def dash_pattern(self) -> dict[str, float]: ...
     @dash_pattern.setter
     def dash_pattern(self, v: dict[str, float]) -> None: ...
@@ -116,3 +124,5 @@ class GraphicsStateMixin:
     @text_shaping.setter
     def text_shaping(self, v: _TextShaping | None) -> None: ...
     def font_face(self) -> FontFace: ...
+
+__pdoc__: Final[dict[str, bool]]

stubs/fpdf2/fpdf/line_break.pyi

@@ -43,7 +43,9 @@ class Fragment:
     @property
     def text_mode(self): ...
     @property
-    def underline(self): ...
+    def underline(self) -> bool: ...
+    @property
+    def strikethrough(self) -> bool: ...
     @property
     def draw_color(self): ...
     @property
@@ -90,6 +92,7 @@ class TextLine(NamedTuple):
     max_width: float
     trailing_nl: bool = False
     trailing_form_feed: bool = False
+    indent: float = 0
     def get_ordered_fragments(self) -> tuple[Fragment, ...]: ...
 
 class SpaceHint(NamedTuple):
@@ -114,13 +117,14 @@ class HyphenHint(NamedTuple):
 
 class CurrentLine:
     max_width: float
-    print_sh: Incomplete
+    print_sh: bool
+    indent: float
     fragments: list[Fragment]
     height: int
     number_of_spaces: int
     space_break_hint: Incomplete
     hyphen_break_hint: Incomplete
-    def __init__(self, max_width: float, print_sh: bool = False) -> None: ...
+    def __init__(self, max_width: float, print_sh: bool = False, indent: float = 0) -> None: ...
     @property
     def width(self) -> float: ...
     def add_character(
@@ -150,6 +154,7 @@ class MultiLineBreak:
     fragment_index: int
     character_index: int
     idx_last_forced_break: int | None
+    first_line_indent: float
     def __init__(
         self,
         fragments: Sequence[Fragment],
@@ -160,5 +165,6 @@ class MultiLineBreak:
         wrapmode: WrapMode = ...,
         line_height: float = 1.0,
         skip_leading_spaces: bool = False,
+        first_line_indent: float = 0,
     ) -> None: ...
     def get_line(self) -> TextLine: ...

stubs/fpdf2/fpdf/outline.pyi

@@ -1,13 +1,14 @@
 from _typeshed import Incomplete
 from collections.abc import Generator, Iterable
-from typing import NamedTuple
+from dataclasses import dataclass
 
 from .fonts import TextStyle
 from .fpdf import FPDF
 from .structure_tree import StructElem
 from .syntax import Destination, PDFObject, PDFString
 
-class OutlineSection(NamedTuple):
+@dataclass
+class OutlineSection:
     name: str
     level: int
     page_number: int