Update fpdf2 stubs to 2.6 (#9236)

Author: srittau

stubs/fpdf2/@tests/stubtest_allowlist.txt

@@ -3,4 +3,12 @@ fpdf.FPDF.output
 fpdf.fpdf.FPDF.output
 
 # Unnecessary re-export from codecs
-fpdf.syntax.BOM_UTF16_BE
+fpdf.syntax.BOM_UTF16_BE
+
+# stubtest doesn't recognize ImportError handler
+fpdf.linearization.signer
+fpdf.output.signer
+
+# Argument has default at runtime, but using it raises a TypeError.
+fpdf.FPDF.set_creation_date
+fpdf.fpdf.FPDF.set_creation_date

stubs/fpdf2/METADATA.toml

@@ -1,4 +1,4 @@
-version = "2.5.*"
+version = "2.6.*"
 requires = ["types-Pillow"]
 
 [tool.stubtest]

stubs/fpdf2/fpdf/actions.pyi

@@ -1,30 +1,36 @@
 from _typeshed import Incomplete
-from abc import ABC
+from abc import ABC, abstractmethod
 
 from .syntax import PDFObject
 
 class Action(ABC):
     next: PDFObject | str | None
     def __init__(self, next_action: PDFObject | str | None = ...) -> None: ...
-    def dict_as_string(self, key_values: dict[str, Incomplete] | None = ...) -> str: ...
+    @abstractmethod
+    def serialize(self) -> str: ...
+
+class URIAction(Action):
+    uri: str
+    def __init__(self, uri: str, next_action: PDFObject | str | None = ...) -> None: ...
+    def serialize(self) -> str: ...
 
 class NamedAction(Action):
-    action_name: Incomplete
-    def __init__(self, action_name, next_action: PDFObject | str | None = ...) -> None: ...
-    def dict_as_string(self) -> str: ...  # type: ignore[override]
+    action_name: str
+    def __init__(self, action_name: str, next_action: PDFObject | str | None = ...) -> None: ...
+    def serialize(self) -> str: ...
 
 class GoToAction(Action):
     dest: Incomplete
     def __init__(self, dest, next_action: PDFObject | str | None = ...) -> None: ...
-    def dict_as_string(self) -> str: ...  # type: ignore[override]
+    def serialize(self) -> str: ...
 
 class GoToRemoteAction(Action):
-    file: Incomplete
+    file: str
     dest: Incomplete
-    def __init__(self, file, dest, next_action: PDFObject | str | None = ...) -> None: ...
-    def dict_as_string(self) -> str: ...  # type: ignore[override]
+    def __init__(self, file: str, dest, next_action: PDFObject | str | None = ...) -> None: ...
+    def serialize(self) -> str: ...
 
 class LaunchAction(Action):
-    file: Incomplete
-    def __init__(self, file, next_action: PDFObject | str | None = ...) -> None: ...
-    def dict_as_string(self) -> str: ...  # type: ignore[override]
+    file: str
+    def __init__(self, file: str, next_action: PDFObject | str | None = ...) -> None: ...
+    def serialize(self) -> str: ...

stubs/fpdf2/fpdf/annotations.pyi

@@ -0,0 +1,80 @@
+from _typeshed import Incomplete
+from datetime import datetime
+from typing import NamedTuple
+
+from .actions import Action
+from .enums import AnnotationFlag, AnnotationName, FileAttachmentAnnotationName
+from .syntax import Destination, Name, PDFContentStream, PDFObject
+
+DEFAULT_ANNOT_FLAGS: Incomplete
+
+class AnnotationMixin:
+    type: Name
+    subtype: Name
+    rect: str
+    border: str
+    f_t: Name | None
+    v: Incomplete | None
+    f: int  # AnnotationFlags
+    contents: str | None
+    a: Action | None
+    dest: Destination | None
+    c: str | None
+    t: str | None
+    m: str | None
+    quad_points: str | None
+    p: Incomplete | None
+    name: AnnotationName | FileAttachmentAnnotationName | None
+    ink_list: str | None
+    f_s: str | None
+    def __init__(
+        self,
+        subtype: str,
+        x: int,
+        y: int,
+        width: int,
+        height: int,
+        flags: tuple[AnnotationFlag, ...] = ...,
+        contents: str | None = ...,
+        dest: Destination | None = ...,
+        action: Action | None = ...,
+        color: tuple[int, int, int] | None = ...,
+        modification_time: datetime | None = ...,
+        title: str | None = ...,
+        quad_points: tuple[float, ...] | None = ...,  # multiple of 8 floats
+        border_width: int = ...,
+        name: AnnotationName | FileAttachmentAnnotationName | None = ...,
+        ink_list: tuple[int, ...] = ...,
+        file_spec: str | None = ...,
+        field_type: str | None = ...,
+        value: Incomplete | None = ...,
+    ) -> None: ...
+
+class PDFAnnotation(AnnotationMixin, PDFObject): ...
+
+class AnnotationDict(AnnotationMixin):
+    def serialize(self) -> str: ...
+
+class PDFEmbeddedFile(PDFContentStream):
+    type: Name
+    params: str
+    def __init__(
+        self,
+        basename: str,
+        contents: bytes,
+        desc: str = ...,
+        creation_date: datetime | None = ...,
+        modification_date: datetime | None = ...,
+        compress: bool = ...,
+        checksum: bool = ...,
+    ) -> None: ...
+    def globally_enclosed(self) -> bool: ...
+    def set_globally_enclosed(self, value: bool) -> None: ...
+    def basename(self) -> str: ...
+    def file_spec(self) -> FileSpec: ...
+
+class FileSpec(NamedTuple):
+    embedded_file: PDFEmbeddedFile
+    basename: str
+    desc: str
+    def serialize(self) -> str: ...

stubs/fpdf2/fpdf/drawing.pyi

@@ -30,26 +30,43 @@ class GraphicsStateDictRegistry(OrderedDict[Raw, Name]):
 def number_to_str(number) -> str: ...
 def render_pdf_primitive(primitive) -> Raw: ...
 
-class DeviceRGB:
-    OPERATOR: str
-    def __new__(cls, r, g, b, a: Incomplete | None = ...): ...
+class _DeviceRGBBase(NamedTuple):
+    r: Number
+    g: Number
+    b: Number
+    a: Number | None
+
+class DeviceRGB(_DeviceRGBBase):
+    OPERATOR: ClassVar[str]
+    def __new__(cls: type[Self], r: Number, g: Number, b: Number, a: Number | None = ...) -> Self: ...
     @property
-    def colors(self): ...
-    def pdf_repr(self) -> str: ...
+    def colors(self) -> tuple[Number, Number, Number]: ...
+    def serialize(self) -> str: ...
+
+class _DeviceGrayBase(NamedTuple):
+    g: Number
+    a: Number | None
 
-class DeviceGray:
-    OPERATOR: str
-    def __new__(cls, g, a: Incomplete | None = ...): ...
+class DeviceGray(_DeviceGrayBase):
+    OPERATOR: ClassVar[str]
+    def __new__(cls: type[Self], g: Number, a: Number | None = ...) -> Self: ...
     @property
-    def colors(self): ...
-    def pdf_repr(self) -> str: ...
+    def colors(self) -> tuple[Number]: ...
+    def serialize(self) -> str: ...
+
+class _DeviceCMYKBase(NamedTuple):
+    c: Number
+    m: Number
+    y: Number
+    k: Number
+    a: Number | None
 
-class DeviceCMYK:
-    OPERATOR: str
-    def __new__(cls, c, m, y, k, a: Incomplete | None = ...): ...
+class DeviceCMYK(_DeviceCMYKBase):
+    OPERATOR: ClassVar[str]
+    def __new__(cls: type[Self], c: Number, m: Number, y: Number, k: Number, a: Number | None = ...) -> Self: ...
     @property
-    def colors(self): ...
-    def pdf_repr(self) -> str: ...
+    def colors(self) -> tuple[Number, Number, Number, Number]: ...
+    def serialize(self) -> str: ...
 
 def rgb8(r, g, b, a: Incomplete | None = ...) -> DeviceRGB: ...
 def gray8(g, a: Incomplete | None = ...) -> DeviceGray: ...
@@ -172,7 +189,7 @@ class GraphicsStyle:
     def stroke_dash_phase(self): ...
     @stroke_dash_phase.setter
     def stroke_dash_phase(self, value): ...
-    def to_pdf_dict(self): ...
+    def serialize(self) -> Raw | None: ...
     def resolve_paint_rule(self): ...
 
 class Move(NamedTuple):
@@ -327,6 +344,7 @@ class PaintedPath:
     @contextmanager
     def transform_group(self: Self, transform) -> Iterator[Self]: ...
     def add_path_element(self, item, _copy: bool = ...) -> None: ...
+    def remove_last_path_element(self) -> None: ...
     def rectangle(self: Self, x, y, w, h, rx: int = ..., ry: int = ...) -> Self: ...
     def circle(self: Self, cx, cy, r) -> Self: ...
     def ellipse(self: Self, cx, cy, rx, ry) -> Self: ...
@@ -372,6 +390,7 @@ class GraphicsContext:
     @clipping_path.setter
     def clipping_path(self, new_clipath) -> None: ...
     def add_item(self, item, _copy: bool = ...) -> None: ...
+    def remove_last_item(self) -> None: ...
     def merge(self, other_context) -> None: ...
     def build_render_list(
         self,

stubs/fpdf2/fpdf/enums.pyi

@@ -3,12 +3,6 @@ from enum import Enum, Flag, IntEnum
 
 from .syntax import Name
 
-class DocumentState(IntEnum):
-    UNINITIALIZED: int
-    READY: int
-    GENERATING_PAGE: int
-    CLOSED: int
-
 class SignatureFlag(IntEnum):
     SIGNATURES_EXIST: int
     APPEND_ONLY: int