Module fpdf.errors

Classes

class ComplianceError (*args, **kwargs)
Expand source code Browse git 
class ComplianceError(FPDFException):
    """Base class for standards-compliance violations (PDF/A, PDF/X, etc.)."""

Base class for standards-compliance violations (PDF/A, PDF/X, etc.).

Ancestors

Subclasses

class FPDFException (*args, **kwargs)
Expand source code Browse git 
class FPDFException(Exception):
    pass

Common base class for all non-exit exceptions.

Ancestors

  • builtins.Exception
  • builtins.BaseException

Subclasses

class FPDFPageFormatException (argument: str, unknown: bool = False, one: bool = False)
Expand source code Browse git 
class FPDFPageFormatException(FPDFException):
    """Error is thrown when a bad page format is given"""

    def __init__(self, argument: str, unknown: bool = False, one: bool = False) -> None:
        super().__init__()
        if unknown and one:
            raise TypeError(
                "FPDF Page Format Exception cannot be both for "
                "unknown type and for wrong number of arguments"
            )
        self.argument = argument
        self.unknown = unknown
        self.one = one

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__name__}"
            f"({self.argument!r}, {self.unknown!r}, {self.one!r})"
        )

    def __str__(self) -> str:
        if self.unknown:
            res = f"Unknown page format: {self.argument}"
        elif self.one:
            res = f"Only one argument given: {self.argument}. Need (height,width)"
        else:
            res = self.argument
        return f"{self.__class__.__name__ }: {res}"

Error is thrown when a bad page format is given

Ancestors

class FPDFResourceAccessError (*args, **kwargs)
Expand source code Browse git 
class FPDFResourceAccessError(FPDFException):
    """Raised when loading a resource violates the active resource access policy."""

Raised when loading a resource violates the active resource access policy.

Ancestors

class FPDFSvgLimitExceeded (*args, **kwargs)
Expand source code Browse git 
class FPDFSvgLimitExceeded(FPDFException):
    """Raised when an SVG file exceeds the configured limits for use depth or resolved elements."""

Raised when an SVG file exceeds the configured limits for use depth or resolved elements.

Ancestors

class FPDFUnicodeEncodingException (text_index: int, character: str, font_name: str)
Expand source code Browse git 
class FPDFUnicodeEncodingException(FPDFException):
    """Error is thrown when a character that cannot be encoded by the chosen encoder is provided"""

    def __init__(self, text_index: int, character: str, font_name: str) -> None:
        super().__init__()
        self.text_index = text_index
        self.character = character
        self.font_name = font_name

    def __repr__(self) -> str:
        return f"{self.__class__.__name__}({repr(self.text_index), repr(self.character), repr(self.font_name)})"

    def __str__(self) -> str:
        return (
            f'Character "{self.character}" at index {self.text_index} in text is outside the range of characters'
            f' supported by the font used: "{self.font_name}".'
            " Please consider using a Unicode font."
        )

Error is thrown when a character that cannot be encoded by the chosen encoder is provided

Ancestors

class PDFAComplianceError (*args, **kwargs)
Expand source code Browse git 
class PDFAComplianceError(ComplianceError):
    """Raised when an operation would produce a PDF that violates the selected PDF/A profile."""

Raised when an operation would produce a PDF that violates the selected PDF/A profile.

Ancestors