Module fpdf.annotations

Classes

class AnnotationDict (subtype: str, x: int, y: int, width: int, height: int, flags: Tuple[AnnotationFlag] = (<AnnotationFlag.PRINT: 4>,), contents: str = None, dest: Destination = None, action: Action = None, color: tuple = None, modification_time: datetime.datetime = None, title: str = None, quad_points: tuple = None, border_width: int = 0, name: Union[AnnotationName, FileAttachmentAnnotationName] = None, ink_list: Tuple[int] = (), file_spec: str = None, field_type: str = None, value=None)

A PDF annotation that get serialized as an inline <>

Expand source code

class AnnotationDict(AnnotationMixin):
    "A PDF annotation that get serialized as an inline <<dictionnary>>"
    __slots__ = (  # RAM usage optimization
        "type",
        "subtype",
        "rect",
        "border",
        "f_t",
        "v",
        "f",
        "contents",
        "a",
        "dest",
        "c",
        "t",
        "quad_points",
        "p",
        "name",
        "ink_list",
        "f_s",
    )

    def serialize(self, _security_handler=None, _obj_id=None):
        obj_dict = build_obj_dict(
            {key: getattr(self, key) for key in dir(self)},
            _security_handler=_security_handler,
            _obj_id=_obj_id,
        )
        return pdf_dict(obj_dict)

    def __repr__(self):
        keys = [key for key in dir(self) if not key.startswith("__")]
        d = {key: getattr(self, key) for key in keys}
        d = {key: value for key, value in d.items() if not callable(value)}
        return f"AnnotationDict(**{d})"

Ancestors

• AnnotationMixin

Instance variables

var a

Return an attribute of instance, which is of type owner.

var border

Return an attribute of instance, which is of type owner.

var c

Return an attribute of instance, which is of type owner.

var contents

Return an attribute of instance, which is of type owner.

var dest

Return an attribute of instance, which is of type owner.

var f

Return an attribute of instance, which is of type owner.

var f_s

Return an attribute of instance, which is of type owner.

var f_t

Return an attribute of instance, which is of type owner.

var ink_list

Return an attribute of instance, which is of type owner.

var name

Return an attribute of instance, which is of type owner.

var p

Return an attribute of instance, which is of type owner.

var quad_points

Return an attribute of instance, which is of type owner.

var rect

Return an attribute of instance, which is of type owner.

var subtype

Return an attribute of instance, which is of type owner.

var t

Return an attribute of instance, which is of type owner.

var type

Return an attribute of instance, which is of type owner.

var v

Return an attribute of instance, which is of type owner.

Methods

def serialize(self)

Expand source code

def serialize(self, _security_handler=None, _obj_id=None):
    obj_dict = build_obj_dict(
        {key: getattr(self, key) for key in dir(self)},
        _security_handler=_security_handler,
        _obj_id=_obj_id,
    )
    return pdf_dict(obj_dict)

class AnnotationMixin (subtype: str, x: int, y: int, width: int, height: int, flags: Tuple[AnnotationFlag] = (<AnnotationFlag.PRINT: 4>,), contents: str = None, dest: Destination = None, action: Action = None, color: tuple = None, modification_time: datetime.datetime = None, title: str = None, quad_points: tuple = None, border_width: int = 0, name: Union[AnnotationName, FileAttachmentAnnotationName] = None, ink_list: Tuple[int] = (), file_spec: str = None, field_type: str = None, value=None)

Expand source code

class AnnotationMixin:
    def __init__(
        self,
        subtype: str,
        x: int,
        y: int,
        width: int,
        height: int,
        flags: Tuple[AnnotationFlag] = DEFAULT_ANNOT_FLAGS,
        contents: str = None,
        dest: Destination = None,
        action: Action = None,
        color: tuple = None,
        modification_time: datetime = None,
        title: str = None,
        quad_points: tuple = None,
        border_width: int = 0,  # PDF readers support: displayed by Acrobat but not Sumatra
        name: Union[AnnotationName, FileAttachmentAnnotationName] = None,
        ink_list: Tuple[int] = (),  # for ink annotations
        file_spec: str = None,
        field_type: str = None,
        value=None,
    ):
        self.type = Name("Annot")
        self.subtype = Name(subtype)
        self.rect = f"[{x:.2f} {y:.2f} {x + width:.2f} {y - height:.2f}]"
        self.border = f"[0 0 {border_width}]"
        self.f_t = Name(field_type) if field_type else None
        self.v = value
        self.f = sum(flags)
        self.contents = enclose_in_parens(contents) if contents else None
        self.a = action
        self.dest = dest
        self.c = f"[{color[0]} {color[1]} {color[2]}]" if color else None
        self.t = enclose_in_parens(title) if title else None
        self.m = format_date(modification_time) if modification_time else None
        self.quad_points = (
            pdf_list(f"{quad_point:.2f}" for quad_point in quad_points)
            if quad_points
            else None
        )
        self.p = None  # must always be set before calling .serialize()
        self.name = name
        self.ink_list = (
            ("[" + pdf_list(f"{coord:.2f}" for coord in ink_list) + "]")
            if ink_list
            else None
        )
        self.f_s = file_spec

