Skip to content

TYP,BLD: Fix backend_pdf stub errors and install it #32586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iccir merged 2 commits into from
Nov 12, 2026
Merged

TYP,BLD: Fix backend_pdf stub errors and install it #32586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f705350
TYP: Fix errors in the backend_pdf stub
maaz7409 Nov 9, 2026
0fa049d
BLD: Install the type stub for backends.backend_pdf
maaz7409 Nov 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions lib/matplotlib/backends/backend_pdf.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import os
import types
from collections.abc import Callable, Iterable, Sequence
from collections.abc import Callable, Iterable, Mapping, Sequence
from datetime import datetime
from enum import Enum
from functools import total_ordering
Expand All @@ -12,7 +12,11 @@ from numpy import typing as npt

from matplotlib import _api, path, transforms
from matplotlib._type1font import Type1Font
from matplotlib.backend_bases import FigureCanvasBase, GraphicsContextBase
from matplotlib.backend_bases import (
FigureCanvasBase,
FigureManagerBase,
GraphicsContextBase,
)
from matplotlib.dviread import DviFont
from matplotlib.figure import Figure
from matplotlib.font_manager import FontPath, FontProperties
Expand All @@ -21,6 +25,7 @@ from matplotlib.transforms import BboxBase, Transform, TransformedBbox, Transfor
from matplotlib.typing import (
CapStyleType,
ColorType,
FillRuleType,
JoinStyleType,
LineStyleType,
RGBColorType,
Expand Down Expand Up @@ -60,6 +65,8 @@ type _SupportsPdfReprExt = (
)

type _MetadataDict = dict[str, str | datetime | Name]
# User-supplied metadata; a None value removes that key.
type _MetadataInput = Mapping[str, str | datetime | Name | None]

def pdfRepr(obj: _SupportsPdfReprExt) -> bytes: ...

Expand Down Expand Up @@ -88,7 +95,9 @@ class Verbatim:
class Op(Enum):
close_fill_stroke = b"b"
fill_stroke = b"B"
fill_evenodd_stroke = b"B*"
fill = b"f"
fill_evenodd = b"f*"
closepath = b"h"
close_stroke = b"s"
stroke = b"S"
Expand Down Expand Up @@ -126,7 +135,9 @@ class Op(Enum):
shading = b"sh"
def pdfRepr(self) -> bytes: ...
@classmethod
def paint_path(cls, fill: bool, stroke: bool) -> bytes: ...
def paint_path(
cls, fill: bool, stroke: bool, *, fill_rule: FillRuleType = "nonzero"
) -> Op: ...

class Stream:
def __init__(
Expand All @@ -144,7 +155,7 @@ class PdfFile:
def __init__(
self,
filename: str | os.PathLike | IO[Any],
metadata: _MetadataDict | None = None,
metadata: _MetadataInput | None = None,
) -> None: ...
@property
def dviFontInfo(self) -> dict[Name, types.SimpleNamespace]: ...
Expand Down Expand Up @@ -358,7 +369,7 @@ class GraphicsContextPdf(GraphicsContextBase):
def __repr__(self) -> str: ...
def stroke(self) -> bool: ...
def fill(self, *args: ColorType) -> bool: ...
def paint(self) -> Op: ...
def paint(self, *, fill_rule: FillRuleType = "nonzero") -> Op: ...
def capstyle_cmd(self, style: CapStyleType) -> _CommandType: ...
def joinstyle_cmd(self, style: JoinStyleType) -> _CommandType: ...
def linewidth_cmd(self, width: float) -> _CommandType: ...
Expand Down Expand Up @@ -388,17 +399,15 @@ class PdfPages:
self,
filename: str | os.PathLike | IO[Any],
keep_empty: None = None,
metadata: _MetadataDict | None = None,
metadata: _MetadataInput | None = None,
) -> None: ...
def __enter__(self) -> Self: ...
def __exit__(
self, exc_type: type[BaseException] | None, exc_val: object, exc_tb: object
) -> None: ...
def close(self) -> None: ...
def infodict(self) -> _MetadataDict: ...
def savefig(
self, figure: Figure | int | None = None, **kwargs: dict[str, Any]
) -> None: ...
def savefig(self, figure: Figure | int | None = None, **kwargs: Any) -> None: ...
def get_pagecount(self) -> int: ...
def attach_note(
self,
Expand All @@ -415,6 +424,8 @@ class FigureCanvasPdf(FigureCanvasBase):
filename: PdfPages | str | os.PathLike | IO[Any],
*,
bbox_inches_restore: _RectangleType | None = None,
metadata: _MetadataDict | None = None,
metadata: _MetadataInput | None = None,
) -> None: ...
def draw(self) -> None: ...

FigureManagerPdf = FigureManagerBase
1 change: 1 addition & 0 deletions lib/matplotlib/backends/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ typing_sources = [
'_macosx.pyi',
'_tkagg.pyi',
# Pure Python types.
'backend_pdf.pyi',
'registry.pyi',
]

Expand Down
Loading