# ****************************************************************************
# * Software: FPDF for python *
# * License: LGPL v3.0+ *
# * *
# * Original Author (PHP): Olivier PLATHEY 2004-12-31 *
# * Ported to Python 2.4 by Max (maxpat78@yahoo.it) on 2006-05 *
# * Maintainer: Mariano Reingart (reingart@gmail.com) et al since 2008 est. *
# * Maintainer: David Alexander (daveankin@gmail.com) et al since 2017 est. *
# * Maintainer: Lucas Cimon et al since 2021 est. *
# ****************************************************************************
import hashlib
import io
import logging
import math
import mimetypes
import os
import re
import sys
import types
import warnings
from collections import defaultdict
from contextlib import contextmanager
from datetime import datetime, timezone
from functools import wraps
from os.path import splitext
from pathlib import Path, PurePath
from typing import (
TYPE_CHECKING,
Any,
BinaryIO,
Callable,
Iterator,
Literal,
NamedTuple,
Optional,
ParamSpec,
Sequence,
Type,
TypeAlias,
TypeVar,
Union,
ValuesView,
cast,
overload,
)
try:
from cryptography.hazmat.primitives.serialization import pkcs12
from endesive import signer
except ImportError:
pkcs12, signer = None, None # type: ignore[assignment]
try:
from PIL.Image import Image # pyright: ignore[reportAssignmentType]
except ImportError:
warnings.warn(
"Pillow could not be imported - fpdf2 will not be able to add any image"
)
class Image: # type: ignore[no-redef]
# The class must exist for some isinstance checks below
pass
from .actions import Action, GoToAction, URIAction
from .annotations import (
DEFAULT_ANNOT_FLAGS,
AnnotationDict,
PDFAnnotation,
PDFEmbeddedFile,
)
from .bidi import BidiParagraph, auto_detect_base_direction
from .deprecation import (
WarnOnDeprecatedModuleAttributes,
deprecated_parameter,
get_stack_level,
support_deprecated_txt_arg,
)
from .drawing import DrawingContext, GraphicsContext, GraphicsStyle, PaintedPath
from .drawing_primitives import (
Color,
ColorInput,
DeviceCMYK,
DeviceGray,
DeviceRGB,
Point,
Transform,
convert_to_device_color,
)
from .encryption import StandardSecurityHandler
from .enums import (
AccessPermission,
Align,
Angle,
AnnotationFlag,
AnnotationName,
AssociatedFileRelationship,
CharVPos,
Corner,
DocumentCompliance,
EncryptionMethod,
FileAttachmentAnnotationName,
MethodReturnValue,
OutputIntentSubType,
PageLabelStyle,
PageLayout,
PageMode,
PageOrientation,
PathPaintRule,
PDFResourceType,
RenderStyle,
TextDirection,
TextEmphasis,
TextMarkupType,
TextMode,
WrapMode,
XPos,
YPos,
)
from .errors import (
FPDFException,
FPDFPageFormatException,
FPDFUnicodeEncodingException,
PDFAComplianceError,
)
from .fonts import CORE_FONTS, CoreFont, FontFace, TextStyle, TitleStyle, TTFFont
from .graphics_state import GraphicsStateMixin, StateStackType
from .html import HTML2FPDF
from .image_datastructures import (
ImageCache,
ImageFilter,
ImageInfo,
RasterImageInfo,
VectorImageInfo,
)
from .image_parsing import (
SUPPORTED_IMAGE_FILTERS,
get_img_info,
load_image,
preload_image,
)
from .line_break import (
Fragment,
MultiLineBreak,
TextLine,
TotalPagesSubstitutionFragment,
)
from .linearization import LinearizedOutputProducer
from .outline import OutlineSection
from .output import (
ZOOM_CONFIGS,
OutputIntentDictionary,
OutputProducer,
PDFICCProfile,
PDFPage,
PDFPageLabel,
ResourceCatalog,
ResourceTypes,
stream_content_for_raster_image,
)
from .pattern import Gradient
from .recorder import FPDFRecorder
from .sign import Signature
from .structure_tree import StructElem, StructureTreeBuilder
from .svg import Percent, SVGObject
from .syntax import DestinationXYZ, Name, PDFArray, PDFDate, PDFString
from .table import Table, draw_box_borders
from .text_region import TextColumns, TextRegionMixin
from .transitions import Transition
from .unicode_script import UnicodeScript, get_unicode_script
from .util import (
FloatTolerance,
ImageType,
Number,
NumberClass,
Padding,
builtin_srgb2014_bytes,
get_parsed_unicode_range,
get_scale_factor,
)
P = ParamSpec("P")
R = TypeVar("R")
if TYPE_CHECKING:
from cryptography.hazmat.primitives.asymmetric.types import PrivateKeyTypes
from cryptography.x509 import Certificate
from .font_type_3 import Type3Font
from .prefs import ViewerPreferences
# Public global variables:
FPDF_VERSION = "2.8.7"
__version__ = FPDF_VERSION
PAGE_FORMATS = {
"a3": (841.89, 1190.55), # 297mm × 420mm
"a4": (595.28, 841.89), # 210mm × 297mm
"a5": (419.53, 595.28), # 148mm x 210mm
"letter": (612, 792),
"legal": (612, 1008),
}
"Supported page format names & dimensions"
# Private global variables:
LOGGER = logging.getLogger(__name__)
HERE = Path(__file__).resolve().parent
FPDF_FONT_DIR: Path = HERE / "font"
LAYOUT_ALIASES: dict[str, Optional[PageLayout]] = {
"default": None,
"single": PageLayout.SINGLE_PAGE,
"continuous": PageLayout.ONE_COLUMN,
"two": PageLayout.TWO_COLUMN_LEFT,
}
class ToCPlaceholder(NamedTuple):
render_function: Callable[["FPDF", list[OutlineSection]], None]
start_page: int
y: float
page_orientation: str | PageOrientation
pages: int = 1
reset_page_indices: bool = True
# Disabling this check due to the "format" parameter below:
# pylint: disable=redefined-builtin
def get_page_format(
format: str | tuple[float, float], k: Optional[float] = None
) -> tuple[float, float]:
"""Return page width and height size in points.
Throws FPDFPageFormatException
`format` can be either a 2-tuple or one of 'a3', 'a4', 'a5', 'letter', or
'legal'.
If format is a tuple, then the return value is the tuple's values
given in the units specified on this document in the constructor,
multiplied by the corresponding scale factor `k`, taken from instance
variable `self.k`.
If format is a string, the (width, height) tuple returned is in points.
For a width and height of 8.5 * 11, 72 dpi is assumed, so the value
returned is (8.5 * 72, 11 * 72), or (612, 792). Additional formats can be
added by adding fields to the `PAGE_FORMATS` dictionary with a
case insensitive key (the name of the new format) and 2-tuple value of
(width, height) in dots per inch with a 72 dpi resolution.
"""
if isinstance(format, str):
format = format.lower()
if format in PAGE_FORMATS:
if format == "a5":
warnings.warn(
# This warning should be removed in the next release:
"Dimensions for page format A5 were fixed in release 2.8.5"
)
return PAGE_FORMATS[format]
raise FPDFPageFormatException(format, unknown=True)
if k is None:
raise FPDFPageFormatException(str(format), one=True)
try:
return format[0] * k, format[1] * k
except Exception as e:
args = f"{format}, {k}"
raise FPDFPageFormatException(f"Arguments must be numbers: {args}") from e
def check_page(fn: Callable[P, R]) -> Callable[P, R]:
"""Decorator to protect drawing methods"""
@wraps(fn)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
self = args[0]
if (
not hasattr(self, "page")
or not self.page # pyright: ignore[reportAttributeAccessIssue, reportUnknownMemberType]
) and not (kwargs.get("dry_run") or kwargs.get("split_only")):
raise FPDFException("No page open, you need to call add_page() first")
return fn(*args, **kwargs)
return wrapper
class FPDF(GraphicsStateMixin, TextRegionMixin):
"PDF Generation class"
MARKDOWN_BOLD_MARKER = "**"
MARKDOWN_ITALICS_MARKER = "__"
MARKDOWN_STRIKETHROUGH_MARKER = "~~"
MARKDOWN_UNDERLINE_MARKER = "--"
MARKDOWN_ESCAPE_CHARACTER = "\\"
MARKDOWN_LINK_REGEX = re.compile(r"^\[([^][]+)\]\(([^()]+)\)(.*)$", re.DOTALL)
MARKDOWN_LINK_COLOR = None
MARKDOWN_LINK_UNDERLINE = True
HTML2FPDF_CLASS = HTML2FPDF
def __init__(
self,
orientation: Union[str, PageOrientation] = PageOrientation.PORTRAIT,
unit: Union[str, float] = "mm",
format: Union[str, tuple[float, float]] = "A4",
font_cache_dir: Literal["DEPRECATED"] = "DEPRECATED",
*,
enforce_compliance: Optional[Union[str, DocumentCompliance]] = None,
) -> None:
"""
Args:
orientation (str): possible values are "portrait" (can be abbreviated "P")
or "landscape" (can be abbreviated "L"). Default to "portrait".
unit (str, int, float): possible values are "pt", "mm", "cm", "in", or a number.
A point equals 1/72 of an inch, that is to say about 0.35 mm (an inch being 2.54 cm).
This is a very common unit in typography; font sizes are expressed in this unit.
If given a number, then it will be treated as the number of points per unit. (eg. 72 = 1 in)
Default to "mm".
format (str): possible values are "a3", "a4", "a5", "letter", "legal" or a tuple
(width, height) expressed in the given unit. Default to "a4".
font_cache_dir (Path or str): [**DEPRECATED since v2.5.1**] unused
"""
if font_cache_dir != "DEPRECATED":
warnings.warn(
(
'"font_cache_dir" parameter is deprecated since v2.5.1, '
"unused and will soon be removed"
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
super().__init__()
self.single_resources_object = False
"""
Setting this to True restore the old behaviour before 2.7.9.
Using a single /Resources object makes the resulting PDF document smaller,
but is less compatible with the PDF spec.
"""
self.page = 0 # current page number
"""
Note: Setting the page manually may result in unexpected behavior.
`pdf.add_page()` takes special care to ensure the page's content stream
matches FPDF's instance attributes. Manually setting the page does not.
"""
# array of PDFPage objects starting at index 1:
self.pages: dict[int, PDFPage] = {}
# map page numbers to a set of font indices:
self.links: dict[int, DestinationXYZ] = (
{}
) # Destination objects starting at index 1
self.named_destinations: dict[str, DestinationXYZ] = (
{}
) # map names to Destination objects
self.embedded_files: list[PDFEmbeddedFile] = [] # array of PDFEmbeddedFile
self.image_cache = ImageCache()
self.in_footer = False # flag set while rendering footer
# indicates that we are inside an .unbreakable() code block:
self._in_unbreakable = False
self._lasth: float = 0 # height of last cell printed
self.alias_nb_pages() # enable alias by default
self._angle: float = 0 # used by deprecated method: rotate()
self.xmp_metadata = None
# Define the compression algorithm used when embedding images:
self.page_duration = 0 # optional pages display duration, cf. add_page()
self.page_transition = None # optional pages transition, cf. add_page()
self.allow_images_transparency = True
# Do nothing by default. Allowed values: 'WARN', 'DOWNSCALE':
self.oversized_images: Optional[Literal["WARN", "DOWNSCALE"]] = None
self.oversized_images_ratio = 2 # number of pixels per UserSpace point
self.struct_builder = StructureTreeBuilder()
self.toc_placeholder: Optional[ToCPlaceholder] = None
self._outline: list[OutlineSection] = []
# flag set true while rendering the table of contents
self.in_toc_rendering = False
# allow page insertion when writing the table of contents
self._toc_allow_page_insertion = False
self._toc_inserted_pages = 0 # number of pages inserted
# dict of Output Intents, with keys beings their subtypes:
self._output_intents: dict[Name, OutputIntentDictionary] = {}
self._sign_key = None
self.title: Optional[str] = None
self.section_title_styles: dict[int, TextStyle] = {} # level -> TextStyle
self.core_fonts_encoding = "latin-1"
"Font encoding, Latin-1 by default"
# Replace these fonts with these core fonts
self.font_aliases = {
"arial": "helvetica",
"couriernew": "courier",
"timesnewroman": "times",
}
# Scale factor
self.k = get_scale_factor(unit)
# Graphics state variables defined as properties by GraphicsStateMixin.
# We set their default values here.
self.font_family = "" # current font family
# current font style (BOLD/ITALICS - does not handle UNDERLINE nor STRIKETHROUGH):
self.font_style = ""
self.underline = False
self.strikethrough = False
self.font_size_pt: float = 12 # current font size in points
self.font_stretching = 100 # current font stretching
self.char_spacing = 0 # current character spacing
self.current_font: Optional[CoreFont | TTFFont] = (
None # None or an instance of CoreFont or TTFFont
)
self.current_font_is_set_on_page = False # current font and size are already added to current page contents with _out
self.draw_color = self.DEFAULT_DRAW_COLOR
self.fill_color = self.DEFAULT_FILL_COLOR
self.text_color = self.DEFAULT_TEXT_COLOR
self.page_background = None
self.dash_pattern = dict(dash=0, gap=0, phase=0)
self.line_width = 0.567 / self.k # line width (0.2 mm)
self.text_mode = TextMode.FILL
# end of graphics state variables
self.dw_pt, self.dh_pt = get_page_format(format, self.k)
self._set_orientation(orientation, self.dw_pt, self.dh_pt)
self.def_orientation = self.cur_orientation
# Page spacing
# Page margins (1 cm)
margin: float = (7200 / 254) / self.k
self.x: float = 0
self.y: float = 0
self.l_margin: float = 0
self.t_margin: float = 0
self.set_margins(margin, margin)
self.x, self.y = self.l_margin, self.t_margin
self.c_margin: float = margin / 10.0 # Interior cell margin (1 mm)
# sets self.auto_page_break, self.b_margin & self.page_break_trigger:
self.set_auto_page_break(True, 2 * margin)
self.set_display_mode("fullwidth") # Full width display mode
self._page_mode: Optional[PageMode] = None
self.viewer_preferences: Optional["ViewerPreferences"] = (
None # optional instance of ViewerPreferences
)
self.compress: bool = True # switch enabling pages content compression
self.pdf_version: str = "1.3" # Set default PDF version No.
self.creation_date: datetime = datetime.now(timezone.utc)
self._security_handler: Optional[StandardSecurityHandler] = None
self._fallback_font_ids: list[str] = []
self._fallback_font_exact_match = False
self.render_color_fonts: bool = True
self._compliance: Optional[DocumentCompliance] = (
DocumentCompliance.coerce(enforce_compliance)
if enforce_compliance
else None
)
if self._compliance:
if self._compliance.profile == "PDFA" and self._compliance.part == 1:
self._set_min_pdf_version("1.4")
self.allow_images_transparency = False
if self._compliance.profile == "PDFA" and self._compliance.part in (2, 3):
self._set_min_pdf_version("1.7")
if self._compliance.profile == "PDFA" and self._compliance.part == 4:
self._set_min_pdf_version("2.0")
self._current_draw_context: Optional[DrawingContext] = None
# map page numbers to a set of GraphicsState names:
self._record_text_quad_points = False
self._resource_catalog: ResourceCatalog = ResourceCatalog()
# page number -> array of 8 × n numbers:
self._text_quad_points: dict[int, list[float]] = defaultdict(list)
# final buffer holding the PDF document in-memory - defined only after calling output():
self.buffer: Optional[bytearray] = None
@property
def fonts(self) -> dict[str, CoreFont | TTFFont]:
return self._resource_catalog.font_registry
def set_encryption(
self,
owner_password: str,
user_password: Optional[str] = None,
encryption_method: EncryptionMethod = EncryptionMethod.RC4,
permissions: int = AccessPermission.all(),
encrypt_metadata: bool = False,
) -> None:
"""
Activate encryption of the document content.
Args:
owner_password (str): mandatory. The owner password allows to perform any change on the document,
including removing all encryption and access permissions.
user_password (str): optional. If a user password is set, the content of the document will be encrypted
and a password prompt displayed when a user opens the document.
The document will only be displayed after either the user or owner password is entered.
encryption_method (fpdf.enums.EncryptionMethod, str): algorithm to be used to encrypt the document.
Defaults to RC4.
permissions (fpdf.enums.AccessPermission): specify access permissions granted
when the document is opened with user access. Defaults to ALL.
encrypt_metadata (bool): whether to also encrypt document metadata (author, creation date, etc.).
Defaults to False.
"""
if self._compliance and self._compliance.profile == "PDFA":
raise PDFAComplianceError(
f"Encryption is now allowed for documents compliant with {self._compliance.label}"
)
self._security_handler = StandardSecurityHandler(
self,
owner_password=owner_password,
user_password=user_password,
permission=permissions,
encryption_method=encryption_method,
encrypt_metadata=encrypt_metadata,
)
def write_html(self, text: str, *args: Any, **kwargs: Any) -> None:
"""
Parse HTML and convert it to PDF.
cf. https://py-pdf.github.io/fpdf2/HTML.html
Args:
text (str): HTML content to render
image_map (function): an optional one-argument function that map `` "src" to new image URLs
li_tag_indent (int): [**DEPRECATED since v2.7.9**]
numeric indentation of `
` elements - Set `tag_styles` instead
dd_tag_indent (int): [**DEPRECATED since v2.7.9**]
numeric indentation of `
` elements - Set `tag_styles` instead
table_line_separators (bool): enable horizontal line separators in `
`. Defaults to `False`.
ul_bullet_char (str): bullet character preceding `
` items in `
` lists.
Can also be configured using the HTML `type` attribute of `
` tags.
li_prefix_color (tuple, str, fpdf.drawing.DeviceCMYK, fpdf.drawing.DeviceGray, fpdf.drawing.DeviceRGB): color for bullets
or numbers preceding `
` tags. This applies to both `
` & `` lists.
heading_sizes (dict): [**DEPRECATED since v2.7.9**]
font size per heading level names ("h1", "h2"...) - Set `tag_styles` instead
pre_code_font (str): [**DEPRECATED since v2.7.9**]
font to use for `
` & `` blocks - Set `tag_styles` instead
warn_on_tags_not_matching (bool): control warnings production for unmatched HTML tags. Defaults to `True`.
tag_indents (dict): [**DEPRECATED since v2.8.0**]
mapping of HTML tag names to numeric values representing their horizontal left indentation. - Set `tag_styles` instead
tag_styles (dict[str, fpdf.fonts.TextStyle]): mapping of HTML tag names to `fpdf.fonts.TextStyle` or `fpdf.fonts.FontFace` instances
"""
html2pdf = self.HTML2FPDF_CLASS(self, *args, **kwargs)
with self.local_context():
html2pdf.feed(text)
def _set_min_pdf_version(self, version: str) -> None:
self.pdf_version = max(self.pdf_version, version)
@property
def emphasis(self) -> TextEmphasis:
"The current text emphasis: bold, italics, underline and/or strikethrough."
font_style = self.font_style
if self.strikethrough:
font_style += "S"
if self.underline:
font_style += "U"
return TextEmphasis.coerce(font_style)
@property
def is_ttf_font(self) -> bool:
return self.current_font is not None and self.current_font.type == "TTF"
@property
def page_mode(self) -> Optional[PageMode]:
return self._page_mode
@page_mode.setter
def page_mode(self, page_mode: PageMode | str) -> None:
self._page_mode = PageMode.coerce(page_mode)
if self._page_mode == PageMode.USE_ATTACHMENTS:
self._set_min_pdf_version("1.6")
elif self._page_mode == PageMode.USE_OC:
self._set_min_pdf_version("1.5")
@property
def output_intents(self) -> ValuesView[OutputIntentDictionary]:
return self._output_intents.values()
def add_output_intent(
self,
subtype: OutputIntentSubType,
output_condition_identifier: Optional[str] = None,
output_condition: Optional[str] = None,
registry_name: Optional[str] = None,
dest_output_profile: Optional[PDFICCProfile] = None,
info: Optional[str] = None,
) -> None:
"""
Adds desired Output Intent to the Output Intents array:
Args:
subtype (OutputIntentSubType, required): PDFA, PDFX or ISOPDF
output_condition_identifier (str, required): see the Name in
https://www.color.org/registry.xalter
output_condition (str, optional): see the Definition in
https://www.color.org/registry.xalter
registry_name (str, optional): "https://www.color.org"
dest_output_profile (PDFICCProfile, required/optional):
PDFICCProfile | None # (required if
output_condition_identifier does not specify a standard
production condition; optional otherwise)
info (str, required/optional see dest_output_profile): human
readable description of profile
"""
if subtype.value in self._output_intents:
raise ValueError(
"add_output_intent: subtype '" + subtype.value + "' already exists."
)
self._output_intents[subtype.value] = OutputIntentDictionary(
subtype,
output_condition_identifier,
output_condition,
registry_name,
dest_output_profile,
info,
)
self._set_min_pdf_version("1.4")
@property
def epw(self) -> float:
"""
Effective page width: the page width minus its horizontal margins.
"""
return self.w - self.l_margin - self.r_margin
@property
def eph(self) -> float:
"""
Effective page height: the page height minus its vertical margins.
"""
return self.h - self.t_margin - self.b_margin
@property
def pages_count(self) -> int:
"""
Returns the total pages of the document, at the time it is called.
Do not use this in `fpdf.fpdf.FPDF.header()` or `fpdf.fpdf.FPDF.footer()`,
as its value will not be the total page count.
Uses `{nb}` instead, _cf._ `fpdf.fpdf.FPDF.alias_nb_pages()`.
"""
return len(self.pages)
def set_margin(self, margin: float) -> None:
"""
Sets the document right, left, top & bottom margins to the same value.
Args:
margin (float): margin in the unit specified to FPDF constructor
"""
self.set_margins(margin, margin)
self.set_auto_page_break(self.auto_page_break, margin)
def set_margins(self, left: float, top: float, right: float = -1) -> None:
"""
Sets the document left, top & optionally right margins to the same value.
By default, they equal 1 cm.
Also sets the current FPDF.y on the page to this minimum vertical position.
Args:
left (float): left margin in the unit specified to FPDF constructor
top (float): top margin in the unit specified to FPDF constructor
right (float): optional right margin in the unit specified to FPDF constructor
"""
self.set_left_margin(left)
if self.y < top or self.y == self.t_margin:
self.y = top
self.t_margin = top
if right == -1:
right = left
self.r_margin = right
def set_left_margin(self, margin: float) -> None:
"""
Sets the document left margin.
Also sets the current FPDF.x on the page to this minimum horizontal position.
Args:
margin (float): margin in the unit specified to FPDF constructor
"""
if self.x < margin or self.x == self.l_margin:
self.x = margin
self.l_margin = margin
def set_top_margin(self, margin: float) -> None:
"""
Sets the document top margin.
Args:
margin (float): margin in the unit specified to FPDF constructor
"""
self.t_margin = margin
def set_right_margin(self, margin: float) -> None:
"""
Sets the document right margin.
Args:
margin (float): margin in the unit specified to FPDF constructor
"""
self.r_margin = margin
def set_auto_page_break(self, auto: bool, margin: float = 0) -> None:
"""
Set auto page break mode, and optionally the bottom margin that triggers it.
By default, the mode is on and the bottom margin is 2 cm.
Detailed documentation on page breaks: https://py-pdf.github.io/fpdf2/PageBreaks.html
Args:
auto (bool): enable or disable this mode
margin (float): optional bottom margin (distance from the bottom of the page)
in the unit specified to FPDF constructor
"""
self.auto_page_break: bool = auto
self.b_margin: float = margin
self.page_break_trigger: float = self.h - self.b_margin
@property
def default_page_dimensions(self) -> tuple[float, float]:
"Return a pair (width, height) in points units (1/72 of inch)"
return (
(self.dw_pt, self.dh_pt)
if self.def_orientation == PageOrientation.PORTRAIT
else (self.dh_pt, self.dw_pt)
)
def _set_orientation(
self,
orientation: str | PageOrientation,
page_width_pt: float,
page_height_pt: float,
) -> None:
self.cur_orientation = PageOrientation.coerce(orientation)
if self.cur_orientation is PageOrientation.PORTRAIT:
self.w_pt = page_width_pt
self.h_pt = page_height_pt
else:
self.w_pt = page_height_pt
self.h_pt = page_width_pt
self.w = self.w_pt / self.k
self.h = self.h_pt / self.k
if hasattr(self, "auto_page_break"): # not set when called from constructor
# When self.h is modified, the .page_break_trigger must be re-computed:
self.set_auto_page_break(self.auto_page_break, self.b_margin)
def set_display_mode(
self,
zoom: str | float,
layout: str = "continuous",
) -> None:
"""
Defines the way the document is to be displayed by the viewer.
It allows to set the zoom level: pages can be displayed entirely on screen,
occupy the full width of the window, use the real size,
be scaled by a specific zooming factor or use the viewer default (configured in its Preferences menu).
The page layout can also be specified: single page at a time, continuous display, two columns or viewer default.
Args:
zoom: either "fullpage", "fullwidth", "real", "default",
or a number indicating the zooming factor to use, interpreted as a percentage.
The zoom level set by default is "default".
layout (fpdf.enums.PageLayout, str): allowed layout aliases are "single", "continuous", "two" or "default",
meaning to use the viewer default mode.
The layout set by default is "continuous".
"""
if zoom in ZOOM_CONFIGS or not isinstance(zoom, str):
self.zoom_mode = zoom
elif zoom != "default":
raise FPDFException(f"Incorrect zoom display mode: {zoom}")
if isinstance(layout, PageLayout):
self.page_layout = layout
else:
# First support legacy aliases like "continuous"/"single"/"default"
alias_layout = LAYOUT_ALIASES.get(str(layout))
if alias_layout is not None or str(layout) in LAYOUT_ALIASES:
self.page_layout = alias_layout
else:
try:
self.page_layout = PageLayout.coerce(str(layout))
except (ValueError, TypeError) as exc:
raise FPDFException(
f"Incorrect layout display mode: {layout}"
) from exc
def set_text_shaping(
self,
use_shaping_engine: bool = True,
features: Optional[dict[str, Any]] = None,
direction: Optional[str | TextDirection] = None,
script: Optional[str] = None,
language: Optional[str] = None,
) -> None:
"""
Enable or disable text shaping engine when rendering text.
If features, direction, script or language are not specified the shaping engine will try
to guess the values based on the input text.
Args:
use_shaping_engine: enable or disable the use of the shaping engine to process the text
features: a dictionary containing 4 digit OpenType features and whether each feature
should be enabled or disabled
example: features={"kern": False, "liga": False}
direction: the direction the text should be rendered, either "ltr" (left to right)
or "rtl" (right to left).
script: a valid OpenType script tag like "arab" or "latn"
language: a valid OpenType language tag like "eng" or "fra"
"""
if not use_shaping_engine:
self.text_shaping = None
return
try:
# pylint: disable=import-outside-toplevel, unused-import
import uharfbuzz # pyright: ignore[reportUnusedImport]
except ImportError as exc:
raise FPDFException(
"The uharfbuzz package could not be imported, but is required for text shaping. Try: pip install uharfbuzz"
) from exc
#
# Features must be a dictionary containing opentype features and a boolean flag
# stating whether the feature should be enabled or disabled.
#
# e.g. features={"liga": True, "kern": False}
#
# https://harfbuzz.github.io/shaping-opentype-features.html
#
if features and not isinstance(features, dict):
raise FPDFException(
"Features must be a dictionary. See text shaping documentation"
)
if not features:
features = {}
# Buffer properties (direction, script and language)
# if the properties are not provided, Harfbuzz "guessing" logic is used.
# https://harfbuzz.github.io/setting-buffer-properties.html
# Valid harfbuzz directions are ltr (left to right), rtl (right to left),
# ttb (top to bottom) or btt (bottom to top)
text_direction = None
if direction:
text_direction = (
direction
if isinstance(direction, TextDirection)
else TextDirection.coerce(direction)
)
if text_direction not in [TextDirection.LTR, TextDirection.RTL]:
raise FPDFException(
"FPDF2 only accept ltr (left to right) or rtl (right to left) directions for now."
)
self.text_shaping = {
"use_shaping_engine": True,
"features": features,
"direction": text_direction,
"script": script,
"language": language,
"fragment_direction": None,
"paragraph_direction": None,
}
@property
def page_layout(self) -> Optional[PageLayout]:
return self._page_layout
@page_layout.setter
def page_layout(self, page_layout: Optional[str | PageLayout]) -> None:
self._page_layout = PageLayout.coerce(page_layout) if page_layout else None
if self._page_layout in (PageLayout.TWO_PAGE_LEFT, PageLayout.TWO_PAGE_RIGHT):
self._set_min_pdf_version("1.5")
def set_compression(self, compress: bool) -> None:
"""
Activates or deactivates page compression.
When activated, the internal representation of each page is compressed
using the zlib/deflate method (FlateDecode), which leads to a compression ratio
of about 2 for the resulting document.
Page compression is enabled by default.
Args:
compress (bool): indicates if compression should be enabled
"""
self.compress = compress
def set_title(self, title: str) -> None:
"""
Defines the title of the document.
Most PDF readers will display it when viewing the document.
There is also a related `fpdf.prefs.ViewerPreferences` entry:
pdf.viewer_preferences = ViewerPreferences(display_doc_title=True)
Args:
title (str): the title
"""
self.title = title
def set_lang(self, lang: str) -> None:
"""
A language identifier specifying the natural language for all text in the document
except where overridden by language specifications for structure elements or marked content.
A language identifier can either be the empty text string, to indicate that the language is unknown,
or a Language-Tag as defined in RFC 3066, "Tags for the Identification of Languages".
Args:
lang (str): the document main language
"""
self.lang = lang
if lang:
self._set_min_pdf_version("1.4")
def set_subject(self, subject: str) -> None:
"""
Defines the subject of the document.
Args:
subject (str): the document main subject
"""
self.subject = subject
def set_author(self, author: str | Sequence[str]) -> None:
"""
Defines the author of the document.
Args:
author(str): the name of the author
"""
self.author = author
def set_keywords(self, keywords: str | Sequence[str]) -> None:
"""
Associate keywords with the document
Args:
keywords (str): a space-separated list of words
"""
self.keywords = keywords
def set_creator(self, creator: str) -> None:
"""
Defines the creator of the document.
This is typically the name of the application that generates the PDF.
Args:
creator (str): name of the PDF creator
"""
self.creator = creator
def set_producer(self, producer: str) -> None:
"""Producer of document"""
self.producer = producer
def set_creation_date(self, date: Optional[datetime] = None) -> None:
"""Sets Creation of Date time, or current time if None given."""
if self._sign_key:
raise FPDFException(
".set_creation_date() must always be called before .sign*() methods"
)
if not isinstance(date, datetime):
raise TypeError(f"date should be a datetime but is a {type(date)}")
if not date.tzinfo:
date = date.astimezone()
self.creation_date = date
def set_xmp_metadata(self, xmp_metadata: str) -> None:
if " tag"
)
self.xmp_metadata = xmp_metadata
if xmp_metadata:
self._set_min_pdf_version("1.4")
def set_doc_option(self, opt: Literal["core_fonts_encoding"], value: str) -> None:
"""
Defines a document option.
Args:
opt (str): name of the option to set
value (str) option value
.. deprecated:: 2.4.0
Simply set the `FPDF.core_fonts_encoding` property as a replacement.
"""
warnings.warn(
(
"set_doc_option() is deprecated since v2.4.0 "
"and will be removed in a future release. "
"Simply set the `.core_fonts_encoding` property as a replacement."
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
if opt != "core_fonts_encoding":
raise FPDFException(f'Unknown document option "{opt}"')
self.core_fonts_encoding = value
def set_image_filter(self, image_filter: str) -> None:
"""
Args:
image_filter (str): name of a the image filter to use
when embedding images in the document, or "AUTO",
meaning to use the best image filter given the images provided.
Allowed values: `FlateDecode` (lossless zlib/deflate compression),
`DCTDecode` (lossy compression with JPEG)
`LZWDecode` (Lempel-Ziv-Welch aka LZW compression)
and `JPXDecode` (lossy compression with JPEG2000).
[**NEW in 2.8.4**] Note that, when using `LZWDecode`, having NumPy installed
will improve performances, reducing execution time.
"""
if image_filter not in SUPPORTED_IMAGE_FILTERS:
raise ValueError(
f"'{image_filter}' is not a supported image filter"
f" - Allowed values: {''.join(SUPPORTED_IMAGE_FILTERS)}"
)
self.image_cache.image_filter = cast(ImageFilter, image_filter)
if image_filter == "JPXDecode":
self._set_min_pdf_version("1.5")
def alias_nb_pages(self, alias: str = "{nb}") -> None:
"""
Defines an alias for the total number of pages.
It will be substituted as the document is closed.
This is useful to insert the number of pages of the document
at a time when this number is not known by the program.
This substitution can be disabled for performances reasons, by calling `alias_nb_pages(None)`.
Args:
alias (str): the alias. Defaults to `"{nb}"`.
Notes
-----
When using this feature with the `FPDF.cell` / `FPDF.multi_cell` methods,
or the `.underline` / `.strikethrough` attributes of `FPDF` class,
the width of the text rendered will take into account the alias length,
not the length of the "actual number of pages" string,
which can causes slight positioning differences.
"""
self.str_alias_nb_pages = alias
@check_page
def set_page_label(
self,
label_style: Optional[str | PageLabelStyle] = None,
label_prefix: Optional[str] = None,
label_start: Optional[int] = None,
) -> None:
"""
Enable `fpdf.output.PDFPageLabel` to be inserted on every page.
This will be displayed by some PDF readers to identify pages.
"""
current_page_label = None
if self.page in self.pages:
current_page_label = self.pages[self.page].get_page_label()
elif self.page > 1:
current_page_label = self.pages[self.page - 1].get_page_label()
new_page_label = None
if label_style or label_prefix or label_start:
if current_page_label:
if label_style is None:
label_style = current_page_label.get_style()
if label_prefix is None:
label_prefix = current_page_label.get_prefix()
if label_start is None and not (
self.toc_placeholder and self.toc_placeholder.reset_page_indices
):
label_start = current_page_label.get_start()
label_style = (
PageLabelStyle.coerce(label_style, case_sensitive=True)
if label_style
else None
)
new_page_label = PDFPageLabel(label_style, label_prefix, label_start)
self.pages[self.page].set_page_label(current_page_label, new_page_label)
def add_page(
self,
orientation: str = "",
format: str = "",
same: bool = False,
duration: float = 0,
transition: Optional[Transition] = None,
label_style: Optional[str | PageLabelStyle] = None,
label_prefix: Optional[str] = None,
label_start: Optional[int] = None,
) -> None:
"""
Adds a new page to the document.
If a page is already present, the `FPDF.footer()` method is called first.
Then the page is added, the current position is set to the top-left corner,
with respect to the left and top margins, and the `FPDF.header()` method is called.
Args:
orientation (str): "portrait" (can be abbreviated "P")
or "landscape" (can be abbreviated "L"). Default to "portrait".
format (str): "a3", "a4", "a5", "letter", "legal" or a tuple
(width, height). Default to "a4".
same (bool): indicates to use the same page format as the previous page.
Default to False.
duration (float): optional page’s display duration, i.e. the maximum length of time,
in seconds, that the page is displayed in presentation mode,
before the viewer application automatically advances to the next page.
Can be configured globally through the `.page_duration` FPDF property.
As of june 2021, onored by Adobe Acrobat reader, but ignored by Sumatra PDF reader.
transition (Transition child class): optional visual transition to use when moving
from another page to the given page during a presentation.
Can be configured globally through the `.page_transition` FPDF property.
As of june 2021, onored by Adobe Acrobat reader, but ignored by Sumatra PDF reader.
label_style (str or PageLabelStyle): Defines the numbering style for the numeric portion of each
page label. Possible values are:
- "D": Decimal Arabic numerals.
- "R": Uppercase Roman numerals.
- "r": Lowercase Roman numerals.
- "A": Uppercase letters (A to Z for the first 26 pages, followed by AA to ZZ, etc.).
- "a": Lowercase letters (a to z for the first 26 pages, followed by aa to zz, etc.).
label_prefix (str): Prefix string applied to the page label, preceding the numeric portion.
label_start (int): Starting number for the first page of a page label range.
"""
if self.buffer:
raise FPDFException(
"A page cannot be added on a closed document, after calling output()"
)
self.current_font_is_set_on_page = False
family = self.font_family
emphasis = self.emphasis
size = self.font_size_pt
lw = self.line_width
dc = self.draw_color
fc = self.fill_color
tc = self.text_color
stretching = self.font_stretching
char_spacing = self.char_spacing
dash_pattern = self.dash_pattern
in_toc_extra_page = (
self.in_toc_rendering
and self._toc_allow_page_insertion
and self.page > self.toc_placeholder.start_page # type: ignore[union-attr]
)
if self.page > 0 and (not self.in_toc_rendering or in_toc_extra_page):
# Page footer
self._render_footer()
current_page_label = (
None if self.page == 0 else self.pages[self.page].get_page_label()
)
new_page_label = None
if label_style or label_prefix or label_start:
label_style = (
PageLabelStyle.coerce(label_style, case_sensitive=True)
if label_style
else None
)
new_page_label = PDFPageLabel(label_style, label_prefix, label_start)
# Start new page
self._beginpage(
orientation,
format,
same,
duration or self.page_duration,
transition or self.page_transition,
new_page=not self._has_next_page(),
)
self.pages[self.page].set_page_label(current_page_label, new_page_label)
if self.page_background:
if isinstance(self.page_background, tuple):
self.set_fill_color(*self.page_background)
self.rect(0, 0, self.w, self.h, style="F")
assert isinstance(fc, (DeviceRGB, DeviceGray))
self.set_fill_color(*fc.colors255)
else:
self.image(
self.page_background, # pyright: ignore[reportArgumentType]
0,
0,
self.w,
self.h,
)
self._out("2 J") # Set line cap style to square
self.line_width = lw # Set line width
self._out(f"{lw * self.k:.2f} w")
# Set font
if family:
self.set_font(family, emphasis, size)
# Set colors
self.draw_color = dc
if dc != self.DEFAULT_DRAW_COLOR and dc is not None:
self._out(dc.serialize().upper())
self.fill_color = fc
if fc != self.DEFAULT_FILL_COLOR and fc is not None:
self._out(fc.serialize().lower())
self.text_color = tc
# BEGIN Page header
if (not self.in_toc_rendering) or self._toc_allow_page_insertion:
self.header()
if self.line_width != lw: # Restore line width
self.line_width = lw
self._out(f"{lw * self.k:.2f} w")
if family:
self.set_font(family, emphasis, size) # Restore font
if self.draw_color != dc and dc is not None: # Restore colors
self.draw_color = dc
self._out(dc.serialize().upper())
if self.fill_color != fc and fc is not None:
self.fill_color = fc
self._out(fc.serialize().lower())
self.text_color = tc
if stretching != 100: # Restore stretching
self.set_stretching(stretching)
if char_spacing != 0:
self.set_char_spacing(char_spacing)
if dash_pattern != dict(dash=0, gap=0, phase=0):
self._write_dash_pattern(
dash_pattern["dash"], dash_pattern["gap"], dash_pattern["phase"]
)
# END Page header
def _render_footer(self) -> None:
self.in_footer = True
if self.toc_placeholder:
# The ToC is rendered AFTER the footer,
# so we must ensure there is no "style leak":
self._push_local_stack()
self._start_local_context()
self.footer()
if self.toc_placeholder:
self._end_local_context()
self._pop_local_stack()
self.in_footer = False
def _beginpage(
self,
orientation: str | PageOrientation,
format: str | tuple[float, float],
same: bool,
duration: Optional[float],
transition: Optional[Transition],
new_page: bool = True,
) -> None:
self.page += 1
if self.in_toc_rendering and self._toc_allow_page_insertion:
self._toc_inserted_pages += 1
self.page = len(self.pages) + 1
new_page = True
if new_page:
page = PDFPage(
contents=bytearray(),
duration=duration,
transition=transition,
index=self.page,
)
self.pages[self.page] = page
if transition:
self._set_min_pdf_version("1.5")
else:
page = self.pages[self.page]
self.x = self.l_margin
self.y = self.t_margin
self.font_family = ""
self.font_stretching = 100
self.char_spacing = 0
if same:
if orientation or format:
raise ValueError(
f"Inconsistent parameters: same={same} but orientation={orientation} format={format}"
)
else:
# Set page format if provided, else use default value:
page_width_pt, page_height_pt = (
get_page_format(format, self.k) if format else (self.dw_pt, self.dh_pt)
)
self._set_orientation(
orientation or self.def_orientation, page_width_pt, page_height_pt
)
page.set_dimensions(self.w_pt, self.h_pt)
def header(self) -> None:
"""
Header to be implemented in your own inherited class
This is automatically called by `FPDF.add_page()`
and should not be called directly by the user application.
The default implementation performs nothing: you have to override this method
in a subclass to implement your own rendering logic.
Note that header rendering can have an impact on the initial
(x,y) position when starting to render the page content.
"""
def footer(self) -> None:
"""
Footer to be implemented in your own inherited class.
This is automatically called by `FPDF.add_page()` and `FPDF.output()`
and should not be called directly by the user application.
The default implementation performs nothing: you have to override this method
in a subclass to implement your own rendering logic.
"""
def page_no(self) -> int:
"""Get the current page number"""
return self.page
def get_page_label(self) -> str:
"""
Return the current page `fpdf.output.PDFPageLabel`.
This will be displayed by some PDF readers to identify pages.
`FPDF.set_page_label()` needs to be called first for those to be inserted.
"""
return self.pages[self.page].get_label()
def set_draw_color(
self, r: Number | Color | str | Sequence[Number], g: Number = -1, b: Number = -1
) -> None:
"""
Defines the color used for all stroking operations (lines, rectangles and cell borders).
Accepts either a single greyscale value, 3 values as RGB components, a single `#abc` or `#abcdef` hexadecimal color string,
or an instance of `fpdf.drawing.DeviceCMYK`, `fpdf.drawing.DeviceRGB` or `fpdf.drawing.DeviceGray`.
The method can be called before the first page is created and the value is retained from page to page.
Args:
r (int, tuple, fpdf.drawing.DeviceGray, fpdf.drawing.DeviceRGB): if `g` and `b` are given, this indicates the red component.
Else, this indicates the grey level. The value must be between 0 and 255.
g (int): green component (between 0 and 255)
b (int): blue component (between 0 and 255)
"""
draw_color = convert_to_device_color(r, g, b)
if draw_color != self.draw_color:
self.draw_color = draw_color
if self.page > 0:
self._out(
self.draw_color.serialize().upper() # pyright: ignore[reportOptionalMemberAccess]
)
def set_fill_color(
self, r: Number | Color | str | Sequence[Number], g: Number = -1, b: Number = -1
) -> None:
"""
Defines the color used for all filling operations (filled rectangles and cell backgrounds).
Accepts either a single greyscale value, 3 values as RGB components, a single `#abc` or `#abcdef` hexadecimal color string,
or an instance of `fpdf.drawing.DeviceCMYK`, `fpdf.drawing.DeviceRGB` or `fpdf.drawing.DeviceGray`.
The method can be called before the first page is created and the value is retained from page to page.
Args:
r (int, tuple, fpdf.drawing.DeviceGray, fpdf.drawing.DeviceRGB): if `g` and `b` are given, this indicates the red component.
Else, this indicates the grey level. The value must be between 0 and 255.
g (int): green component (between 0 and 255)
b (int): blue component (between 0 and 255)
"""
fill_color = convert_to_device_color(r, g, b)
if fill_color != self.fill_color:
self.fill_color = fill_color
if self.page > 0:
self._out(
self.fill_color.serialize().lower() # pyright: ignore[reportOptionalMemberAccess]
)
def set_text_color(
self,
r: (
Number
| Color
| str
| Sequence[Number]
| DeviceCMYK
| DeviceGray
| DeviceRGB
),
g: Number = -1,
b: Number = -1,
) -> None:
"""
Defines the color used for text.
Accepts either a single greyscale value, 3 values as RGB components, a single `#abc` or `#abcdef` hexadecimal color string,
or an instance of `fpdf.drawing.DeviceCMYK`, `fpdf.drawing.DeviceRGB` or `fpdf.drawing.DeviceGray`.
The method can be called before the first page is created and the value is retained from page to page.
Args:
r (int, tuple, fpdf.drawing.DeviceGray, fpdf.drawing.DeviceRGB): if `g` and `b` are given, this indicates the red component.
Else, this indicates the grey level. The value must be between 0 and 255.
g (int): green component (between 0 and 255)
b (int): blue component (between 0 and 255)
"""
self.text_color = convert_to_device_color(r, g, b)
def get_string_width(
self, s: str, normalized: bool = False, markdown: bool = False
) -> float:
"""
Returns the length of a string in user unit. A font must be selected.
The value is calculated with stretching and spacing.
Note that the width of a cell has some extra padding added to this width,
on the left & right sides, equal to the .c_margin property.
Args:
s (str): the string whose length is to be computed.
normalized (bool): whether normalization needs to be performed on the input string.
markdown (bool): indicates if basic markdown support is enabled
"""
if not self.font_family:
raise FPDFException("No font set, you need to call set_font() beforehand")
# normalized is parameter for internal use
s = s if normalized else self.normalize_text(s)
return sum(
frag.get_width() for frag in self._preload_bidirectional_text(s, markdown)
)
def set_line_width(self, width: float) -> None:
"""
Defines the line width of all stroking operations (lines, rectangles and cell borders).
By default, the value equals 0.2 mm.
The method can be called before the first page is created and the value is retained from page to page.
Args:
width (float): the width in user unit
"""
if width != self.line_width:
self.line_width = width
if self.page > 0:
self._out(f"{width * self.k:.2f} w")
def set_page_background(
self, background: Optional[str | BinaryIO | Image | DeviceRGB | tuple[float]]
) -> None:
"""
Sets a background color or image to be drawn every time `FPDF.add_page()` is called, or removes a previously set background.
The method can be called before the first page is created and the value is retained from page to page.
Args:
background: either a string representing a file path or URL to an image,
an io.BytesIO containing an image as bytes, an instance of `PIL.Image.Image`, drawing.DeviceRGB
or a RGB tuple representing a color to fill the background with or `None` to remove the background
"""
if isinstance(
background, (str, io.BytesIO, Image, DeviceRGB, tuple, type(None))
):
if isinstance(background, DeviceRGB):
self.page_background = background.colors255
else:
self.page_background = background
else:
raise TypeError(
f"""background must be of type str, io.BytesIO, PIL.Image.Image, drawing.DeviceRGB, tuple or None
got: {type(background)}"""
)
@contextmanager
@check_page
def drawing_context(
self, debug_stream: Optional[bool] = None # pylint: disable=unused-argument
) -> Iterator[DrawingContext]:
"""
Create a context for drawing paths on the current page.
If this context manager is called again inside of an active context, it will
raise an exception, as base drawing contexts cannot be nested.
"""
if self._current_draw_context is not None:
raise FPDFException(
"cannot create a drawing context while one is already open"
)
context = DrawingContext()
self._current_draw_context = context
try:
yield context
finally:
self._current_draw_context = None
starting_style = self._current_graphic_style()
render_args = (
self._resource_catalog,
Point(self.x, self.y),
self.k,
self.h,
starting_style,
)
rendered = context.render(*render_args)
# Let the catalog scan & register resources used by this drawing:
self._resource_catalog.index_stream_resources(rendered, self.page)
# Once we handle text-rendering SVG tags (cf. PR #1029),
# we should also detect fonts used and add them to the resource catalog
self._out(rendered)
# The drawing API makes use of features (notably transparency and blending modes) that were introduced in PDF 1.4:
self._set_min_pdf_version("1.4")
@contextmanager
@check_page
def use_pattern(self, shading: Gradient) -> Iterator[None]:
"""
Create a context for using a shading pattern on the current page.
"""
self._resource_catalog.add(PDFResourceType.SHADING, shading, self.page)
pattern = shading.get_pattern()
pattern_name = self._resource_catalog.add(
PDFResourceType.PATTERN, pattern, self.page
)
self._out(f"/Pattern cs /{pattern_name} scn")
try:
yield
finally:
assert self.draw_color is not None
self._out(self.draw_color.serialize().lower())
def _current_graphic_style(self) -> GraphicsStyle:
gs = GraphicsStyle()
gs.allow_transparency = self.allow_images_transparency
# This initial stroke_width is ignored when embedding SVGs,
# as the value in SVGObject.convert_graphics() takes precedence,
# so this probably creates an unnecessary PDF dict entry:
gs.stroke_width = self.line_width
if self.draw_color != self.DEFAULT_DRAW_COLOR:
gs.stroke_color = self.draw_color
if self.fill_color != self.DEFAULT_FILL_COLOR:
gs.fill_color = self.fill_color
dash_info = self.dash_pattern
dash_pattern: Optional[tuple[float, float]] = (
(dash_info["dash"], dash_info["gap"])
if dash_info["dash"] != 0 and dash_info["gap"] != 0
else None
)
gs.stroke_dash_pattern = dash_pattern
gs.stroke_dash_phase = dash_info["phase"]
return gs
@contextmanager
def new_path(
self,
x: float = 0,
y: float = 0,
paint_rule: PathPaintRule = PathPaintRule.AUTO,
debug_stream: Optional[bool] = None, # pylint: disable=unused-argument
) -> Iterator[PaintedPath]:
"""
Create a path for appending lines and curves to.
Args:
x (float): Abscissa of the path starting point
y (float): Ordinate of the path starting point
paint_rule (PathPaintRule): Optional choice of how the path should
be painted. The default (AUTO) automatically selects stroke/fill based
on the path style settings.
"""
with self.drawing_context() as ctxt:
path = PaintedPath(x=x, y=y)
path.style.paint_rule = paint_rule
yield path
ctxt.add_item(path)
def draw_path(
self,
path: GraphicsContext,
debug_stream: Optional[bool] = None, # pylint: disable=unused-argument
copy: bool = True,
) -> None:
"""
Add a pre-constructed path to the document.
Args:
path (drawing.PaintedPath): the path to be drawn.
copy (bool): if true (the default), the path will be copied before being
added. This prevents modifications to a referenced object from
"retroactively" altering its style/shape and should be disabled with
caution.
"""
with self.drawing_context() as ctxt:
ctxt.add_item(path, copy)
def set_dash_pattern(
self, dash: float = 0, gap: float = 0, phase: float = 0
) -> None:
"""
Set the current dash pattern for lines and curves.
Args:
dash (float): The length of the dashes in current units.
gap (float): The length of the gaps between dashes in current units.
If omitted, the dash length will be used.
phase (float): Where in the sequence to start drawing.
Omitting 'dash' (= 0) resets the pattern to a solid line.
"""
if not (isinstance(dash, (int, float)) and dash >= 0):
raise ValueError("Dash length must be zero or a positive number.")
if not (isinstance(gap, (int, float)) and gap >= 0):
raise ValueError("gap length must be zero or a positive number.")
if not (isinstance(phase, (int, float)) and phase >= 0):
raise ValueError("Phase must be zero or a positive number.")
pattern: dict[str, float] = dict(
dash=float(dash), gap=float(gap), phase=float(phase)
)
if pattern != self.dash_pattern:
self.dash_pattern = pattern
self._write_dash_pattern(dash, gap, phase)
def _write_dash_pattern(self, dash: float, gap: float, phase: float) -> None:
if dash:
if gap:
dstr = f"[{dash * self.k:.3f} {gap * self.k:.3f}] {phase *self.k:.3f} d"
else:
dstr = f"[{dash * self.k:.3f}] {phase *self.k:.3f} d"
else:
dstr = "[] 0 d"
self._out(dstr)
@contextmanager
def glyph_drawing_context(self) -> Iterator[DrawingContext]:
"""
Create a context for drawing paths for type 3 font glyphs, without writing on the current page.
"""
if self._current_draw_context is not None:
raise FPDFException(
"cannot create a drawing context while one is already open"
)
context = DrawingContext()
self._current_draw_context = context
try:
yield context
finally:
self._current_draw_context = None
self._set_min_pdf_version("1.4")
def draw_vector_glyph(
self, path: Union[PaintedPath, GraphicsContext], font: "Type3Font"
) -> str:
"""
Add a pre-constructed path to the document.
"""
output_stream: str = ""
with self.glyph_drawing_context() as ctxt:
ctxt.add_item(path)
starting_style = GraphicsStyle()
render_args = (
self._resource_catalog,
Point(0, 0),
1,
0,
starting_style,
)
output_stream = ctxt.render(*render_args)
# Registering raster images embedded in the vector graphics:
for resource_type, resource_id in self._resource_catalog.scan_stream(
output_stream
):
if resource_type == PDFResourceType.X_OBJECT:
font.images_used.add(int(resource_id))
if resource_type == PDFResourceType.EXT_G_STATE:
font.graphics_style_used.add(resource_id)
if resource_type == PDFResourceType.PATTERN:
font.patterns_used.add(resource_id)
return output_stream
@check_page
def line(self, x1: float, y1: float, x2: float, y2: float) -> None:
"""
Draw a line between two points.
Args:
x1 (float): Abscissa of first point
y1 (float): Ordinate of first point
x2 (float): Abscissa of second point
y2 (float): Ordinate of second point
"""
self._out(
f"{x1 * self.k:.2f} {(self.h - y1) * self.k:.2f} m {x2 * self.k:.2f} "
f"{(self.h - y2) * self.k:.2f} l S"
)
@check_page
def polyline(
self,
point_list: Sequence[tuple[float, float]],
fill: bool = False,
polygon: bool = False,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Draws lines between two or more points.
Args:
point_list (list of tuples): List of Abscissa and Ordinate of
segments that should be drawn
fill (bool): [**DEPRECATED since v2.5.4**] Use `style="F"` or `style="DF"` instead
polygon (bool): If true, close path before stroking, to fill the inside of the polyline
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Possible values are:
* `D` or None: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
if fill:
warnings.warn(
(
'"fill" parameter is deprecated since v2.5.4, '
'use style="F" or style="DF" instead'
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
if fill and style is None:
style = RenderStyle.DF
else:
style = RenderStyle.coerce(style) if style is not None else RenderStyle.D
if fill and style == RenderStyle.D:
raise ValueError(
f"Conflicting values provided: fill={fill} & style={style}"
)
operator = "m"
for point in point_list:
self._out(
f"{point[0] * self.k:.2f} {(self.h - point[1]) * self.k:.2f} {operator}"
)
operator = "l"
if polygon:
self._out(" h")
self._out(f" {style.operator}")
@check_page
def polygon(
self,
point_list: Sequence[tuple[float, float]],
fill: bool = False,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs a polygon defined by three or more points.
Args:
point_list (list of tuples): List of coordinates defining the polygon to draw
fill (bool): [**DEPRECATED since v2.5.4**] Use `style="F"` or `style="DF"` instead
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Possible values are:
* `D` or None: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
self.polyline(point_list, fill=fill, polygon=True, style=style)
@check_page
def dashed_line(
self,
x1: float,
y1: float,
x2: float,
y2: float,
dash_length: float = 1,
space_length: float = 1,
) -> None:
"""
Draw a dashed line between two points.
Args:
x1 (float): Abscissa of first point
y1 (float): Ordinate of first point
x2 (float): Abscissa of second point
y2 (float): Ordinate of second point
dash_length (float): Length of the dash
space_length (float): Length of the space between 2 dashes
.. deprecated:: 2.4.6
Use `FPDF.set_dash_pattern()` and the normal drawing operations instead.
"""
warnings.warn(
(
"dashed_line() is deprecated since v2.4.6, "
"and will be removed in a future release. "
"Use set_dash_pattern() and the normal drawing operations instead."
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
self.set_dash_pattern(dash_length, space_length)
self.line(x1, y1, x2, y2)
self.set_dash_pattern()
@check_page
def rect(
self,
x: float,
y: float,
w: float,
h: float,
style: Optional[RenderStyle | str] = None,
round_corners: bool = False,
corner_radius: float = 0,
) -> None:
"""
Outputs a rectangle.
It can be drawn (border only), filled (with no border) or both.
Args:
x (float): Abscissa of upper-left bounding box.
y (float): Ordinate of upper-left bounding box.
w (float): Width.
h (float): Height.
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Possible values are:
* `D` or empty string: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
round_corners (tuple of str, tuple of fpdf.enums.Corner, bool): Optional draw a rectangle with round corners.
Possible values are:
*`TOP_LEFT`: a rectangle with round top left corner
*`TOP_RIGHT`: a rectangle with round top right corner
*`BOTTOM_LEFT`: a rectangle with round bottom left corner
*`BOTTOM_RIGHT`: a rectangle with round bottom right corner
*`True`: a rectangle with all round corners
*`False`: a rectangle with no round corners
corner_radius: Optional radius of the corners
"""
style = RenderStyle.coerce(style) if style is not None else RenderStyle.D
if round_corners is not False:
self._draw_rounded_rect(x, y, w, h, style, round_corners, corner_radius)
else:
self._out(
f"{x * self.k:.2f} {(self.h - y) * self.k:.2f} {w * self.k:.2f} "
f"{-h * self.k:.2f} re {style.operator}"
)
def _draw_rounded_rect(
self,
x: float,
y: float,
w: float,
h: float,
style: RenderStyle,
round_corners: bool | tuple[Corner | str, ...],
r: float,
) -> None:
min = h
if w < h:
min = w
if r == 0:
r = min / 5
if r >= min / 2:
r /= min
# Calculate corner points
point_1 = point_8 = (x, y)
point_2 = (x + w, y)
point_4 = (x + w, y + h)
point_6 = (x, y + h)
if round_corners is True:
round_corners = (
Corner.TOP_RIGHT.value,
Corner.TOP_LEFT.value,
Corner.BOTTOM_RIGHT.value,
Corner.BOTTOM_LEFT.value,
)
assert not isinstance(round_corners, bool)
round_corners_list: tuple[Corner, ...] = tuple(
Corner.coerce(rc) for rc in round_corners
)
# Update points based on which corners are rounded
if Corner.TOP_RIGHT in round_corners_list:
point_1 = (x + r, y)
point_8 = (x, y + r)
if Corner.TOP_LEFT in round_corners_list:
point_2 = (x + w - r, y)
_point_3 = (x + w, y + r)
if Corner.BOTTOM_LEFT in round_corners_list:
point_4 = (x + w, y + h - r)
_point_5 = (x + w - r, y + h)
if Corner.BOTTOM_RIGHT in round_corners_list:
point_6 = (x + r, y + h)
_point_7 = (x, y + h - r)
# Build a single continuous path
# Start at point_1
self._out(f"{point_1[0] * self.k:.2f} {(self.h - point_1[1]) * self.k:.2f} m")
# Top edge: point_1 to point_2
self._out(f"{point_2[0] * self.k:.2f} {(self.h - point_2[1]) * self.k:.2f} l")
# Top-left corner arc
if Corner.TOP_LEFT in round_corners_list:
self._draw_arc_segment(x + w - 2 * r, y, 2 * r, 270, 0)
# Right edge: point_3 to point_4
self._out(f"{point_4[0] * self.k:.2f} {(self.h - point_4[1]) * self.k:.2f} l")
# Bottom-left corner arc
if Corner.BOTTOM_LEFT in round_corners_list:
self._draw_arc_segment(x + w - 2 * r, y + h - 2 * r, 2 * r, 0, 90)
# Bottom edge: point_5 to point_6
self._out(f"{point_6[0] * self.k:.2f} {(self.h - point_6[1]) * self.k:.2f} l")
# Bottom-right corner arc
if Corner.BOTTOM_RIGHT in round_corners_list:
self._draw_arc_segment(x, y + h - 2 * r, 2 * r, 90, 180)
# Left edge: point_7 to point_8
self._out(f"{point_8[0] * self.k:.2f} {(self.h - point_8[1]) * self.k:.2f} l")
# Top-right corner arc
if Corner.TOP_RIGHT in round_corners_list:
self._draw_arc_segment(x, y, 2 * r, 180, 270)
# Close path and apply style
self._out(f"h {style.operator}")
def _draw_arc_segment(
self,
x: float,
y: float,
a: float,
start_angle: float,
end_angle: float,
b: Optional[float] = None,
) -> None:
"""
Draw an arc segment as part of an existing path (no move, no style application).
Used internally for building complex shapes like rounded rectangles.
"""
if b is None:
b = a
a /= 2
b /= 2
cx = x + a
cy = y + b
def deg_to_rad(deg: float) -> float:
return deg * math.pi / 180
def angle_to_param(angle: float) -> float:
angle = deg_to_rad(angle % 360)
eta = math.atan2(math.sin(angle) / b, math.cos(angle) / a)
if eta < 0:
eta += 2 * math.pi
return eta
def evaluate(eta: float) -> list[float]:
a_cos_eta = a * math.cos(eta)
b_sin_eta = b * math.sin(eta)
return [cx + a_cos_eta, cy + b_sin_eta]
def derivative_evaluate(eta: float) -> list[float]:
a_sin_eta = a * math.sin(eta)
b_cos_eta = b * math.cos(eta)
return [-a_sin_eta, b_cos_eta]
start_eta = angle_to_param(start_angle)
end_eta = angle_to_param(end_angle)
if end_eta <= start_eta:
end_eta += 2 * math.pi
max_curves = 4
n = min(
max_curves, math.ceil(abs(end_eta - start_eta) / (2 * math.pi / max_curves))
)
d_eta = (end_eta - start_eta) / n
alpha = math.sin(d_eta) * (math.sqrt(4 + 3 * math.tan(d_eta / 2) ** 2) - 1) / 3
eta2 = start_eta
p2 = evaluate(eta2)
p2_prime = derivative_evaluate(eta2)
for _ in range(n):
p1 = p2
p1_prime = p2_prime
eta2 += d_eta
p2 = evaluate(eta2)
p2_prime = derivative_evaluate(eta2)
control_point_1 = [p1[0] + alpha * p1_prime[0], p1[1] + alpha * p1_prime[1]]
control_point_2 = [p2[0] - alpha * p2_prime[0], p2[1] - alpha * p2_prime[1]]
self._out(
f"{control_point_1[0] * self.k:.2f} {(self.h - control_point_1[1]) * self.k:.2f} "
f"{control_point_2[0] * self.k:.2f} {(self.h - control_point_2[1]) * self.k:.2f} "
f"{p2[0] * self.k:.2f} {(self.h - p2[1]) * self.k:.2f} c"
)
@check_page
def ellipse(
self,
x: float,
y: float,
w: float,
h: float,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs an ellipse.
It can be drawn (border only), filled (with no border) or both.
Args:
x (float): Abscissa of upper-left bounding box.
y (float): Ordinate of upper-left bounding box.
w (float): Width
h (float): Height
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Possible values are:
* `D` or empty string: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
style = RenderStyle.coerce(style) if style is not None else RenderStyle.D
self._draw_ellipse(x, y, w, h, style.operator)
def _draw_ellipse(
self, x: float, y: float, w: float, h: float, operator: str
) -> None:
cx = x + w / 2
cy = y + h / 2
rx = w / 2
ry = h / 2
lx = 4 / 3 * (math.sqrt(2) - 1) * rx
ly = 4 / 3 * (math.sqrt(2) - 1) * ry
self._out(
(
f"{(cx + rx) * self.k:.2f} {(self.h - cy) * self.k:.2f} m "
f"{(cx + rx) * self.k:.2f} {(self.h - cy + ly) * self.k:.2f} "
f"{(cx + lx) * self.k:.2f} {(self.h - cy + ry) * self.k:.2f} "
f"{cx * self.k:.2f} {(self.h - cy + ry) * self.k:.2f} c"
)
)
self._out(
(
f"{(cx - lx) * self.k:.2f} {(self.h - cy + ry) * self.k:.2f} "
f"{(cx - rx) * self.k:.2f} {(self.h - cy + ly) * self.k:.2f} "
f"{(cx - rx) * self.k:.2f} {(self.h - cy) * self.k:.2f} c"
)
)
self._out(
(
f"{(cx - rx) * self.k:.2f} {(self.h - cy - ly) * self.k:.2f} "
f"{(cx - lx) * self.k:.2f} {(self.h - cy - ry) * self.k:.2f} "
f"{cx * self.k:.2f} {(self.h - cy - ry) * self.k:.2f} c"
)
)
self._out(
(
f"{(cx + lx) * self.k:.2f} {(self.h - cy - ry) * self.k:.2f} "
f"{(cx + rx) * self.k:.2f} {(self.h - cy - ly) * self.k:.2f} "
f"{(cx + rx) * self.k:.2f} {(self.h - cy) * self.k:.2f} c {operator}"
)
)
@check_page
def circle(
self,
x: float,
y: float,
radius: float,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs a circle.
It can be drawn (border only), filled (with no border) or both.
WARNING: This method changed parameters in [release 2.8.1](https://github.com/py-pdf/fpdf2/releases/tag/2.8.1)
Args:
x (float): Abscissa of upper-left bounding box.
y (float): Ordinate of upper-left bounding box.
radius (float): Radius of the circle.
style (str): Style of rendering. Possible values are:
* `D` or None: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
self.ellipse(x - radius, y - radius, 2 * radius, 2 * radius, style)
@check_page
def regular_polygon(
self,
x: float,
y: float,
numSides: int,
polyWidth: float,
rotateDegrees: float = 0,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs a regular polygon with n sides
It can be rotated
Style can also be applied (fill, border...)
Args:
x (float): Abscissa of upper-left bounding box.
y (float): Ordinate of upper-left bounding box.
numSides (int): Number of sides for polygon.
polyWidth (float): Width of the polygon.
rotateDegrees (float): Optional degree amount to rotate polygon.
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Possible values are:
* `D` or None: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
radius = polyWidth / 2
centerX = x + radius
centerY = y - radius
# center point is (centerX, centerY)
points: list[tuple[float, float]] = []
for i in range(1, numSides + 1):
point = centerX + radius * math.cos(
math.radians((360 / numSides) * i) + math.radians(rotateDegrees)
), centerY + radius * math.sin(
math.radians((360 / numSides) * i) + math.radians(rotateDegrees)
)
points.append(point)
# creates list of tuples containing coordinate points of vertices
self.polygon(points, style=style)
# passes points through polygon function
@check_page
def star(
self,
x: float,
y: float,
r_in: float,
r_out: float,
corners: int,
rotate_degrees: float = 0,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs a regular star with n corners.
It can be rotated.
It can be drawn (border only), filled (with no border) or both.
Args:
x (float): Abscissa of star's centre.
y (float): Ordinate of star's centre.
r_in (float): radius of internal circle.
r_out (float): radius of external circle.
corners (int): number of star's corners.
rotate_degrees (float): Optional degree amount to rotate star clockwise.
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Possible values are:
* `D`: draw border. This is the default value.
* `F`: fill.
* `DF` or `FD`: draw and fill.
"""
th = math.radians(rotate_degrees)
point_list: list[tuple[float, float]] = []
for i in range(0, (corners * 2) + 1):
corner_x = x + (r_out if i % 2 == 0 else r_in) * math.sin(th)
corner_y = y + (r_out if i % 2 == 0 else r_in) * math.cos(th)
point_list.append((corner_x, corner_y))
th += math.radians(180 / corners)
self.polyline(point_list, polygon=True, style=style)
@check_page
def arc(
self,
x: float,
y: float,
a: float,
start_angle: float,
end_angle: float,
b: Optional[float] = None,
inclination: float = 0,
clockwise: bool = False,
start_from_center: bool = False,
end_at_center: bool = False,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs an arc.
It can be drawn (border only), filled (with no border) or both.
Args:
x (float): Abscissa of upper-left corner of the bounding box of the full ellipse.
y (float): Ordinate of upper-left corner of the bounding box of the full ellipse.
a (float): Major axis diameter (width of bounding box).
b (float): Minor axis diameter (height of bounding box), if None, equals to a (default: None).
start_angle (float): Start angle of the arc (in degrees).
end_angle (float): End angle of the arc (in degrees).
inclination (float): Inclination of the arc in respect of the x-axis (default: 0).
clockwise (bool): Way of drawing the arc (True: clockwise, False: counterclockwise) (default: False).
start_from_center (bool): Start drawing from the center of the ellipse (default: False).
end_at_center (bool): End drawing at the center of the ellipse (default: False).
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Allowed values are:
* `D` or None: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
style = RenderStyle.coerce(style) if style is not None else RenderStyle.D
if b is None:
b = a
a /= 2
b /= 2
cx = x + a
cy = y + b
# Functions used only to construct other points of the bezier curve
def deg_to_rad(deg: float) -> float:
return deg * math.pi / 180
def angle_to_param(angle: float) -> float:
angle = deg_to_rad(angle % 360)
eta = math.atan2(math.sin(angle) / b, math.cos(angle) / a)
if eta < 0:
eta += 2 * math.pi
return eta
theta = deg_to_rad(inclination)
cos_theta = math.cos(theta)
sin_theta = math.sin(theta)
def evaluate(eta: float) -> list[float]:
a_cos_eta = a * math.cos(eta)
b_sin_eta = b * math.sin(eta)
return [
cx + a_cos_eta * cos_theta - b_sin_eta * sin_theta,
cy + a_cos_eta * sin_theta + b_sin_eta * cos_theta,
]
def derivative_evaluate(eta: float) -> list[float]:
a_sin_eta = a * math.sin(eta)
b_cos_eta = b * math.cos(eta)
return [
-a_sin_eta * cos_theta - b_cos_eta * sin_theta,
-a_sin_eta * sin_theta + b_cos_eta * cos_theta,
]
# Calculating start_eta and end_eta so that
# start_eta < end_eta <= start_eta + 2*PI if counterclockwise
# end_eta < start_eta <= end_eta + 2*PI if clockwise
start_eta = angle_to_param(start_angle)
end_eta = angle_to_param(end_angle)
if not clockwise and end_eta <= start_eta:
end_eta += 2 * math.pi
elif clockwise and end_eta >= start_eta:
start_eta += 2 * math.pi
start_point = evaluate(start_eta)
# Move to the start point
if start_from_center:
self._out(f"{cx * self.k:.2f} {(self.h - cy) * self.k:.2f} m")
self._out(
f"{start_point[0] * self.k:.2f} {(self.h - start_point[1]) * self.k:.2f} l"
)
else:
self._out(
f"{start_point[0] * self.k:.2f} {(self.h - start_point[1]) * self.k:.2f} m"
)
# Number of curves to use, maximal segment angle is 2*PI/max_curves
max_curves = 4
n = min(
max_curves, math.ceil(abs(end_eta - start_eta) / (2 * math.pi / max_curves))
)
d_eta = (end_eta - start_eta) / n
alpha = math.sin(d_eta) * (math.sqrt(4 + 3 * math.tan(d_eta / 2) ** 2) - 1) / 3
eta2 = start_eta
p2 = evaluate(eta2)
p2_prime = derivative_evaluate(eta2)
for i in range(n):
p1 = p2
p1_prime = p2_prime
eta2 += d_eta
p2 = evaluate(eta2)
p2_prime = derivative_evaluate(eta2)
control_point_1 = [p1[0] + alpha * p1_prime[0], p1[1] + alpha * p1_prime[1]]
control_point_2 = [p2[0] - alpha * p2_prime[0], p2[1] - alpha * p2_prime[1]]
end = ""
if i == n - 1 and not end_at_center:
end = f" {style.operator}"
self._out(
(
f"{control_point_1[0] * self.k:.2f} {(self.h - control_point_1[1]) * self.k:.2f} "
f"{control_point_2[0] * self.k:.2f} {(self.h - control_point_2[1]) * self.k:.2f} "
f"{p2[0] * self.k:.2f} {(self.h - p2[1]) * self.k:.2f} c" + end
)
)
if end_at_center:
if start_from_center:
self._out(f"h {style.operator}")
else:
self._out(
f"{cx * self.k:.2f} {(self.h - cy) * self.k:.2f} l {style.operator}"
)
def solid_arc(
self,
x: float,
y: float,
a: float,
start_angle: float,
end_angle: float,
b: Optional[float] = None,
inclination: float = 0,
clockwise: bool = False,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs a solid arc. A solid arc combines an arc and a triangle to form a pie slice
It can be drawn (border only), filled (with no border) or both.
Args:
x (float): Abscissa of upper-left bounding box.
y (float): Ordinate of upper-left bounding box.
a (float): Semi-major axis.
b (float): Semi-minor axis, if None, equals to a (default: None).
start_angle (float): Start angle of the arc (in degrees).
end_angle (float): End angle of the arc (in degrees).
inclination (float): Inclination of the arc in respect of the x-axis (default: 0).
clockwise (bool): Way of drawing the arc (True: clockwise, False: counterclockwise) (default: False).
style (str): Style of rendering. Possible values are:
* `D` or None: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
self.arc(
x,
y,
a,
start_angle,
end_angle,
b,
inclination,
clockwise,
True,
True,
style,
)
def bezier(
self,
point_list: Sequence[tuple[float, float]],
closed: bool = False,
style: Optional[RenderStyle | str] = None,
) -> None:
"""
Outputs a quadratic or cubic Bézier curve, defined by three or four coordinates.
Args:
point_list (list of tuples): List of Abscissa and Ordinate of
segments that should be drawn. Should be
three or four tuples. The first and last
points are the start and end point. The
middle point(s) are the control point(s).
closed (bool): True to draw the curve as a closed path, False (default)
for it to be drawn as an open path.
style (fpdf.enums.RenderStyle, str): Optional style of rendering. Allowed values are:
* `D` or None: draw border. This is the default value.
* `F`: fill
* `DF` or `FD`: draw and fill
"""
points = len(point_list)
if points not in (3, 4):
raise ValueError(
"point_list should contain 3 tuples for a quadratic curve"
" or 4 tuples for a cubic curve."
)
style = RenderStyle.coerce(style) if style is not None else RenderStyle.D
# QuadraticBezierCurve and BezierCurve make use of `initial_point` when instantiated.
# If we want to define all 3 (quad.) or 4 (cubic) points, we can set `initial_point`
# to be the first point given in `point_list` by creating a separate dummy path at that pos.
with self.drawing_context() as ctxt:
p1 = point_list[0]
x1, y1 = p1[0], p1[1]
dummy_path = PaintedPath(x1, y1)
ctxt.add_item(dummy_path)
p2 = point_list[1]
x2, y2 = p2[0], p2[1]
p3 = point_list[2]
x3, y3 = p3[0], p3[1]
if points == 4:
p4 = point_list[3]
x4, y4 = p4[0], p4[1]
path = PaintedPath(x1, y1)
# Translate enum style (RenderStyle) into rule (PathPaintRule)
rule = PathPaintRule.STROKE_FILL_NONZERO
if style.is_draw and not style.is_fill:
rule = PathPaintRule.STROKE
elif style.is_fill and not style.is_draw:
rule = PathPaintRule.FILL_NONZERO
path.style.paint_rule = rule
path.style.auto_close = closed
if points == 4:
path.curve_to(
x2,
y2,
x3,
y3,
x4, # pyright: ignore[reportPossiblyUnboundVariable]
y4, # pyright: ignore[reportPossiblyUnboundVariable]
)
elif points == 3:
path.curve_to(x2, y2, x2, y2, x3, y3)
ctxt.add_item(path)
@deprecated_parameter([("uni", "2.5.1")])
def add_font(
self,
family: Optional[str] = None,
style: str = "",
fname: Optional[str | PurePath] = None,
*,
unicode_range: Optional[str | Sequence[str | int | tuple[int, int]]] = None,
variations: Optional[dict[str, dict[str, float]] | dict[str, float]] = None,
palette: Optional[int] = None,
collection_font_number: int = 0,
) -> None:
"""
Imports a TrueType or OpenType font and makes it available
for later calls to the `FPDF.set_font()` method.
You will find more information on the "Unicode" documentation page.
Args:
family (str): optional name of the font family. Used as a reference for `FPDF.set_font()`.
If not provided, use the base name of the `fname` font path, without extension.
style (str): font style. "" for regular, include 'B' for bold, and/or 'I' for italic.
fname (str): font file name. You can specify a relative or full path.
If the file is not found, it will be searched in `FPDF_FONT_DIR`.
unicode_range (Optional[Union[str, int, tuple, list]]): subset of Unicode codepoints to embed.
Accepts CSS-style strings (e.g. "U+1F600-1F64F, U+2600"), integers, tuples, or lists.
Defaults to None, which embeds the full cmap.
variations (dict[style, dict]): maps style to limits of axes for the variable font.
palette (int): optional palette index for color fonts (COLR/CPAL). Defaults to 0 (first palette).
Only applicable to fonts with CPAL table (color fonts).
collection_font_number (int): face index for TTC/OTC collections.
"""
if not fname:
raise ValueError('"fname" parameter is required')
ext = splitext(str(fname))[1].lower()
if ext not in (".otb", ".otf", ".otc", ".ttf", ".ttc", ".woff", ".woff2"):
raise ValueError(
f"Unsupported font file extension: {ext}."
" add_font() used to accept .pkl file as input, but for security reasons"
" this feature is deprecated since v2.5.1 and has been removed in v2.5.3."
)
for parent in (Path("."), FPDF_FONT_DIR):
if (parent / fname).exists():
font_file_path = parent / fname
break
else:
raise FileNotFoundError(f"TTF Font file not found: {fname}")
if family is None:
family = font_file_path.stem
parsed_unicode_range = None
if unicode_range is not None:
parsed_unicode_range = get_parsed_unicode_range(unicode_range)
style = "".join(sorted(style.upper()))
if any(letter not in "BI" for letter in style):
raise ValueError(
f"Unknown style provided (only B & I letters are allowed): {style}"
)
# Handle variable font.
if variations is not None:
if not isinstance(variations, dict):
raise TypeError("Variations, if specified, must be a dictionary")
# Check variations dictionary
if all(
key.upper() in ("", "B", "I", "BI") and isinstance(value, dict)
for key, value in variations.items()
):
for var_style, axes_dict in variations.items():
self.add_font(
family=family,
style=var_style,
fname=fname,
unicode_range=unicode_range,
variations=axes_dict, # type: ignore[arg-type]
palette=palette,
collection_font_number=collection_font_number,
)
return
fontkey = f"{family.lower()}{style}"
if fontkey in self.fonts or fontkey in CORE_FONTS:
warnings.warn(
f"Core font or font already added '{fontkey}': doing nothing",
stacklevel=get_stack_level(),
)
return
font_obj = TTFFont(
self,
font_file_path,
fontkey,
style,
parsed_unicode_range,
variations, # type: ignore[arg-type]
palette,
collection_font_number,
)
self.fonts[fontkey] = font_obj
if font_obj.is_cff and font_obj.is_cid_keyed:
self._set_min_pdf_version("1.6")
def set_font(
self,
family: Optional[str] = None,
style: Union[str, TextEmphasis] = "",
size: float = 0,
) -> None:
"""
Sets the font used to print character strings.
It is mandatory to call this method at least once before printing text.
Default encoding is not specified, but all text writing methods accept only
unicode for external fonts and one byte encoding for standard.
Standard fonts use `Latin-1` encoding by default, but Windows
encoding `cp1252` (Western Europe) can be used with
`self.core_fonts_encoding = encoding`.
The font specified is retained from page to page.
The method can be called before the first page is created.
Args:
family (str): name of a font added with `FPDF.add_font`,
or name of one of the 14 standard "PostScript" fonts:
Courier (fixed-width), Helvetica (sans serif), Times (serif),
Symbol (symbolic) or ZapfDingbats (symbolic)
If an empty string is provided, the current family is retained.
style (str, fpdf.enums.TextEmphasis): empty string (by default) or a combination
of one or several letters among B (bold), I (italic), S (strikethrough) and U (underline).
Bold and italic styles do not apply to Symbol and ZapfDingbats fonts.
size (float): in points. The default value is the current size.
"""
if not family:
family = self.font_family
family = family.lower()
if isinstance(style, TextEmphasis):
style = style.style
style = "".join(sorted(style.upper()))
if any(letter not in "BISU" for letter in style):
raise ValueError(
f"Unknown style provided (only B/I/S/U letters are allowed): {style}"
)
if "U" in style:
self.underline = True
style = style.replace("U", "")
else:
self.underline = False
if "S" in style:
self.strikethrough = True
style = style.replace("S", "")
else:
self.strikethrough = False
if family in self.font_aliases and family + style not in self.fonts:
warnings.warn(
f"Substituting font {family} by core font {self.font_aliases[family]}"
" - This is deprecated since v2.7.8, and will soon be removed",
DeprecationWarning,
stacklevel=get_stack_level(),
)
family = self.font_aliases[family]
elif family in ("symbol", "zapfdingbats") and style:
warnings.warn(
f"Built-in font {family} only has a single 'style' "
"and can't be bold or italic",
stacklevel=get_stack_level(),
)
style = ""
if not size:
size = self.font_size_pt
# Test if font is already selected
if (
self.font_family == family
and self.font_style == style
and FloatTolerance.equal(self.font_size_pt, size)
):
return
# Test if used for the first time
fontkey = family + style
if fontkey not in self.fonts:
if fontkey not in CORE_FONTS:
raise FPDFException(
f"Undefined font: {fontkey} - "
f"Use built-in fonts or FPDF.add_font() beforehand"
)
# If it's one of the core fonts, add it to self.fonts
if self._compliance and self._compliance.profile == "PDFA":
raise PDFAComplianceError(
f"Usage of base fonts is now allowed for documents compliant with {self._compliance.label}. Use add_font() to embed a font file"
)
self.fonts[fontkey] = CoreFont(len(self.fonts) + 1, fontkey, style)
# Select it
self.font_family = family
self.font_style = style
self.font_size_pt = size
self.current_font = self.fonts[fontkey]
self.current_font_is_set_on_page = False
def set_font_size(self, size: float) -> None:
"""
Configure the font size in points
Args:
size (float): font size in points
"""
if FloatTolerance.equal(self.font_size_pt, size):
return
self.font_size_pt = size
self.current_font_is_set_on_page = False
def _set_font_for_page(
self,
font: CoreFont | TTFFont,
font_size_pt: float,
wrap_in_text_object: bool = True,
) -> str:
"""
Set font and size for current page.
This step is needed before adding text into page and not needed in set_font and set_font_size.
"""
sl = f"/F{font.i} {font_size_pt:.2f} Tf"
if wrap_in_text_object:
sl = f"BT {sl} ET"
self._resource_catalog.add(PDFResourceType.FONT, font.i, self.page)
self.current_font_is_set_on_page = True
return sl
def set_char_spacing(self, spacing: float) -> None:
"""
Sets horizontal character spacing.
A positive value increases the space between characters, a negative value
reduces it (which may result in glyph overlap).
By default, no spacing is set (which is equivalent to a value of 0).
Args:
spacing (float): horizontal spacing in document units
"""
if self.char_spacing == spacing:
return
self.char_spacing = spacing
if self.page > 0:
self._out(f"BT {spacing:.2f} Tc ET")
def set_stretching(self, stretching: float) -> None:
"""
Sets horizontal font stretching.
By default, no stretching is set (which is equivalent to a value of 100).
Args:
stretching (float): horizontal stretching (scaling) in percents.
"""
if self.font_stretching == stretching:
return
self.font_stretching = stretching
if self.page > 0:
self._out(f"BT {stretching:.2f} Tz ET")
def set_fallback_fonts(
self, fallback_fonts: Sequence[str], exact_match: bool = True
) -> None:
"""
Allows you to specify a list of fonts to be used if any character is not available on the font currently set.
Detailed documentation: https://py-pdf.github.io/fpdf2/Unicode.html#fallback-fonts
Args:
fallback_fonts: sequence of fallback font IDs
exact_match (bool): when a glyph cannot be rendered uing the current font,
fpdf2 will look for a fallback font matching the current character emphasis (bold/italics).
If it does not find such matching font, and `exact_match` is True, no fallback font will be used.
If it does not find such matching font, and `exact_match` is False, a fallback font will still be used.
To get even more control over this logic, you can also override `FPDF.get_fallback_font()`
"""
fallback_font_ids: list[str] = []
for fallback_font in fallback_fonts:
found = False
for fontkey in self.fonts:
# will add all font styles on the same family
if fontkey.replace("B", "").replace("I", "") == fallback_font.lower():
if fontkey not in fallback_font_ids:
fallback_font_ids.append(fontkey)
found = True
if not found:
raise FPDFException(
f"Undefined fallback font: {fallback_font} - Use FPDF.add_font() beforehand"
)
self._fallback_font_ids = fallback_font_ids
self._fallback_font_exact_match = exact_match
def add_link(
self,
y: float = 0,
x: float = 0,
page: int = -1,
zoom: str | float = "null",
name: Optional[str] = None,
) -> int:
"""
Creates a new internal link and returns its identifier.
An internal link is a clickable area which directs to another place within the document.
The identifier can then be passed to the `FPDF.cell()`, `FPDF.write()`, `FPDF.image()`
or `FPDF.link()` methods.
If a name is provided, creates a named destination that can be referenced later.
Named destinations are more stable than plain links when pages are added or removed.
Args:
y (float): optional ordinate of target position.
The default value is 0 (top of page).
x (float): optional abscissa of target position.
The default value is 0 (top of page).
page (int): optional number of target page.
-1 indicates the current page, which is the default value.
zoom (float): optional new zoom level after following the link.
Currently ignored by Sumatra PDF Reader, but observed by Adobe Acrobat reader.
name (str, optional): Name for the destination. If provided, creates a named
destination in the PDF that can be referenced from other parts of the document
or from external documents.
"""
# Create destination
link = DestinationXYZ(
self.page if page == -1 else page,
top=self.h_pt - y * self.k,
left=x * self.k,
zoom=zoom,
)
# Handle named destinations
if name is not None:
if not name or name.isspace():
raise ValueError("Destination name cannot be empty or whitespace")
self.named_destinations[name] = link
# Store link and return index
link_index = len(self.links) + 1
self.links[link_index] = link
return link_index
def get_named_destination(self, name: str) -> str:
"""
Retrieves a named destination by its name and creates a link to it.
Args:
name (str): The name of the destination to retrieve.
Returns:
str: A string with format "#name" that can be used with cell(), write(), image(), or link()
Raises:
KeyError: If no destination exists with the given name
"""
if name not in self.named_destinations:
# Create a placeholder named destination pointing to page 0
# This will be caught during output if never set properly
self.named_destinations[name] = DestinationXYZ(0, top=self.h_pt * self.k)
# Return the name prefixed with # to indicate it's a named destination
# This way, the link() method will use the named destination string
return f"#{name}"
def set_link(
self,
link: Optional[int] = None,
y: float = 0,
x: float = 0,
page: int = -1,
zoom: float | str = "null",
name: Optional[str] = None,
) -> DestinationXYZ | str:
"""
Defines the page and position a link points to.
Args:
link (int, optional): a link identifier returned by `FPDF.add_link()`.
If None and name is provided, will create or update a named destination.
y (float): optional ordinate of target position.
The default value is 0 (top of page).
x (float): optional abscissa of target position.
The default value is 0 (top of page).
page (int): optional number of target page.
-1 indicates the current page, which is the default value.
zoom (float): optional new zoom level after following the link.
Currently ignored by Sumatra PDF Reader, but observed by Adobe Acrobat reader.
name (str, optional): Name for the destination. If provided, creates or updates a named
destination in the PDF that can be referenced from other parts of the document
or from external documents.
"""
# Handle named destination case
if name and link is None:
# Create the destination
dest = DestinationXYZ(
self.page if page == -1 else page,
top=self.h_pt - y * self.k,
left=x * self.k,
zoom=zoom,
)
# Store it in the named destinations dictionary
self.named_destinations[name] = dest
# Return the name for reference
return name
# Regular link handling (backward compatibility)
# We must take care to update the existing DestinationXYZ,
# and NOT re-assign self.links[link] to a new instance,
# as a reference to self.links[link] is kept in self.pages[].annots:
assert link is not None
destination = self.links[link]
destination.page_number = self.page if page == -1 else page
destination.top = self.h_pt - y * self.k
destination.left = x * self.k
destination.zoom = zoom
# If a name is provided with an existing link, associate the name with this link
if name:
self.named_destinations[name] = destination
return name
# Return link index for backward compatibility
return destination
def link(
self,
x: float,
y: float,
w: float,
h: float,
link: str | int,
alt_text: Optional[str] = None,
**kwargs: Any,
) -> AnnotationDict:
"""
Puts a link annotation on a rectangular area of the page.
Text or image links are generally put via `FPDF.cell`,
`FPDF.write` or `FPDF.image`,
but this method can be useful for instance to define a clickable area inside an image.
Args:
x (float): horizontal position (from the left) to the left side of the link rectangle
y (float): vertical position (from the top) to the bottom side of the link rectangle
w (float): width of the link rectangle
h (float): height of the link rectangle
link: can be one of the following:
- a URL string to create an external link
- an integer returned by `FPDF.add_link`, defining an internal link to a page
- a named destination string prefixed with '#' (e.g., '#chapter1')
alt_text (str): optional textual description of the link, for accessibility purposes
border_width (int): thickness of an optional black border surrounding the link.
Not all PDF readers honor this: Acrobat renders it but not Sumatra.
"""
action: Optional[URIAction] = None
dest: Optional[PDFString | DestinationXYZ] = None
if link:
if isinstance(link, str):
# Check if this is a named destination (prefixed with '#')
if link.startswith("#"):
dest_name = link[1:] # Remove the '#' prefix
# If the named destination doesn't exist yet, create a placeholder
# destination pointing to page 0 (which doesn't exist)
# This will be caught during output if never set properly
if dest_name not in self.named_destinations:
self.named_destinations[dest_name] = DestinationXYZ(
0, top=self.h_pt * self.k
)
# Use destination name instead of destination object for named destinations
dest = PDFString(dest_name, encrypt=True)
else:
# Regular URL
action = URIAction(link)
else: # Dest type ending of annotation entry
assert (
link in self.links
), f"Link with an invalid index: {link} (doc #links={len(self.links)})"
dest = self.links[link]
if not dest.page_number:
raise ValueError(
f"Cannot insert link {link} with no page number assigned"
)
link_annot = AnnotationDict(
"Link",
x=x * self.k,
y=self.h_pt - y * self.k,
width=w * self.k,
height=h * self.k,
action=action,
dest=dest,
**kwargs,
)
self.pages[self.page].add_annotation(link_annot)
if alt_text is not None:
# Note: the spec indicates that a /StructParent could be added **inside* this /Annot,
# but tests with Adobe Acrobat Reader reveal that the page /StructParents inserted below
# is enough to link the marked content in the hierarchy tree with this annotation link.
self._add_marked_content(struct_type="/Link", alt_text=alt_text)
return link_annot
def embed_file(
self,
file_path: Optional[Union[str, Path]] = None,
bytes: Optional[bytes] = None,
basename: Optional[str] = None,
modification_date: Optional[datetime] = None,
mime_type: Optional[str] = None,
associated_file_relationship: Optional[str] = None,
**kwargs: Any,
) -> PDFEmbeddedFile:
"""
Embed a file into the PDF as an attachment (and, for PDF/A-3 or PDF/A-4f, as an
Associated File).
Args:
file_path (str or Path): filesystem path to the existing file to embed
bytes (bytes): optional, as an alternative to file_path, bytes content of the file to embed
basename (str): optional, required if bytes is provided, file base name
creation_date (datetime): date and time when the file was created
modification_date (datetime): date and time when the file was last modified
desc (str): optional description of the file
mime_type: MIME type of the embedded content (e.g., "application/pdf", "text/csv", "image/png")
associated_file_relationship: For PDF/A-3/A-4f, the AF relationship to declare in the FileSpec
(e.g., "Data", "Source", "Alternative", "Supplement", or "Unspecified").
**kwargs:
desc (str): Optional human-readable description for the FileSpec.
creation_date (datetime): Original creation time of the file.
compress (bool): enabled zlib compression of the file - False by default
checksum (bool): insert a MD5 checksum of the file content - False by default
Returns: a PDFEmbeddedFile instance, with a .basename string attribute representing the internal file name
"""
if file_path:
if bytes:
raise ValueError("'bytes' cannot be provided with 'file_path'")
if basename:
raise ValueError("'basename' cannot be provided with 'file_path'")
file_path = Path(file_path)
with file_path.open("rb") as input_file:
bytes = input_file.read()
basename = file_path.name
stats = file_path.stat()
if modification_date is None:
modification_date = datetime.fromtimestamp(stats.st_mtime).astimezone()
else:
if not bytes:
raise ValueError("'bytes' is required if 'file_path' is not provided")
if not basename:
raise ValueError(
"'basename' is required if 'file_path' is not provided"
)
if mime_type is None:
mime_type = mimetypes.guess_type(basename)[0] or "application/octet-stream"
mime_type = mime_type.lower()
af_relationship = (
AssociatedFileRelationship.coerce(associated_file_relationship)
if associated_file_relationship is not None
else None
)
already_embedded_basenames = set(
file.basename() for file in self.embedded_files
)
if basename in already_embedded_basenames:
raise ValueError(f"{basename} has already been embedded in this file")
if self._compliance and self._compliance.profile == "PDFA":
if self._compliance.part == 1:
raise PDFAComplianceError(
f"Embedding files is not allowed for documents compliant with {self._compliance.label}"
)
if self._compliance.part == 2 or (
self._compliance.part == 4 and self._compliance.conformance is None
):
if (mime_type == "application/pdf") or basename.lower().endswith(
".pdf"
):
LOGGER.warning(
"%s: ensure the embedded PDF '%s' is itself PDF/A to remain compliant.",
self._compliance.label,
basename,
)
else:
raise PDFAComplianceError(
f"{self._compliance.label} permits embedding only PDF files, which must themselves be PDF/A."
)
if self._compliance.part in (3, 4):
if af_relationship is None:
af_relationship = AssociatedFileRelationship.UNSPECIFIED
embedded_file = PDFEmbeddedFile(
basename=basename,
contents=bytes,
modification_date=modification_date,
mime_type=mime_type,
af_relationship=af_relationship,
**kwargs,
)
self.embedded_files.append(embedded_file)
self._set_min_pdf_version("1.4")
return embedded_file
@check_page
def file_attachment_annotation(
self,
file_path: str | Path,
x: float,
y: float,
w: float = 1,
h: float = 1,
name: Optional[FileAttachmentAnnotationName | str] = None,
flags: tuple[AnnotationFlag | str, ...] = DEFAULT_ANNOT_FLAGS,
**kwargs: Any,
) -> AnnotationDict:
"""
Puts a file attachment annotation on a rectangular area of the page.
Args:
file_path (str or Path): filesystem path to the existing file to embed
x (float): horizontal position (from the left) to the left side of the link rectangle
y (float): vertical position (from the top) to the bottom side of the link rectangle
w (float): optional width of the link rectangle
h (float): optional height of the link rectangle
name (fpdf.enums.FileAttachmentAnnotationName, str): optional icon that shall be used in displaying the annotation
flags (Tuple[fpdf.enums.AnnotationFlag], Tuple[str]): optional list of flags defining annotation properties
bytes (bytes): optional, as an alternative to file_path, bytes content of the file to embed
basename (str): optional, required if bytes is provided, file base name
creation_date (datetime): date and time when the file was created
modification_date (datetime): date and time when the file was last modified
desc (str): optional description of the file
compress (bool): enabled zlib compression of the file - False by default
checksum (bool): insert a MD5 checksum of the file content - False by default
"""
embedded_file = self.embed_file(file_path, **kwargs)
# Attachment annotations should not be listed in the document-level AF entry
# (they are reachable through the annotation itself), so keep them out of AF:
embedded_file.set_globally_enclosed(False)
annotation = AnnotationDict(
"FileAttachment",
x * self.k,
self.h_pt - y * self.k,
w * self.k,
h * self.k,
file_spec=embedded_file.file_spec(),
name=FileAttachmentAnnotationName.coerce(name) if name else None,
flags=flags,
)
self.pages[self.page].add_annotation(annotation)
return annotation
@check_page
def text_annotation(
self,
x: float,
y: float,
text: str,
w: float = 1,
h: float = 1,
name: Optional[AnnotationName | str] = None,
**kwargs: Any,
) -> AnnotationDict:
"""
Puts a text annotation on a rectangular area of the page.
Args:
x (float): horizontal position (from the left) to the left side of the link rectangle
y (float): vertical position (from the top) to the bottom side of the link rectangle
text (str): text to display
w (float): optional width of the link rectangle
h (float): optional height of the link rectangle
name (fpdf.enums.AnnotationName, str): optional icon that shall be used in displaying the annotation
flags (Tuple[fpdf.enums.AnnotationFlag], Tuple[str]): optional list of flags defining annotation properties
title (str): the text label that shall be displayed in the title bar of the annotation’s
pop-up window when open and active. This entry shall identify the user who added the annotation.
"""
annotation = AnnotationDict(
"Text",
x * self.k,
self.h_pt - y * self.k,
w * self.k,
h * self.k,
contents=text,
name=AnnotationName.coerce(name) if name else None,
**kwargs,
)
self.pages[self.page].add_annotation(annotation)
return annotation
@check_page
def free_text_annotation(
self,
text: str,
x: Optional[float] = None,
y: Optional[float] = None,
w: Optional[float] = None,
h: Optional[float] = None,
**kwargs: Any,
) -> AnnotationDict:
"""
Puts a free text annotation on a rectangular area of the page.
Args:
text (str): text to display
x (float): optional horizontal position (from the left) to the left side of the link rectangle.
Default value: None, meaning the current abscissa is used
y (float): vertical position (from the top) to the bottom side of the link rectangle.
Default value: None, meaning the current ordinate is used
w (float): optional width of the link rectangle. Default value: None, meaning the length of text in user unit
h (float): optional height of the link rectangle. Default value: None, meaning an height equal
to the current font size
flags (Tuple[fpdf.enums.AnnotationFlag], Tuple[str]): optional list of flags defining annotation properties
color (tuple): a tuple of numbers in the range 0.0 to 1.0, representing a colour used for the annotation background
border_width (float): width of the annotation border
"""
if not self.font_family:
raise FPDFException("No font set, you need to call set_font() beforehand")
if not self.current_font_is_set_on_page:
assert self.current_font is not None
self._out(self._set_font_for_page(self.current_font, self.font_size_pt))
if x is None:
x = self.x
if y is None:
y = self.y
if h is None:
h = self.font_size
if w is None:
w = self.get_string_width(text, normalized=True, markdown=False)
assert self.draw_color is not None and self.current_font is not None
annotation = AnnotationDict(
"FreeText",
x * self.k,
self.h_pt - y * self.k,
w * self.k,
h * self.k,
contents=text,
default_appearance=f"({self.draw_color.serialize()} /F{self.current_font.i} {self.font_size_pt:.2f} Tf)",
**kwargs,
)
self.pages[self.page].add_annotation(annotation)
return annotation
@check_page
def add_action(
self, action: Action, x: float, y: float, w: float, h: float, **kwargs: Any
) -> AnnotationDict:
"""
Puts an Action annotation on a rectangular area of the page.
Args:
action (fpdf.actions.Action): the action to add
x (float): horizontal position (from the left) to the left side of the link rectangle
y (float): vertical position (from the top) to the bottom side of the link rectangle
w (float): width of the link rectangle
h (float): height of the link rectangle
"""
annotation_action_type = "Action"
if isinstance(action, GoToAction):
annotation_action_type = "Link"
annotation = AnnotationDict(
annotation_action_type,
x * self.k,
self.h_pt - y * self.k,
w * self.k,
h * self.k,
action=action,
**kwargs,
)
self.pages[self.page].add_annotation(annotation)
return annotation
@contextmanager
def highlight(
self,
text: str,
type: TextMarkupType | str = "Highlight",
color: tuple[float, float, float] = (1, 1, 0),
modification_time: Optional[datetime] = None,
**kwargs: Any,
) -> Iterator[None]:
"""
Context manager that adds a single highlight annotation based on the text lines inserted
inside its indented block.
Args:
text (str): text of the annotation
title (str): the text label that shall be displayed in the title bar of the annotation’s
pop-up window when open and active. This entry shall identify the user who added the annotation.
type (fpdf.enums.TextMarkupType, str): "Highlight", "Underline", "Squiggly" or "StrikeOut".
color (tuple): a tuple of numbers in the range 0.0 to 1.0, representing a colour used for
the title bar of the annotation’s pop-up window. Defaults to yellow.
modification_time (datetime): date and time when the annotation was most recently modified
"""
if self._record_text_quad_points:
raise FPDFException("highlight() cannot be nested")
self._record_text_quad_points = True
yield
for page, quad_points in self._text_quad_points.items():
self.add_text_markup_annotation(
type,
text,
quad_points=quad_points,
modification_time=modification_time,
page=page,
color=color,
**kwargs,
)
self._text_quad_points = defaultdict(list)
self._record_text_quad_points = False
@contextmanager
def add_highlight(self, *args: Any, **kwargs: Any) -> Iterator[None]:
warnings.warn(
"add_highlight() has been renamed to highlight() in v2.5.5.",
DeprecationWarning,
stacklevel=get_stack_level(),
)
with self.highlight(*args, **kwargs):
yield
@check_page
def add_text_markup_annotation(
self,
type: TextMarkupType | str,
text: str,
quad_points: Sequence[float],
color: tuple[float, float, float] = (1, 1, 0),
modification_time: Optional[datetime] = None,
page: Optional[int] = None,
**kwargs: Any,
) -> AnnotationDict:
"""
Adds a text markup annotation on some quadrilateral areas of the page.
Args:
type (fpdf.enums.TextMarkupType, str): "Highlight", "Underline", "Squiggly" or "StrikeOut"
text (str): text of the annotation
quad_points (tuple): array of 8 × n numbers specifying the coordinates of n quadrilaterals
in default user space that comprise the region in which the link should be activated.
The coordinates for each quadrilateral are given in the order: x1 y1 x2 y2 x3 y3 x4 y4
specifying the four vertices of the quadrilateral in counterclockwise order
title (str): the text label that shall be displayed in the title bar of the annotation’s
pop-up window when open and active. This entry shall identify the user who added the annotation.
color (tuple): a tuple of numbers in the range 0.0 to 1.0, representing a colour used for
the title bar of the annotation’s pop-up window. Defaults to yellow.
modification_time (datetime): date and time when the annotation was most recently modified
page (int): index of the page where this annotation is added
"""
self._set_min_pdf_version("1.6")
type = TextMarkupType.coerce(type).value
if modification_time is None:
modification_time = self.creation_date
if page is None:
page = self.page
x_min = min(quad_points[0::2])
y_min = min(quad_points[1::2])
x_max = max(quad_points[0::2])
y_max = max(quad_points[1::2])
annotation = AnnotationDict(
type,
contents=text,
x=y_min,
y=y_max,
width=x_max - x_min,
height=y_max - y_min,
modification_time=modification_time,
quad_points=quad_points,
color=color,
**kwargs,
)
self.pages[page].add_annotation(annotation)
return annotation
@check_page
def ink_annotation(
self,
coords: Sequence[tuple[float, float]],
text: str = "",
color: tuple[float, float, float] = (1, 1, 0),
border_width: float = 1,
**kwargs: Any,
) -> AnnotationDict:
"""
Adds add an ink annotation on the page.
Args:
coords (tuple): an iterable of coordinates (pairs of numbers) defining a path
text (str): textual description
title (str): the text label that shall be displayed in the title bar of the annotation’s
pop-up window when open and active. This entry shall identify the user who added the annotation.
color (tuple): a tuple of numbers in the range 0.0 to 1.0, representing a colour used for
the title bar of the annotation’s pop-up window. Defaults to yellow.
border_width (float): thickness of the path stroke.
"""
ink_list = sum(((x * self.k, (self.h - y) * self.k) for (x, y) in coords), ())
x_min = min(ink_list[0::2])
y_min = min(ink_list[1::2])
x_max = max(ink_list[0::2])
y_max = max(ink_list[1::2])
annotation = AnnotationDict(
"Ink",
x=y_min,
y=y_max,
width=x_max - x_min,
height=y_max - y_min,
ink_list=ink_list,
contents=text,
border_width=border_width,
color=color,
**kwargs,
)
self.pages[self.page].add_annotation(annotation)
return annotation
@check_page
@support_deprecated_txt_arg
def text(self, x: float, y: float, text: str = "") -> None:
"""
Prints a character string. The origin is on the left of the first character,
on the baseline. This method allows placing a string precisely on the page,
but it is usually easier to use the `FPDF.cell()`, `FPDF.multi_cell() or `FPDF.write()` methods.
Args:
x (float): abscissa of the origin
y (float): ordinate of the origin
text (str): string to print
txt (str): [**DEPRECATED since v2.7.6**] string to print
Notes
-----
`text()` lacks many of the features available in `FPDF.write()`,
`FPDF.cell()` and `FPDF.multi_cell()` like markdown and text shaping.
"""
if not self.font_family:
raise FPDFException("No font set, you need to call set_font() beforehand")
text = self.normalize_text(text)
assert self.current_font is not None
if not self.current_font_is_set_on_page:
self._out(self._set_font_for_page(self.current_font, self.font_size_pt))
sl = [f"BT {x * self.k:.2f} {(self.h - y) * self.k:.2f} Td"]
if self.text_mode != TextMode.FILL:
sl.append(f" {self.text_mode} Tr {self.line_width:.2f} w")
sl.append(f"{self.current_font.encode_text(text)} ET")
if (
text != "" and (self.underline or self.strikethrough)
) or self._record_text_quad_points:
w = self.get_string_width(text, normalized=True, markdown=False)
if text != "":
if self.underline:
sl.append(self._do_underline(x, y, w))
if self.strikethrough:
sl.append(self._do_strikethrough(x, y, w))
if self._record_text_quad_points:
h = self.font_size
y -= 0.8 * h # same coefficient as in _render_styled_text_line()
self._add_quad_points(x, y, w, h)
attr_l: list[str] = []
if self.fill_color != self.text_color:
assert self.text_color is not None
attr_l.append(f"{self.text_color.serialize().lower()}")
if attr_l:
sl = ["q"] + attr_l + sl + ["Q"]
self._out(" ".join(sl))
@check_page
def rotate(
self, angle: float, x: Optional[float] = None, y: Optional[float] = None
) -> None:
"""
.. deprecated:: 2.1.0
Use `FPDF.rotation()` instead.
"""
warnings.warn(
(
"rotate() can produces malformed PDFs and is deprecated since v2.1.0. "
"It will be removed in a future release. "
"Use the rotation() context manager instead."
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
if x is None:
x = self.x
if y is None:
y = self.y
if self._angle != 0:
self._out("Q")
self._angle = angle
if angle != 0:
angle *= math.pi / 180
c = math.cos(angle)
s = math.sin(angle)
cx = x * self.k
cy = (self.h - y) * self.k
output = (
f"q {c:.5F} {s:.5F} {-s:.5F} {c:.5F} {cx:.2F} {cy:.2F} cm "
f"1 0 0 1 {-cx:.2F} {-cy:.2F} cm"
)
self._out(output)
@check_page
@contextmanager
def rotation(
self, angle: float, x: Optional[float] = None, y: Optional[float] = None
) -> Iterator[None]:
"""
Method to perform a rotation around a given center.
It must be used as a context-manager using `with`:
with rotation(angle=90, x=x, y=y):
pdf.something()
The rotation affects all elements which are printed inside the indented
context (with the exception of clickable areas).
Args:
angle (float): angle in degrees
x (float): abscissa of the center of the rotation
y (float): ordinate of the center of the rotation
Notes
-----
Only the rendering is altered. The `FPDF.get_x()` and `FPDF.get_y()` methods are
not affected, nor the automatic page break mechanism.
The rotation also establishes a local graphics state, so that any
graphics state settings changed within will not affect the operations
invoked after it has finished.
"""
if x is None:
x = self.x
if y is None:
y = self.y
with self.transform(Transform.rotation_d(-angle).about(x, y)):
yield
@check_page
@contextmanager
def skew(
self,
ax: float = 0,
ay: float = 0,
x: Optional[float] = None,
y: Optional[float] = None,
) -> Iterator[None]:
"""
Method to perform a skew transformation originating from a given center.
It must be used as a context-manager using `with`:
with skew(ax=15, ay=15, x=x, y=y):
pdf.something()
The skew transformation affects all elements which are printed inside the indented
context (with the exception of clickable areas).
Args:
ax (float): angle of skew in the horizontal direction in degrees
ay (float): angle of skew in the vertical direction in degrees
x (float): abscissa of the center of the skew transformation
y (float): ordinate of the center of the skew transformation
"""
lim_val = 2**32
if x is None:
x = self.x
if y is None:
y = self.y
ax = max(min(math.tan(ax * (math.pi / 180)), lim_val), -lim_val)
ay = max(min(math.tan(ay * (math.pi / 180)), lim_val), -lim_val)
with self.transform(Transform.shearing(-ax, -ay).about(x, y)):
yield
@check_page
@contextmanager
def mirror(
self, origin: tuple[float, float], angle: Angle | str | float
) -> Iterator[None]:
"""
Method to perform a reflection transformation over a given mirror line.
It must be used as a context-manager using `with`:
with mirror(origin=(15,15), angle="SOUTH"):
pdf.something()
The mirror transformation affects all elements which are rendered inside the indented
context (with the exception of clickable areas).
Args:
origin (float, Sequence(float, float)): a point on the mirror line
angle: (fpdf.enums.Angle): the direction of the mirror line
"""
x, y = origin
try:
if isinstance(angle, (str, Angle)):
theta = float(Angle.coerce(angle).value)
else:
theta = float(angle)
except ValueError:
theta = float(angle)
a = math.cos(math.radians(theta * 2))
b = -math.sin(math.radians(theta * 2))
with self.transform(Transform(a, b, b, -a, 0, 0).about(x, y)):
yield
@check_page
@contextmanager
def transform(self, transform: Transform) -> Iterator[None]:
"""
Apply a transformation matrix to the current graphics state.
This context manager isolates the transformation so it doesn't affect
rendering outside the 'with' block.
It automatically handles the conversion from FPDF's User Units (usually mm, top-left origin)
to PDF Device Units (points, bottom-left origin).
Args:
transform (fpdf.drawing_primitives.Transform): The transformation matrix to apply.
"""
with self.local_context():
user_to_pdf = Transform.scaling(self.k, -self.k).translate(0, self.h_pt)
adjusted_transform = user_to_pdf.inverse() @ transform @ user_to_pdf
command, _ = adjusted_transform.render(None) # type: ignore
self._out(command)
yield
@check_page
@contextmanager
def local_context(self, **kwargs: Any) -> Iterator[None]:
"""
Creates a local graphics state, which won't affect the surrounding code.
This method must be used as a context manager using `with`:
with pdf.local_context():
set_some_state()
draw_some_stuff()
The affected settings are those controlled by GraphicsStateMixin and drawing.GraphicsStyle:
* allow_transparency
* auto_close
* blend_mode
* char_vpos
* char_spacing
* dash_pattern
* denom_lift
* denom_scale
* draw_color
* fill_color
* fill_opacity
* font_family
* font_size
* font_size_pt
* font_style
* font_stretching
* intersection_rule
* line_width
* nom_lift
* nom_scale
* paint_rule
* strikethrough
* stroke_cap_style
* stroke_join_style
* stroke_miter_limit
* stroke_opacity
* sub_lift
* sub_scale
* sup_lift
* sup_scale
* text_color
* text_mode
* text_shaping
* underline
Font size can be specified in document units with `font_size` or in points with `font_size_pt`.
Args:
**kwargs: key-values settings to set at the beginning of this context.
"""
if self._in_unbreakable:
raise FPDFException(
"cannot create a local context inside an unbreakable() code block"
)
self._push_local_stack()
self._start_local_context(**kwargs)
yield
self._end_local_context()
self._pop_local_stack()
def _start_local_context(
self,
font_family: Optional[str] = None,
font_style: Optional[str] = None,
font_size_pt: Optional[float] = None,
line_width: Optional[float] = None,
draw_color: Optional[ColorInput] = None,
fill_color: Optional[ColorInput] = None,
text_color: Optional[ColorInput] = None,
dash_pattern: Optional[
Union[tuple[float, float, float], dict[str, float]]
] = None,
**kwargs: Any,
) -> None:
"""
This method starts a "q/Q" context in the page content stream,
and inserts operators in it to initialize all the PDF settings specified.
"""
if "font_size" in kwargs:
# At some point we may want to deprecate font_size here in favour of font_size_pt,
# and raise a warning if font_size is provided:
# * font_size_pt is more consistent with the size parameter of .set_font(), provided in points.
# * font_size can be misused, as users may not be aware of the difference between the 2 properties,
# and may erroneously provide a value in points as font_size.
if font_size_pt is not None:
raise ValueError("font_size & font_size_pt cannot be both provided")
font_size_pt = kwargs["font_size"] * self.k
del kwargs["font_size"]
gs = None
for key, value in kwargs.items():
if key in (
"stroke_color",
"stroke_dash_phase",
"stroke_dash_pattern",
"stroke_width",
):
raise ValueError(
f"Unsupported setting: {key} - This can be controlled through dash_pattern / draw_color / line_width"
)
if key in GraphicsStyle.MERGE_PROPERTIES:
if gs is None:
gs = GraphicsStyle()
setattr(gs, key, value)
if key == "blend_mode":
self._set_min_pdf_version("1.4")
elif key in (
"char_vpos",
"char_spacing",
"current_font",
"denom_lift",
"denom_scale",
"font_stretching",
"nom_lift",
"nom_scale",
"strikethrough",
"sub_lift",
"sub_scale",
"sup_lift",
"sup_scale",
"text_mode",
"text_shaping",
"underline",
"current_font_is_set_on_page",
):
setattr(self, key, value)
else:
raise ValueError(f"Unsupported setting: {key}")
if gs:
gs_name = self._resource_catalog.register_graphics_style(gs)
assert gs_name is not None
self._resource_catalog.add(PDFResourceType.EXT_G_STATE, gs_name, self.page)
self._out(f"q /{gs_name} gs")
else:
self._out("q")
# All the following calls to .set*() methods invoke .out() and write to the stream buffer:
if (
font_family is not None
or font_style is not None
or font_size_pt is not None
):
self.set_font(
font_family or self.font_family,
# Beware: font_style='' must be handled distinctly from font_style=None
self.font_style if font_style is None else font_style,
font_size_pt or self.font_size_pt,
)
if line_width is not None:
self.set_line_width(line_width)
if draw_color is not None:
self.set_draw_color(draw_color)
if fill_color is not None:
self.set_fill_color(fill_color)
if text_color is not None:
self.set_text_color(text_color)
if dash_pattern is not None:
if isinstance(dash_pattern, dict):
self.set_dash_pattern(
dash_pattern.get("dash", 0),
dash_pattern.get("gap", 0),
dash_pattern.get("phase", 0),
)
else:
self.set_dash_pattern(dash_pattern[0], dash_pattern[1], dash_pattern[2])
def _end_local_context(self) -> None:
"""
This method ends a "q/Q" context in the page content stream.
"""
self._out("Q")
@property
def accept_page_break(self) -> bool:
"""
Whenever a page break condition is met, this `@property` method is called,
and the break is issued or not depending on the returned value.
The default implementation returns `self.auto_page_break`,
a value according to the mode selected by `FPDF.set_auto_page_break()`.
This method is called automatically and should not be called directly by the application.
Detailed documentation on page breaks: https://py-pdf.github.io/fpdf2/PageBreaks.html
"""
return self.auto_page_break
@check_page
@support_deprecated_txt_arg
def cell(
self,
w: Optional[float] = None,
h: Optional[float] = None,
text: str = "",
border: Literal[0, 1] | str = 0,
ln: Literal["DEPRECATED"] = "DEPRECATED",
align: str | Align = Align.L,
fill: bool = False,
link: Optional[str | int] = "",
center: bool = False,
markdown: bool = False,
new_x: str | XPos = XPos.RIGHT,
new_y: str | YPos = YPos.TOP,
) -> bool:
"""
Prints a cell (rectangular area) with optional borders, background color and
character string. The upper-left corner of the cell corresponds to the current
position. The text can be aligned or centered. After the call, the current
position moves to the selected `new_x`/`new_y` position. It is possible to put a link
on the text. A cell has an horizontal padding, on the left & right sides, defined by
the.c_margin property.
If automatic page breaking is enabled and the cell goes beyond the limit, a
page break is performed before outputting.
Args:
w (float): Cell width. Default value: None, meaning to fit text width.
If 0, the cell extends up to the right margin.
h (float): Cell height. Default value: None, meaning an height equal
to the current font size.
text (str): String to print. Default value: empty string.
border: Indicates if borders must be drawn around the cell.
The value can be either a number (`0`: no border ; `1`: frame)
or a string containing some or all of the following characters
(in any order):
`L`: left ; `T`: top ; `R`: right ; `B`: bottom. Default value: 0.
new_x (fpdf.enums.XPos, str): New current position in x after the call. Default: RIGHT
new_y (fpdf.enums.YPos, str): New current position in y after the call. Default: TOP
ln (int): **DEPRECATED since 2.5.1**: Use `new_x` and `new_y` instead.
align (fpdf.enums.Align, str): Set text alignment inside the cell.
Possible values are: `L` or empty string: left align (default value) ;
`C`: center; `X`: center around current x position; `R`: right align
fill (bool): Indicates if the cell background must be painted (`True`)
or transparent (`False`). Default value: False.
link (str): optional link to add on the cell, internal
(identifier returned by `FPDF.add_link`) or external URL.
center (bool): center the cell horizontally on the page.
markdown (bool): enable minimal markdown-like markup to render part
of text as bold / italics / strikethrough / underlined.
Supports `\\` as escape character. Default to False.
txt (str): [**DEPRECATED since v2.7.6**] String to print. Default value: empty string.
Returns: a boolean indicating if page break was triggered
"""
if not self.font_family:
raise FPDFException("No font set, you need to call set_font() beforehand")
if isinstance(w, str) or isinstance(h, str):
raise ValueError(
"Parameter 'w' and 'h' must be numbers, not strings."
" You can omit them by passing string content with text="
)
if isinstance(border, int) and border not in (0, 1):
warnings.warn(
'Integer values for "border" parameter other than 1 are currently ignored',
stacklevel=get_stack_level(),
)
border = 1
new_x = XPos.coerce(new_x)
new_y = YPos.coerce(new_y)
align = Align.coerce(align)
if align == Align.J:
raise ValueError(
"cell() only produces one text line, justified alignment is not possible"
)
if ln != "DEPRECATED":
# For backwards compatibility, if "ln" is used we overwrite "new_[xy]".
if ln == 0:
new_x = XPos.RIGHT
new_y = YPos.TOP
elif ln == 1:
new_x = XPos.LMARGIN
new_y = YPos.NEXT
elif ln == 2:
new_x = XPos.LEFT
new_y = YPos.NEXT
else:
raise ValueError(
f'Invalid value for parameter "ln" ({ln}),'
" must be an int between 0 and 2."
)
warnings.warn(
(
'The parameter "ln" is deprecated since v2.5.2.'
f" Instead of ln={ln} use new_x=XPos.{new_x.name}, new_y=YPos.{new_y.name}."
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
# Font styles preloading must be performed before any call to FPDF.get_string_width:
text = self.normalize_text(text)
styled_txt_frags = (
self._preload_bidirectional_text(text, markdown)
if self.text_shaping
else self._preload_font_styles(text, markdown)
)
line_height = self.font_size if h is None else h
return self._render_styled_text_line(
TextLine(
styled_txt_frags,
text_width=0,
number_of_spaces=0,
align=align,
height=line_height,
max_width=w,
trailing_nl=False,
),
line_height,
border,
new_x=new_x,
new_y=new_y,
fill=fill,
link=link,
center=center,
prevent_font_change=markdown,
)
def _render_styled_text_line(
self,
text_line: TextLine,
h: Optional[float] = None,
border: Union[str, int] = 0,
new_x: XPos = XPos.RIGHT,
new_y: YPos = YPos.TOP,
fill: bool = False,
link: Optional[str | int] = "",
center: bool = False,
padding: Optional[Padding] = None,
prevent_font_change: bool = False,
) -> bool:
"""
Prints a cell (rectangular area) with optional borders, background color and
character string. The upper-left corner of the cell corresponds to the current
position. The text can be aligned, centered or justified. After the call, the
current position moves to the requested new position. It is possible to put a
link on the text.
If automatic page breaking is enabled and the cell goes beyond the limit, a
page break is performed before outputting.
Args:
text_line (TextLine instance): Contains the (possibly empty) tuple of
fragments to render.
h (float): Cell height. Default value: None, meaning an height equal
to the current font size.
border: Indicates if borders must be drawn around the cell.
The value can be either a number (`0`: no border ; `1`: frame)
or a string containing some or all of the following characters
(in any order):
`L`: left ; `T`: top ; `R`: right ; `B`: bottom. Default value: 0.
new_x (fpdf.enums.XPos): New current position in x after the call.
new_y (fpdf.enums.YPos): New current position in y after the call.
fill (bool): Indicates if the cell background must be painted (`True`)
or transparent (`False`). Default value: False.
link (str): optional link to add on the cell, internal
(identifier returned by `FPDF.add_link`) or external URL.
center (bool): center the cell horizontally on the page.
padding (Padding or None): optional padding to apply to the cell content.
If padding for left and right is non-zero then c_margin is ignored.
prevent_font_change (bool): ensure no font settings (family / size / style)
change during this call.
Returns: a boolean indicating if page break was triggered
"""
if isinstance(border, int) and border not in (0, 1):
warnings.warn(
'Integer values for "border" parameter other than 1 are currently ignored',
stacklevel=get_stack_level(),
)
border = 1
elif isinstance(border, str) and set(border).issuperset("LTRB"):
border = 1
if padding is None:
padding = Padding(0, 0, 0, 0)
l_c_margin = r_c_margin = float(0)
if padding.left == 0:
l_c_margin = self.c_margin
if padding.right == 0:
r_c_margin = self.c_margin
styled_txt_width = text_line.text_width
if not styled_txt_width:
for i, frag in enumerate(text_line.fragments):
unscaled_width = frag.get_width(initial_cs=i != 0)
styled_txt_width += unscaled_width
w = text_line.max_width
if w is None:
if not text_line.fragments:
raise ValueError(
"'text_line' must have fragments if 'text_line.text_width' is None"
)
w = styled_txt_width + l_c_margin + r_c_margin
elif w == 0:
w = self.w - self.r_margin - self.x
if center:
self.x = self.l_margin + (self.epw - w) / 2
elif text_line.align == Align.X:
self.x -= w / 2
max_font_size: float = 0 # how much height we need to accommodate.
# currently all font sizes within a line are vertically aligned on the baseline.
fragments = text_line.get_ordered_fragments()
for frag in fragments:
if FloatTolerance.greater_than(frag.font_size, max_font_size):
max_font_size = frag.font_size
if h is None:
h = max_font_size
page_break_triggered = self._perform_page_break_if_need_be(h)
sl: list[str] = []
k = self.k
# pre-calc border edges with padding
left = (self.x - padding.left) * k
right = (self.x + w + padding.right) * k
top = (self.h - self.y + padding.top) * k
bottom = (self.h - (self.y + h) - padding.bottom) * k
if fill:
op = "B" if border == 1 else "f"
sl.append(f"{left:.2f} {top:.2f} {right-left:.2f} {bottom-top:.2f} re {op}")
elif border == 1:
sl.append(f"{left:.2f} {top:.2f} {right-left:.2f} {bottom-top:.2f} re S")
# pylint: enable=invalid-unary-operand-type
if isinstance(border, str):
if "L" in border:
sl.append(f"{left:.2f} {top:.2f} m {left:.2f} {bottom:.2f} l S")
if "T" in border:
sl.append(f"{left:.2f} {top:.2f} m {right:.2f} {top:.2f} l S")
if "R" in border:
sl.append(f"{right:.2f} {top:.2f} m {right:.2f} {bottom:.2f} l S")
if "B" in border:
sl.append(f"{left:.2f} {bottom:.2f} m {right:.2f} {bottom:.2f} l S")
if self._record_text_quad_points:
self._add_quad_points(self.x, self.y, w, h)
s_start = self.x
s_width: float = 0
# We try to avoid modifying global settings for temporary changes.
current_ws = frag_ws = 0.0
current_lift = 0.0
current_char_vpos = CharVPos.LINE
current_font = self.current_font
current_font_size_pt = self.font_size_pt
current_font_style = self.font_style
current_text_mode = self.text_mode
current_font_stretching = self.font_stretching
current_char_spacing = self.char_spacing
fill_color_changed = False
last_used_color = self.fill_color
if fragments:
if text_line.align == Align.R:
dx = w - l_c_margin - styled_txt_width
elif text_line.align in [Align.C, Align.X]:
dx = (w - styled_txt_width) / 2
else:
dx = l_c_margin
s_start += dx
word_spacing: float = 0
if text_line.align == Align.J and text_line.number_of_spaces:
word_spacing = (
w - l_c_margin - r_c_margin - styled_txt_width
) / text_line.number_of_spaces
sl.append(
f"BT {(self.x + dx) * k:.2f} "
f"{(self.h - self.y - 0.5 * h - 0.3 * max_font_size) * k:.2f} Td"
)
underlines: list[tuple[float, float, CoreFont | TTFFont, float]] = []
strikethroughs: list[tuple[float, float, CoreFont | TTFFont, float]] = []
for i, frag in enumerate(fragments):
if isinstance(frag, TotalPagesSubstitutionFragment):
self.pages[self.page].add_text_substitution(frag)
if frag.text_color != last_used_color:
# allow to change color within the line of text.
last_used_color = frag.text_color
assert last_used_color is not None
sl.append(last_used_color.serialize().lower())
fill_color_changed = True
if word_spacing and frag.font_stretching != 100:
# Space character is already stretched, extra spacing is absolute.
frag_ws = word_spacing * 100 / frag.font_stretching
else:
frag_ws = word_spacing
if current_font_stretching != frag.font_stretching:
current_font_stretching = frag.font_stretching
sl.append(f"{frag.font_stretching:.2f} Tz")
if current_char_spacing != frag.char_spacing:
current_char_spacing = frag.char_spacing
sl.append(f"{frag.char_spacing:.2f} Tc")
if not self.current_font_is_set_on_page:
if prevent_font_change:
# This is "local" to the current BT / ET context:
current_font = frag.font
current_font_size_pt = frag.font_size_pt
current_font_style = frag.font_style
sl.append(f"/F{current_font.i} {current_font_size_pt:.2f} Tf")
self._resource_catalog.add(
PDFResourceType.FONT, current_font.i, self.page
)
current_char_vpos = frag.char_vpos
else:
# This is "global" to the page,
# as it is rendered in the content stream
# BEFORE the text_lines /fragments,
# wrapped into BT / ET operators:
current_font = self.current_font = frag.font
current_font_size_pt = self.font_size_pt = frag.font_size_pt
current_font_style = self.font_style = frag.font_style
self._out(
self._set_font_for_page(
current_font,
current_font_size_pt,
)
)
current_char_vpos = frag.char_vpos
elif (
current_font != frag.font
or current_font_size_pt != frag.font_size_pt
or current_font_style != frag.font_style
or current_char_vpos != frag.char_vpos
):
# This is "local" to the current BT / ET context:
current_font = frag.font
current_font_size_pt = frag.font_size_pt
current_font_style = frag.font_style
sl.append(
self._set_font_for_page(
current_font,
current_font_size_pt,
wrap_in_text_object=False,
)
)
current_char_vpos = frag.char_vpos
lift = frag.lift
if lift != current_lift:
# Use text rise operator:
sl.append(f"{lift:.2f} Ts")
current_lift = lift
if (
frag.text_mode != TextMode.FILL
or frag.text_mode != current_text_mode
):
current_text_mode = frag.text_mode
sl.append(f"{frag.text_mode} Tr {frag.line_width:.2f} w")
r_text = frag.render_pdf_text(
frag_ws,
current_ws,
word_spacing,
self.x + dx + s_width,
self.y + (0.5 * h + 0.3 * max_font_size),
self.h,
)
if r_text:
sl.append(r_text)
frag_width = frag.get_width(
initial_cs=i != 0
) + word_spacing * frag.characters.count(" ")
if frag.underline:
underlines.append(
(self.x + dx + s_width, frag_width, frag.font, frag.font_size)
)
if frag.strikethrough:
strikethroughs.append(
(self.x + dx + s_width, frag_width, frag.font, frag.font_size)
)
if frag.link:
self.link(
x=self.x + dx + s_width,
y=self.y + (0.5 * h) - (0.5 * frag.font_size),
w=frag_width,
h=frag.font_size,
link=frag.link,
)
if not frag.is_ttf_font:
current_ws = frag_ws
s_width += frag_width
sl.append("ET")
# Underlines & strikethrough must be rendred OUTSIDE BT/ET contexts,
# cf. https://github.com/py-pdf/fpdf2/issues/1456
if underlines:
for start_x, width, font, font_size in underlines:
sl.append(
self._do_underline(
start_x, self.y + (0.5 * h) + (0.3 * font_size), width, font
)
)
if strikethroughs:
for start_x, width, font, font_size in strikethroughs:
sl.append(
self._do_strikethrough(
start_x, self.y + (0.5 * h) + (0.3 * font_size), width, font
)
)
if link:
self.link(
self.x + dx,
self.y
+ (0.5 * h)
- (
0.5
* frag.font_size # pyright: ignore[reportPossiblyUnboundVariable]
),
styled_txt_width,
frag.font_size, # pyright: ignore[reportPossiblyUnboundVariable]
link,
)
if sl:
# If any PDF settings have been left modified, wrap the line
# in a local context.
# pylint: disable=too-many-boolean-expressions
if (
current_ws != 0.0
or current_lift != 0.0
or current_char_vpos != CharVPos.LINE
or current_font != self.current_font
or current_font_size_pt != self.font_size_pt
or current_font_style != self.font_style
or current_text_mode != self.text_mode
or fill_color_changed
or current_font_stretching != self.font_stretching
or current_char_spacing != self.char_spacing
):
s = f"q {' '.join(sl)} Q"
else:
s = " ".join(sl)
# pylint: enable=too-many-boolean-expressions
self._out(s)
# If the text is empty, h = max_font_size ends up as 0.
# We still need a valid default height for self.ln() (issue #601).
self._lasth = h or self.font_size
# XPos.LEFT -> self.x stays the same
if new_x == XPos.RIGHT:
self.x += w
elif new_x == XPos.START:
self.x = s_start
elif new_x == XPos.END:
self.x = s_start + s_width
elif new_x == XPos.WCONT:
if s_width:
self.x = s_start + s_width - r_c_margin
else:
self.x = s_start
elif new_x == XPos.CENTER:
self.x = s_start + s_width / 2.0
elif new_x == XPos.LMARGIN:
self.x = self.l_margin
elif new_x == XPos.RMARGIN:
self.x = self.w - self.r_margin
# YPos.TOP: -> self.y stays the same
# YPos.LAST: -> self.y stays the same (single line)
if new_y == YPos.NEXT:
self.y += h
if new_y == YPos.TMARGIN:
self.y = self.t_margin
if new_y == YPos.BMARGIN:
self.y = self.h - self.b_margin
return page_break_triggered
def _add_quad_points(self, x: float, y: float, w: float, h: float) -> None:
self._text_quad_points[self.page].extend(
[
x * self.k,
(self.h - y) * self.k,
(x + w) * self.k,
(self.h - y) * self.k,
x * self.k,
(self.h - y - h) * self.k,
(x + w) * self.k,
(self.h - y - h) * self.k,
]
)
def _preload_bidirectional_text(
self, text: str, markdown: bool
) -> Sequence[Fragment]:
""" "
Break the text into bidirectional segments and preload font styles for each fragment
"""
if not self.text_shaping:
return self._preload_font_styles(text, markdown)
paragraph_direction = (
self.text_shaping["direction"]
if self.text_shaping["direction"]
else auto_detect_base_direction(text)
)
paragraph = BidiParagraph(text=text, base_direction=paragraph_direction)
directional_segments = paragraph.get_bidi_fragments()
self.text_shaping["paragraph_direction"] = paragraph.base_direction
fragments: list[Fragment] = []
for bidi_text, bidi_direction in directional_segments:
self.text_shaping["fragment_direction"] = bidi_direction
fragments += self._preload_font_styles(bidi_text, markdown)
return tuple(fragments)
def _preload_font_styles(
self, text: Optional[str], markdown: bool
) -> Sequence[Fragment]:
"""
When Markdown styling is enabled, we require secondary fonts
to ender text in bold & italics.
This function ensure that those fonts are available.
It needs to perform Markdown parsing,
so we return the resulting `styled_txt_frags` tuple
to avoid repeating this processing later on.
"""
if not text:
return tuple()
prev_font_style = self.font_style
if self.underline:
prev_font_style += "U"
if self.strikethrough:
prev_font_style += "S"
styled_txt_frags = tuple(self._parse_chars(text, markdown))
if markdown:
page = self.page
# We set the current to page to zero so that
# set_font() does not produce any text object on the stream buffer:
self.page = 0
if any(frag.font_style == "B" for frag in styled_txt_frags):
# Ensuring bold font is supported:
self.set_font(style="B")
if any(frag.font_style == "I" for frag in styled_txt_frags):
# Ensuring italics font is supported:
self.set_font(style="I")
if any(frag.font_style == "BI" for frag in styled_txt_frags):
# Ensuring bold italics font is supported:
self.set_font(style="BI")
if any(frag.font_style == "" for frag in styled_txt_frags):
# Ensuring base font is supported:
self.set_font(style="")
for frag in styled_txt_frags:
frag.font = self.fonts[frag.font_family + frag.font_style]
# Restoring initial style:
self.set_font(style=prev_font_style)
self.page = page
return styled_txt_frags
def get_fallback_font(self, char: str, style: str = "") -> Optional[str]:
"""
Returns which fallback font has the requested glyph.
This method can be overridden to provide more control than the `select_mode` parameter
of `FPDF.set_fallback_fonts()` provides.
"""
emphasis = TextEmphasis.coerce(style)
fonts_with_char = [
font_id
for font_id in self._fallback_font_ids
if ord(char) in self.fonts[font_id].cmap # type: ignore[union-attr]
]
if not fonts_with_char:
return None
font_with_matching_emphasis = next(
(font for font in fonts_with_char if self.fonts[font].emphasis == emphasis),
None,
)
if font_with_matching_emphasis:
return font_with_matching_emphasis
if self._fallback_font_exact_match:
return None
return fonts_with_char[0]
def _parse_chars(self, text: str, markdown: bool) -> Iterator[Fragment]:
"Split text into fragments"
if not markdown and not self.text_shaping and not self._fallback_font_ids:
if self.str_alias_nb_pages:
for seq, fragment_text in enumerate(
text.split(self.str_alias_nb_pages)
):
if seq > 0:
yield TotalPagesSubstitutionFragment(
self.str_alias_nb_pages,
self._get_current_graphics_state(),
self.k,
)
if fragment_text:
yield Fragment(
fragment_text, self._get_current_graphics_state(), self.k
)
return
yield Fragment(text, self._get_current_graphics_state(), self.k)
return
txt_frag: list[str] = []
in_bold: bool = "B" in self.font_style
in_italics: bool = "I" in self.font_style
in_strikethrough: bool = bool(self.strikethrough)
in_underline: bool = bool(self.underline)
current_fallback_font = None
current_text_script = None
def frag() -> Fragment:
nonlocal txt_frag, current_fallback_font, current_text_script
gstate = self._get_current_graphics_state()
gstate.font_style = ("B" if in_bold else "") + ("I" if in_italics else "")
gstate.strikethrough = in_strikethrough
gstate.underline = in_underline
if current_fallback_font:
style = "".join(c for c in current_fallback_font if c in ("BI"))
family = current_fallback_font.replace("B", "").replace("I", "")
gstate.font_family = family
gstate.font_style = style
gstate.current_font = self.fonts[current_fallback_font]
current_fallback_font = None
current_text_script = None
fragment = Fragment(
txt_frag,
gstate,
self.k,
)
txt_frag = []
return fragment
if self.is_ttf_font:
font_glyphs = self.current_font.cmap # type: ignore[union-attr]
else:
font_glyphs = []
escape_next_marker = 0
escape_run = 0
while text:
if markdown and text[0] == self.MARKDOWN_ESCAPE_CHARACTER:
escape_run += 1
text = text[1:]
continue
if markdown and escape_run:
is_escape_target = text[:2] in (
self.MARKDOWN_BOLD_MARKER,
self.MARKDOWN_ITALICS_MARKER,
self.MARKDOWN_STRIKETHROUGH_MARKER,
self.MARKDOWN_UNDERLINE_MARKER,
)
if is_escape_target and escape_run % 2 == 1:
for _ in range(escape_run - 1):
txt_frag.append(self.MARKDOWN_ESCAPE_CHARACTER)
if current_fallback_font:
if txt_frag:
yield frag()
current_fallback_font = None
escape_next_marker = 2
escape_run = 0
continue
for _ in range(escape_run):
txt_frag.append(self.MARKDOWN_ESCAPE_CHARACTER)
escape_run = 0
is_marker = text[:2] in (
self.MARKDOWN_BOLD_MARKER,
self.MARKDOWN_ITALICS_MARKER,
self.MARKDOWN_STRIKETHROUGH_MARKER,
self.MARKDOWN_UNDERLINE_MARKER,
)
if markdown and escape_next_marker:
is_marker = False
half_marker = text[0]
text_script = get_unicode_script(text[0])
if text_script not in (
UnicodeScript.COMMON,
UnicodeScript.UNKNOWN,
current_text_script,
):
if txt_frag and current_text_script:
yield frag()
current_text_script = text_script
if self.str_alias_nb_pages:
if text[: len(self.str_alias_nb_pages)] == self.str_alias_nb_pages:
if txt_frag:
yield frag()
gstate = self._get_current_graphics_state()
gstate.font_style = ("B" if in_bold else "") + (
"I" if in_italics else ""
)
gstate.strikethrough = in_strikethrough
gstate.underline = in_underline
yield TotalPagesSubstitutionFragment(
self.str_alias_nb_pages,
gstate,
self.k,
)
text = text[len(self.str_alias_nb_pages) :]
continue
# Check that previous & next characters are not identical to the marker:
if markdown:
if (
is_marker
and (not txt_frag or txt_frag[-1] != half_marker)
and (len(text) < 3 or text[2] != half_marker)
):
if txt_frag:
yield frag()
if text[:2] == self.MARKDOWN_BOLD_MARKER:
in_bold = not in_bold
if text[:2] == self.MARKDOWN_ITALICS_MARKER:
in_italics = not in_italics
if text[:2] == self.MARKDOWN_STRIKETHROUGH_MARKER:
in_strikethrough = not in_strikethrough
if text[:2] == self.MARKDOWN_UNDERLINE_MARKER:
in_underline = not in_underline
text = text[2:]
continue
is_link = self.MARKDOWN_LINK_REGEX.match(text)
if is_link:
link_text, link_dest, text = is_link.groups()
if txt_frag:
yield frag()
gstate = self._get_current_graphics_state()
gstate.underline = self.MARKDOWN_LINK_UNDERLINE
if self.MARKDOWN_LINK_COLOR:
gstate.text_color = convert_to_device_color(
self.MARKDOWN_LINK_COLOR
)
try:
page = int(link_dest)
link_dest = self.add_link(page=page)
except ValueError:
pass
yield Fragment(
list(link_text),
gstate,
self.k,
link=link_dest,
)
continue
if self.is_ttf_font and text[0] != "\n" and not ord(text[0]) in font_glyphs:
style = ("B" if in_bold else "") + ("I" if in_italics else "")
fallback_font = self.get_fallback_font(text[0], style)
if fallback_font:
if fallback_font == current_fallback_font:
txt_frag.append(text[0])
text = text[1:]
continue
if txt_frag:
yield frag()
current_fallback_font = fallback_font
txt_frag.append(text[0])
text = text[1:]
continue
if current_fallback_font:
if txt_frag:
yield frag()
current_fallback_font = None
txt_frag.append(text[0])
text = text[1:]
if markdown and escape_next_marker:
escape_next_marker -= 1
if escape_next_marker == 0:
yield frag()
if markdown and escape_run:
for _ in range(escape_run):
txt_frag.append(self.MARKDOWN_ESCAPE_CHARACTER)
escape_run = 0
if txt_frag:
yield frag()
def will_page_break(self, height: float) -> bool:
"""
Let you know if adding an element will trigger a page break,
based on its height and the current ordinate (`y` position).
Detailed documentation on page breaks: https://py-pdf.github.io/fpdf2/PageBreaks.html
Args:
height (float): height of the section that would be added, e.g. a cell
Returns: a boolean indicating if a page break would occur
"""
return (
self.y + height > self.page_break_trigger
and not self.in_footer
and self.accept_page_break
)
def _perform_page_break_if_need_be(self, h: float) -> bool:
if self.will_page_break(h):
LOGGER.debug(
"Page break on page %d at y=%d for element of height %d > %d",
self.page,
self.y,
h,
self.page_break_trigger,
)
self._perform_page_break()
return True
return False
def _perform_page_break(self) -> None:
"""
Performs a page break, taking care to preserve self.x
and a potential existing `fpdf.fpdf.FPDF.local_context()`.
A call to `fpdf.fpdf.FPDF.will_page_break()` should be performed beforehand.
"""
x = self.x
# If we are in a .local_context(), we need to temporarily leave it,
# by popping out every GraphicsState:
gs_stack: list[StateStackType] = []
while self._is_current_graphics_state_nested():
gs_stack.append(self._get_current_graphics_state())
self._pop_local_stack()
# This code assumes that every Graphics State in the stack
# has been pushed in it while adding a "q" in the PDF stream
# (which is what FPDF.local_context() does):
self._end_local_context()
# Using a temporary GS to render header & footer:
self.current_font_is_set_on_page = False
self._push_local_stack()
self.add_page(same=True)
self._pop_local_stack()
for prev_gs in reversed(gs_stack):
self._push_local_stack()
prev_gs.current_font_is_set_on_page = False
self._start_local_context(**prev_gs.as_kwargs())
self.x = x # restore x but not y after drawing header
def _has_next_page(self) -> bool:
return self.pages_count > self.page
@contextmanager
def _disable_writing(self) -> Iterator[None]:
if not isinstance(self._out, types.MethodType):
# This mean that self._out has already been redefined.
# This is the case of a nested call to this method: we do nothing
yield
return
self._out = lambda *args, **kwargs: None # type: ignore[method-assign]
prev_page, prev_pages_count, prev_x, prev_y = (
self.page,
self.pages_count,
self.x,
self.y,
)
annots = self.pages[self.page].annots or PDFArray()
self._push_local_stack()
try:
yield
finally:
self._pop_local_stack()
# restore location:
for p in range(prev_pages_count + 1, self.pages_count + 1):
del self.pages[p]
self.page = prev_page
self.pages[self.page].annots = annots
self.set_xy(prev_x, prev_y)
# restore writing function:
del self._out
# multi_cell has dynamic results depending on the `output` parameter
MultiCellPageBreakResult: TypeAlias = bool
MultiCellLinesResult: TypeAlias = list[str]
MultiCellHeightResult: TypeAlias = float
MultiCellResult: TypeAlias = (
MultiCellPageBreakResult
| MultiCellLinesResult
| MultiCellHeightResult
| tuple[MultiCellPageBreakResult, MultiCellLinesResult]
| tuple[MultiCellPageBreakResult, MultiCellHeightResult]
| tuple[MultiCellLinesResult, MultiCellHeightResult]
| tuple[MultiCellPageBreakResult, MultiCellLinesResult, MultiCellHeightResult]
)
@check_page
@support_deprecated_txt_arg
def multi_cell(
self,
w: float,
h: Optional[float] = None,
text: str = "",
border: Literal[0, 1] | str = 0,
align: str | Align = Align.J,
fill: bool = False,
split_only: bool = False, # DEPRECATED
link: Optional[int | str] = None,
ln: Literal["DEPRECATED"] = "DEPRECATED",
max_line_height: Optional[float] = None,
markdown: bool = False,
print_sh: bool = False,
new_x: str | XPos = XPos.RIGHT,
new_y: str | YPos = YPos.NEXT,
wrapmode: WrapMode = WrapMode.WORD,
dry_run: bool = False,
output: str | MethodReturnValue = MethodReturnValue.PAGE_BREAK,
center: bool = False,
padding: int | Sequence[int] | Padding = 0,
) -> MultiCellResult:
"""
This method allows printing text with line breaks. They can be automatic
(breaking at the most recent space or soft-hyphen character) as soon as the text
reaches the right border of the cell, or explicit (via the `\\n` character).
As many cells as necessary are stacked, one below the other.
Text can be aligned, centered or justified. The cell block can be framed and
the background painted. A cell has an horizontal padding, on the left & right sides,
defined by the.c_margin property.
Args:
w (float): cell width. If 0, they extend up to the right margin of the page.
h (float): height of a single line of text. Default value: None, meaning to use the current font size.
text (str): string to print.
border: Indicates if borders must be drawn around the cell.
The value can be either a number (`0`: no border ; `1`: frame)
or a string containing some or all of the following characters
(in any order):
`L`: left ; `T`: top ; `R`: right ; `B`: bottom. Default value: 0.
align (fpdf.enums.Align, str): Set text alignment inside the cell.
Possible values are:
`J`: justify (default value); `L` or empty string: left align;
`C`: center; `X`: center around current x position; `R`: right align
fill (bool): Indicates if the cell background must be painted (`True`)
or transparent (`False`). Default value: False.
split_only (bool): **DEPRECATED since 2.7.4**:
Use `dry_run=True` and `output=("LINES",)` instead.
link (str): optional link to add on the cell, internal
(identifier returned by `add_link`) or external URL.
new_x (fpdf.enums.XPos, str): New current position in x after the call. Default: RIGHT
new_y (fpdf.enums.YPos, str): New current position in y after the call. Default: NEXT
ln (int): **DEPRECATED since 2.5.1**: Use `new_x` and `new_y` instead.
max_line_height (float): optional maximum height of each sub-cell generated
markdown (bool): enable minimal markdown-like markup to render part
of text as bold / italics / strikethrough / underlined.
Supports `\\` as escape character. Default to False.
print_sh (bool): Treat a soft-hyphen (\\u00ad) as a normal printable
character, instead of a line breaking opportunity. Default value: False
wrapmode (fpdf.enums.WrapMode): "WORD" for word based line wrapping (default),
"CHAR" for character based line wrapping.
dry_run (bool): if `True`, does not output anything in the document.
Can be useful when combined with `output`.
output (fpdf.enums.MethodReturnValue): defines what this method returns.
If several enum values are joined, the result will be a tuple.
txt (str): [**DEPRECATED since v2.7.6**] string to print.
center (bool): center the cell horizontally on the page.
padding (float or Sequence): padding to apply around the text. Default value: 0.
When one value is specified, it applies the same padding to all four sides.
When two values are specified, the first padding applies to the top and bottom, the second to
the left and right. When three values are specified, the first padding applies to the top,
the second to the right and left, the third to the bottom. When four values are specified,
the paddings apply to the top, right, bottom, and left in that order (clockwise)
If padding for left or right ends up being non-zero then respective c_margin is ignored.
Center overrides values for horizontal padding
Using `new_x=XPos.RIGHT, new_y=XPos.TOP, maximum height=pdf.font_size` is
useful to build tables with multiline text in cells.
Returns: a single value or a tuple, depending on the `output` parameter value
"""
padding = Padding.new(padding)
wrapmode = WrapMode.coerce(wrapmode)
if split_only:
warnings.warn(
(
'The parameter "split_only" is deprecated since v2.7.4.'
' Use instead dry_run=True and output="LINES".'
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
if dry_run or split_only:
with self._disable_writing():
return self.multi_cell(
w=w,
h=h,
text=text,
border=border,
align=align,
fill=fill,
link=link,
ln=ln,
max_line_height=max_line_height,
markdown=markdown,
print_sh=print_sh,
new_x=new_x,
new_y=new_y,
wrapmode=wrapmode,
dry_run=False,
split_only=False,
output=MethodReturnValue.LINES if split_only else output,
center=center,
padding=padding,
)
if not self.font_family:
raise FPDFException("No font set, you need to call set_font() beforehand")
if isinstance(w, str) or isinstance(h, str):
raise ValueError(
"Parameter 'w' and 'h' must be numbers, not strings."
" You can omit them by passing string content with text="
)
new_x = XPos.coerce(new_x)
new_y = YPos.coerce(new_y)
if ln != "DEPRECATED":
# For backwards compatibility, if "ln" is used we overwrite "new_[xy]".
if ln == 0:
new_x = XPos.RIGHT
new_y = YPos.NEXT
elif ln == 1:
new_x = XPos.LMARGIN
new_y = YPos.NEXT
elif ln == 2:
new_x = XPos.LEFT
new_y = YPos.NEXT
elif ln == 3:
new_x = XPos.RIGHT
new_y = YPos.TOP
else:
raise ValueError(
f'Invalid value for parameter "ln" ({ln}),'
" must be an int between 0 and 3."
)
warnings.warn(
(
'The parameter "ln" is deprecated since v2.5.2.'
f" Instead of ln={ln} use new_x=XPos.{new_x.name}, new_y=YPos.{new_y.name}."
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
align = Align.coerce(align)
page_break_triggered = False
if h is None:
h = self.font_size
# If width is 0, set width to available width between margins
if w == 0:
w = self.w - self.r_margin - self.x
# Store the starting position before applying padding
prev_x, prev_y = self.x, self.y
# Apply padding to contents
# decrease maximum allowed width by padding
# shift the starting point by padding
maximum_allowed_width = w = w - padding.right - padding.left
clearance_margins: list[float] = []
# If we don't have padding on either side, we need a clearance margin.
if not padding.left:
clearance_margins.append(self.c_margin)
if not padding.right:
clearance_margins.append(self.c_margin)
if align != Align.X:
self.x += padding.left
self.y += padding.top
# Center overrides padding
if center:
self.x = (
self.w / 2 if align == Align.X else self.l_margin + (self.epw - w) / 2
)
prev_x = self.x
# Calculate text length
text = self.normalize_text(text)
normalized_string = text.replace("\r", "")
styled_text_fragments = (
self._preload_bidirectional_text(normalized_string, markdown)
if self.text_shaping
else self._preload_font_styles(normalized_string, markdown)
)
prev_current_font = self.current_font
prev_font_style = self.font_style
prev_underline = self.underline
total_height: float = 0
text_lines: list[TextLine] = []
multi_line_break = MultiLineBreak(
styled_text_fragments,
maximum_allowed_width,
clearance_margins,
align=align,
print_sh=print_sh,
wrapmode=wrapmode,
)
text_line = multi_line_break.get_line()
while (text_line) is not None:
text_lines.append(text_line)
text_line = multi_line_break.get_line()
if not text_lines: # ensure we display at least one cell - cf. issue #349
text_lines = [
TextLine(
[],
text_width=0,
number_of_spaces=0,
align=align,
height=h,
max_width=w,
trailing_nl=False,
)
]
if max_line_height is None or len(text_lines) == 1:
line_height = h
else:
line_height = min(h, max_line_height)
box_required = fill or border
page_break_triggered = False
for text_line_index, text_line in enumerate(text_lines):
start_of_new_page = self._perform_page_break_if_need_be(h + padding.bottom)
if start_of_new_page:
page_break_triggered = True
self.y += padding.top
if box_required and (text_line_index == 0 or start_of_new_page):
# estimate how many cells can fit on this page
top_gap = self.y # Top padding has already been added
bottom_gap = padding.bottom + self.b_margin
lines_before_break = int((self.h - top_gap - bottom_gap) // line_height)
# check how many cells should be rendered
num_lines = min(lines_before_break, len(text_lines) - text_line_index)
box_height = max(
h - text_line_index * line_height, num_lines * line_height
)
# render the box
x = self.x - (w / 2 if align == Align.X else 0)
draw_box_borders(
self,
x - padding.left,
self.y - padding.top,
x + w + padding.right,
self.y + box_height + padding.bottom,
border,
self.fill_color if fill else None,
)
is_last_line = text_line_index == len(text_lines) - 1
self._render_styled_text_line(
text_line,
h=line_height,
new_x=new_x if is_last_line else XPos.LEFT,
new_y=new_y if is_last_line else YPos.NEXT,
border=0, # already rendered
fill=False, # already rendered
link=link,
padding=Padding(0, padding.right, 0, padding.left),
prevent_font_change=markdown,
)
total_height += line_height
if not is_last_line and align == Align.X:
# prevent cumulative shift to the left
self.x = prev_x
if total_height < h:
# Move to the bottom of the multi_cell
if new_y == YPos.NEXT:
self.y += h - total_height
total_height = h
if page_break_triggered and new_y == YPos.TOP:
# When a page jump is performed and the requested y is TOP,
# pretend we started at the top of the text block on the new page.
# cf. test_multi_cell_table_with_automatic_page_break
prev_y = self.y
last_line = text_lines[-1]
if last_line and last_line.trailing_nl and new_y in (YPos.LAST, YPos.NEXT):
# The line renderer can't handle trailing newlines in the text.
self.ln()
if new_y == YPos.TOP: # We may have jumped a few lines -> reset
self.y = prev_y
elif new_y == YPos.NEXT: # move down by bottom padding
self.y += padding.bottom
if markdown:
self.font_style = prev_font_style
self.current_font = prev_current_font
self.underline = prev_underline
if new_x == XPos.RIGHT: # move right by right padding to align outer RHS edge
self.x += padding.right
elif new_x == XPos.LEFT: # move left by left padding to align outer LHS edge
self.x -= padding.left
output = MethodReturnValue.coerce(output)
return_value = ()
if output & MethodReturnValue.PAGE_BREAK:
return_value += (page_break_triggered,) # type: ignore[assignment]
if output & MethodReturnValue.LINES:
output_lines: list[str] = []
for text_line in text_lines:
characters: list[str] = []
for frag in text_line.fragments:
characters.extend(frag.characters)
output_lines.append("".join(characters))
return_value += (output_lines,) # type: ignore[assignment]
if output & MethodReturnValue.HEIGHT:
return_value += (total_height + padding.top + padding.bottom,) # type: ignore[assignment]
if len(return_value) == 1:
return return_value[0]
return return_value # type: ignore[return-value]
@check_page
@support_deprecated_txt_arg
def write(
self,
h: Optional[float] = None,
text: str = "",
link: Optional[str | int] = "",
print_sh: bool = False,
wrapmode: WrapMode = WrapMode.WORD,
) -> bool:
"""
Prints text from the current position.
When the right margin is reached, a line break occurs at the most recent
space or soft-hyphen character, and text continues from the left margin.
A manual break happens any time the \\n character is met,
Upon method exit, the current position is left just at the end of the text.
Args:
h (float): line height. Default value: None, meaning to use the current font size.
text (str): text content
link (str): optional link to add on the text, internal
(identifier returned by `FPDF.add_link`) or external URL.
print_sh (bool): Treat a soft-hyphen (\\u00ad) as a normal printable
character, instead of a line breaking opportunity. Default value: False
wrapmode (fpdf.enums.WrapMode): "WORD" for word based line wrapping (default),
"CHAR" for character based line wrapping.
txt (str): [**DEPRECATED since v2.7.6**] text content
"""
wrapmode = WrapMode.coerce(wrapmode)
if not self.font_family:
raise FPDFException("No font set, you need to call set_font() beforehand")
if isinstance(h, str):
raise ValueError(
"Parameter 'h' must be a number, not a string."
" You can omit it by passing string content with text="
)
if h is None:
h = self.font_size
page_break_triggered = False
normalized_string = self.normalize_text(text).replace("\r", "")
styled_text_fragments = (
self._preload_bidirectional_text(normalized_string, False)
if self.text_shaping
else self._preload_font_styles(normalized_string, False)
)
text_lines: list[TextLine] = []
multi_line_break = MultiLineBreak(
styled_text_fragments,
lambda _height: max_width, # pyright: ignore[reportUnknownLambdaType]
(self.c_margin, self.c_margin),
print_sh=print_sh,
wrapmode=wrapmode,
)
# first line from current x position to right margin
first_width = self.w - self.x - self.r_margin
max_width = first_width
text_line = multi_line_break.get_line()
# remaining lines fill between margins
full_width = self.w - self.l_margin - self.r_margin
max_width = full_width
while (text_line) is not None:
text_lines.append(text_line)
text_line = multi_line_break.get_line()
if not text_lines:
return False
for text_line_index, text_line in enumerate(text_lines):
if text_line_index > 0:
self.ln()
new_page = self._render_styled_text_line(
text_line,
h=h,
border=0,
new_x=XPos.WCONT,
new_y=YPos.TOP,
fill=False,
link=link,
)
page_break_triggered = page_break_triggered or new_page
if text_line is not None and text_line.trailing_nl:
# The line renderer can't handle trailing newlines in the text.
self.ln()
return page_break_triggered
@check_page
def text_columns(
self,
text: Optional[str] = None,
img: Optional[str] = None,
img_fill_width: bool = False,
ncols: int = 1,
gutter: Optional[float] = 10,
balance: bool = False,
text_align: Optional[Align | str] = "LEFT",
line_height: Optional[float] = 1,
l_margin: Optional[float] = None,
r_margin: Optional[float] = None,
print_sh: Optional[bool] = False,
wrapmode: Optional[WrapMode] = WrapMode.WORD,
skip_leading_spaces: Optional[bool] = False,
) -> TextColumns:
"""Establish a layout with multiple columns to fill with text.
Args:
text (str, optional): A first piece of text to insert.
ncols (int, optional): the number of columns to create. (Default: 1).
gutter (float, optional): The distance between the columns. (Default: 10).
balance: (bool, optional): Specify whether multiple columns should end at approximately
the same height, if they don't fill the page. (Default: False)
text_align (Align or str, optional): The alignment of the text within the region.
(Default: "LEFT")
line_height (float, optional): A multiplier relative to the font size changing the
vertical space occupied by a line of text. (Default: 1.0).
l_margin (float, optional): Override the current left page margin.
r_margin (float, optional): Override the current right page margin.
print_sh (bool, optional): Treat a soft-hyphen (\\u00ad) as a printable character,
instead of a line breaking opportunity. (Default: False)
wrapmode (fpdf.enums.WrapMode, optional): "WORD" for word based line wrapping,
"CHAR" for character based line wrapping. (Default: "WORD")
skip_leading_spaces (bool, optional): On each line, any space characters at the
beginning will be skipped if True. (Default: False)
"""
return TextColumns(
self,
text=text,
img=img,
img_fill_width=img_fill_width,
ncols=ncols,
gutter=gutter or 10,
balance=balance,
text_align=text_align,
line_height=line_height,
l_margin=l_margin,
r_margin=r_margin,
print_sh=print_sh,
wrapmode=wrapmode,
skip_leading_spaces=skip_leading_spaces,
)
def image(
self,
name: ImageType,
x: Optional[float | Align] = None,
y: Optional[float] = None,
w: float = 0,
h: float = 0,
type: str | Literal["DEPRECATED"] | None = "",
link: Optional[str | int] = "",
title: Optional[str] = None,
alt_text: Optional[str] = None,
dims: Optional[tuple[float, float]] = None,
keep_aspect_ratio: bool = False,
) -> RasterImageInfo | VectorImageInfo:
"""
Put an image on the page.
The size of the image on the page can be specified in different ways:
* explicit width and height (expressed in user units)
* one explicit dimension, the other being calculated automatically
in order to keep the original proportions
* no explicit dimension, in which case the image is put at 72 dpi.
* explicit width and height (expressed in user units) and `keep_aspect_ratio=True`
**Remarks**:
* if an image is used several times, only one copy is embedded in the file.
* when using an animated GIF, only the first frame is used.
Args:
name: either a string representing a file path to an image, an URL to an image,
bytes, an io.BytesIO, or a instance of `PIL.Image.Image`
x (float, fpdf.enums.Align): optional horizontal position where to put the image on the page.
If not specified or equal to None, the current abscissa is used.
`fpdf.enums.Align.C` can also be passed to center the image horizontally;
and `fpdf.enums.Align.R` to place it along the right page margin
y (float): optional vertical position where to put the image on the page.
If not specified or equal to None, the current ordinate is used.
After the call, the current ordinate is moved to the bottom of the image
w (float): optional width of the image. If not specified or equal to zero,
it is automatically calculated from the image size.
Pass `pdf.epw` to scale horizontally to the full page width.
h (float): optional height of the image. If not specified or equal to zero,
it is automatically calculated from the image size.
Pass `pdf.eph` to scale horizontally to the full page height.
type (str): [**DEPRECATED since 2.2.0**] unused, will be removed in a later version.
link (str): optional link to add on the image, internal
(identifier returned by `FPDF.add_link`) or external URL.
title (str): optional. Currently, never seem rendered by PDF readers.
alt_text (str): optional alternative text describing the image,
for accessibility purposes. Displayed by some PDF readers on hover.
dims (Tuple[float]): optional dimensions as a tuple (width, height) to resize the image
before storing it in the PDF. Note that those are the **intrinsic** image dimensions,
but the image will still be rendered on the page with the width (`w`) and height (`h`)
provided as parameters. Note also that the `.oversized_images` attribute of FPDF
provides an automated way to auto-adjust those intrinsic image dimensions.
keep_aspect_ratio (bool): ensure the image fits in the rectangle defined by `x`, `y`, `w` & `h`
while preserving its original aspect ratio. Defaults to False.
Only meaningful if both `w` & `h` are provided.
If `y` is provided, this method will not trigger any page break;
otherwise, auto page break detection will be performed.
Returns: an instance of a subclass of `ImageInfo`.
"""
if not self.page:
raise FPDFException("No page open, you need to call add_page() first")
if type:
warnings.warn(
(
'"type" parameter is deprecated since v2.2.0, '
"unused and will soon be removed"
),
DeprecationWarning,
stacklevel=get_stack_level(),
)
name, img, info = preload_image(self.image_cache, name, dims)
if isinstance(info, VectorImageInfo):
return self._vector_image(
name,
cast(SVGObject, img),
info,
x,
y,
w,
h,
link,
title,
alt_text,
keep_aspect_ratio,
)
if TYPE_CHECKING:
assert not isinstance(img, SVGObject)
return self._raster_image(
name,
img,
info,
x,
y,
w,
h,
link,
title,
alt_text,
dims,
keep_aspect_ratio,
)
def _raster_image(
self,
name: str,
img: ImageType,
info: RasterImageInfo,
x: Optional[float | Align] = None,
y: Optional[float] = None,
w: float = 0,
h: float = 0,
link: Optional[str | int] = "",
title: Optional[str] = None,
alt_text: Optional[str] = None,
dims: Optional[tuple[float, float]] = None,
keep_aspect_ratio: bool = False,
) -> RasterImageInfo:
if "smask" in info:
self._set_min_pdf_version("1.4")
# Automatic width and height calculation if needed
w, h = info.size_in_document_units(w, h, scale=self.k)
# Flowing mode
if y is None:
self._perform_page_break_if_need_be(h)
y = self.y
self.y += h
if x is None:
x = self.x
if not isinstance(x, NumberClass):
x = self.x_by_align(x, w, h, info, keep_aspect_ratio)
if TYPE_CHECKING:
x = float(x)
if keep_aspect_ratio:
x, y, w, h = info.scale_inside_box(x, y, w, h)
if self.oversized_images and info["usages"] == 1 and not dims:
info = self._downscale_image(name, img, info, w, h, scale=self.k)
stream_content = stream_content_for_raster_image(
info, x, y, w, h, keep_aspect_ratio, scale=self.k, pdf_height_to_flip=self.h
)
if title or alt_text:
with self._marked_sequence(title=title, alt_text=alt_text):
self._out(stream_content)
else:
self._out(stream_content)
if link:
self.link(x, y, w, h, link)
self._resource_catalog.add(
PDFResourceType.X_OBJECT, info["i"], self.page # type: ignore
)
info["rendered_width"] = w
info["rendered_height"] = h
return info
def x_by_align(
self,
x: Align | str,
w: float,
h: float,
img_info: RasterImageInfo | VectorImageInfo,
keep_aspect_ratio: bool,
) -> float:
if keep_aspect_ratio:
_, _, w, h = img_info.scale_inside_box(0, 0, w, h)
x = Align.coerce(x)
if x == Align.C:
return (self.w - w) / 2
if x == Align.R:
return self.w - w - self.r_margin
if x == Align.L:
return self.l_margin
raise ValueError(f"Unsupported 'x' value passed to .image(): {x}")
def _vector_image(
self,
name: str,
svg: SVGObject,
info: VectorImageInfo,
x: Optional[float | Align] = None,
y: Optional[float] = None,
w: float = 0,
h: float = 0,
link: Optional[str | int] = "",
title: Optional[str] = None,
alt_text: Optional[str] = None,
keep_aspect_ratio: bool = False,
) -> VectorImageInfo:
if not svg.viewbox and svg.width and svg.height:
warnings.warn(
'