Subclasses

• AnnotationDict
• PDFAnnotation

class FileSpec (embedded_file: PDFEmbeddedFile, basename: str, desc: str)

FileSpec(embedded_file, basename, desc)

Expand source code

class FileSpec(NamedTuple):
    embedded_file: PDFEmbeddedFile
    basename: str
    desc: str

    def serialize(self, _security_handler=None, _obj_id=None):
        obj_dict = {
            "/Type": "/Filespec",
            "/F": enclose_in_parens(self.basename),
            "/EF": pdf_dict({"/F": pdf_ref(self.embedded_file.id)}),
        }
        if self.desc:
            obj_dict["/Desc"] = enclose_in_parens(self.desc)
        return pdf_dict(obj_dict, field_join=" ")

Ancestors

• builtins.tuple

Instance variables

var basename : str

Alias for field number 1

var desc : str

Alias for field number 2

var embedded_file : PDFEmbeddedFile

Alias for field number 0

Methods

def serialize(self)

Expand source code

def serialize(self, _security_handler=None, _obj_id=None):
    obj_dict = {
        "/Type": "/Filespec",
        "/F": enclose_in_parens(self.basename),
        "/EF": pdf_dict({"/F": pdf_ref(self.embedded_file.id)}),
    }
    if self.desc:
        obj_dict["/Desc"] = enclose_in_parens(self.desc)
    return pdf_dict(obj_dict, field_join=" ")

class PDFAnnotation (*args, **kwargs)

A PDF annotation that get serialized as an obj<>endobj block

Expand source code

class PDFAnnotation(AnnotationMixin, PDFObject):
    "A PDF annotation that get serialized as an obj<</>>endobj block"

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

Ancestors

• AnnotationMixin
• PDFObject

Inherited members

• PDFObject:
  • content_stream
  • serialize

class PDFEmbeddedFile (basename: str, contents: bytes, desc: str = '', creation_date: datetime.datetime = None, modification_date: datetime.datetime = None, compress: bool = False, checksum: bool = False)

Main features of this class: * delay ID assignement * implement serializing

Expand source code

class PDFEmbeddedFile(PDFContentStream):
    def __init__(
        self,
        basename: str,
        contents: bytes,
        desc: str = "",
        creation_date: datetime = None,
        modification_date: datetime = None,
        compress: bool = False,
        checksum: bool = False,
    ):
        super().__init__(contents=contents, compress=compress)
        self.type = Name("EmbeddedFile")
        params = {"/Size": len(contents)}
        if creation_date:
            params["/CreationDate"] = format_date(creation_date, with_tz=True)
        if modification_date:
            params["/ModDate"] = format_date(modification_date, with_tz=True)
        if checksum:
            file_hash = hashlib.new("md5", usedforsecurity=False)
            file_hash.update(self._contents)
            hash_hex = file_hash.hexdigest()
            params["/CheckSum"] = f"<{hash_hex}>"
        self.params = pdf_dict(params)
        self._basename = basename  # private so that it does not get serialized
        self._desc = desc  # private so that it does not get serialized
        self._globally_enclosed = True

    def globally_enclosed(self):
        return self._globally_enclosed

    def set_globally_enclosed(self, value):
        self._globally_enclosed = value

    def basename(self):
        return self._basename

    def file_spec(self):
        return FileSpec(self, self._basename, self._desc)

Ancestors

• PDFContentStream
• PDFObject

Methods

def basename(self)

Expand source code

def basename(self):
    return self._basename

def file_spec(self)

Expand source code

def file_spec(self):
    return FileSpec(self, self._basename, self._desc)

def globally_enclosed(self)

Expand source code

def globally_enclosed(self):
    return self._globally_enclosed

def set_globally_enclosed(self, value)

Expand source code

def set_globally_enclosed(self, value):
    self._globally_enclosed = value

Inherited members

• PDFContentStream:
  • content_stream
  • serialize