pypdfium2

https://pypdfium2.readthedocs.io
Admin
pypdfium2 is an ABI-level Python 3 binding to PDFium, a powerful and liberal-licensed library for...
Tokens:140,998
Snippets:906
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install pypdfium2 with default setup

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Default installation command for pypdfium2 from the source directory. It invokes setup.py, which typically downloads a binary from pdfium-binaries and runs ctypesgen to generate bindings. If no pre-built binaries are available, setup will look for system pdfium or build from source.

```bash
# In the pypdfium2/ directory
python -m pip install -v .

```

--------------------------------

### Install pypdfium2 with system pdfium

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Install pypdfium2 using a system-provided pdfium shared library. The setup probes for pdfium via ctypes.util.find_library() and hardcodes the result into the bindings. Set $PDFIUM_BINARY to specify an out-of-tree DLL, $PDFIUM_HEADERS for header location, or pass a version like PDFIUM_PLATFORM=system-search:XXXX if version detection fails.

```bash
PDFIUM_PLATFORM="system-search" python -m pip install -v .

```

--------------------------------

### Install pypdfium2 from PyPI

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Installs or upgrades pypdfium2 from PyPI. Uses a pre-built wheel if available for the platform; otherwise runs setup code, which may look for system pdfium or build from source.

```bash
python -m pip install -U pypdfium2
```

--------------------------------

### Install pypdfium2 with V8/XFA builds

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Installs pypdfium2 with V8 (JavaScript) / XFA enabled builds. Bypasses wheels and runs setup, requesting V8 builds via the PDFIUM_PLATFORM=auto-v8 environment setting.

```bash
PDFIUM_PLATFORM=auto-v8 pip install -v pypdfium2 --no-binary pypdfium2
```

--------------------------------

### Install native build

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Install the package after completing the native build process.

```bash
# Install
PDFIUM_PLATFORM="sourcebuild" python -m pip install -v .
```

--------------------------------

### Install Docker on Fedora

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Installs Docker (moby-engine) on Fedora and configures it to start on boot and allow the current user to run docker commands. Requires a reboot or re-login after adding the user to the docker group.

```bash
sudo dnf in moby-engine  # this provides the docker command
sudo systemctl start docker
sudo systemctl enable docker
sudo usermod -aG docker $USER
# then reboot (re-login might also suffice)
```

--------------------------------

### Install GN via pip

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Install the appropriate GN version for the PDFium version pinned by pypdfium2 using the dependency group from pyproject.toml.

```bash
python3 -m pip install --group gn
```

--------------------------------

### PdfSysfontBase.setup

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Installs (activates) the sysfont handler. Once called, the instance is kept alive until end of session unless closed manually.

```APIDOC
## PdfSysfontBase.setup

### Description
Install (activate) the sysfont handler. Once this method has been called, the instance is (by default) kept alive until the end of session, through an exit handler. To stop the sysfont handler earlier, call `close()`.

### Method
setup

### Signature
`setup(_reusable=False)`

### Parameters
- **reusable** (bool) - Optional - If True, the handler can be reused after closing; if False (default), closing will destroy pdfium's default handler.

### Notes
- Sysfont handlers are singleton; only one handler can be active at a time. When a new handler is installed, the previous handler (if any) is implicitly closed.

```

--------------------------------

### Install native build dependencies

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Install required system dependencies for the native build process on Ubuntu 24.04.

```bash
# Install dependencies
python -m pip install --group gn  # see above
sudo apt-get install ninja-build libfreetype-dev liblcms2-dev libjpeg-dev libopenjp2-7-dev libpng-dev libtiff-dev zlib1g-dev libicu-dev libglib2.0-dev libharfbuzz-dev  # generate-ninja
```

--------------------------------

### Perform toolchained build

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Run the toolchained build script and install the package with the sourcebuild platform directive.

```bash
# call build script with --help to list options
python ./setupsrc/build_toolchained.py
PDFIUM_PLATFORM="sourcebuild" python -m pip install -v .
```

--------------------------------

### Clone pypdfium2 repository and ctypesgen

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Clones the pypdfium2 repository and its ctypesgen fork into the deps directory, then changes into the source tree. Setup will automatically clone ctypesgen if not present.

```bash
git clone "https://github.com/pypdfium2-team/pypdfium2"
git clone "https://github.com/pypdfium2-team/ctypesgen" pypdfium2/deps/ctypesgen
cd pypdfium2/
```

--------------------------------

### Source code for pypdfium2._helpers.unsupported (PdfUnspHandler)

Source: https://pypdfium2.readthedocs.io/en/stable/_modules/pypdfium2/_helpers/unsupported.html

Source code of pypdfium2._helpers.unsupported. Use this to understand the implementation of PdfUnspHandler. The class must be registered via setup() once per session; calling it again raises RuntimeError. The default behavior logs a warning via lib_logger.

```python
# SPDX-FileCopyrightText: 2026 geisserml <geisserml@gmail.com>
# SPDX-License-Identifier: Apache-2.0 OR BSD-3-Clause

__all__ = ("PdfUnspHandler", )

import atexit
import logging
import pypdfium2.raw as pdfium_c
import pypdfium2.internal as pdfium_i
from pypdfium2._helpers.misc import PdfiumError

lib_logger = logging.getLogger("pypdfium2")




[docs]
class PdfUnspHandler (pdfium_i.AutoCastable):
    """
    Unsupported feature handler helper class.
    
    Attributes:
        raw (UNSUPPORT_INFO):
           The underlying pdfium ``UNSUPPORT_INFO`` struct.
        handlers (dict[str, typing.Callable]):
            A dictionary of named handler functions to be called with an unsupported code (:attr:`FPDF_UNSP_*`) when PDFium detects an unsupported feature.
    """
    
    SINGLETON = None
    
    def __init__(self):
        self.handlers = {}
        self.raw = pdfium_c.UNSUPPORT_INFO(version=1)
    
    def __call__(self, _, type):
        for handler in self.handlers.values():
            handler(type)
    
    @staticmethod
    def _default(type):
        lib_logger.warning(f"Unsupported PDF feature: {pdfium_i.UnsupportedInfoToStr.get(type)}")
    
    def _keep(self):
        id(self.handlers)
        id(self.raw)
    


[docs]
    def setup(self, add_default=True):
        """
        Register the handler with PDFium, and install an exit function that will keep the object alive until the end of session.
        
        Once set up, a :class:`.PdfUnspHandler` cannot be removed. It stands and falls with the library.
        Thus, this function can only be called once in a session.
        However, you may change the wrapped :attr:`.handlers` callbacks.
        Call ``.handlers.clear()`` to remove all handlers, thereby effectively disabling the instance.
        
        Parameters:
            add_default (bool):
                If True, add a default callback that will log unsupported features as warning.
        """
        if PdfUnspHandler.SINGLETON:
            raise RuntimeError("Only one PdfUnspHandler instance can be registered for a session.")
        
        pdfium_i.set_callback(self.raw, "FSDK_UnSupport_Handler", self)
        ok = pdfium_c.FSDK_SetUnSpObjProcessHandler(self.raw)
        if not ok:
            raise PdfiumError("Failed to register PdfUnspHandler object.")
        PdfUnspHandler.SINGLETON = self
        
        # TODO might want to have this unregistered in destroy_lib() after library destruction
        atexit.register(self._keep)
        if add_default:
            self.handlers["default"] = PdfUnspHandler._default

```

--------------------------------

### Show pypdfium2 help with --help

Source: https://pypdfium2.readthedocs.io/en/stable/shell_api.html

Run `pypdfium2 --help` to display usage, environment variables, and available subcommands. The CLI is for testing purposes and has no API stability promises.

```bash
$ pypdfium2 --help
usage: pypdfium2 [-h] [-v]
                 {arrange,attachments,extract-images,extract-text,imgtopdf,pageobjects,pdfinfo,fonts,default-fonts,render,tile,toc} ...

pypdfium2 is a Python binding to PDFium, a PDF processing library.
This is the command-line interface. Invoke as `pypdfium2` or `python -m pypdfium2_cli`.

pypdfium2's CLI mainly serves testing purposes, similar to pdfium_test upstream.
It is not meant as a feature-complete PDF toolkit for end users.
There are no API stability promises; backward incompatible changes may be made.

Environment variables:
- PYPDFIUM_LOGLEVEL {debug,info,warning,error,critical} = debug
  Controls the logging level.
- DEBUG_AUTOCLOSE {-1,0,1} = 0
  Whether to print info about (auto-)closing of PDFium objects.
  Defaults to 0, which means warnings only. 1 enables debugging. -1 silences even warnings.
- DEBUG_UNSUPPORTED {0,1} = 1
  Whether to enable or disable the unsupported feature handler.
- DEBUG_SYSFONTS {0,1} = 0
  Whether to install a sysfont listener.

positional arguments:
  {arrange,attachments,extract-images,extract-text,imgtopdf,pageobjects,pdfinfo,fonts,default-fonts,render,tile,toc}
    arrange             Rearrange/merge documents
    attachments         List/extract/edit embedded files
    extract-images      Extract images
    extract-text        Extract text
    imgtopdf            Convert images to PDF
    pageobjects         Print info on pageobjects
    pdfinfo             Print info on document and pages
    fonts               List a document's fonts
    default-fonts       Dump info about default fonts
    render              Rasterize pages
    tile                Tile pages (N-up)
    toc                 Print table of contents

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit

```

--------------------------------

### Set up pypdfium2 with caller-provided data files

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Use this shell script to supply pypdfium2's data files manually and bypass its automated setup. Set TARGET to "sourcebuild" to bundle pdfium in-tree, or "system" to use system pdfium out-of-tree; the staging directory is data/$TARGET. When bundling, copy the pdfium DLL into the staging directory; for system pdfium this step is skipped.

```bash
# First, ask yourself: Do you want to bundle pdfium (in-tree), or use system
# pdfium (out-of-tree)? For bundling, set "sourcebuild", else set "system".
TARGET="sourcebuild"  # or "system"
STAGING_DIR="data/$TARGET"

# If you have decided for bundling, copy over the pdfium DLL in question.
# Otherwise, skip this step.

```

--------------------------------

### PdfSysfontBase.setup()

Source: https://pypdfium2.readthedocs.io/en/stable/genindex.html

Sets up a system font base object. This method is part of the pypdfium2 SDK.

```APIDOC
## PdfSysfontBase.setup()

### Description
Sets up a system font base object.

### Method
setup()

### Parameters
None documented.

### Returns
None.
```

--------------------------------

### PdfUnspHandler.setup()

Source: https://pypdfium2.readthedocs.io/en/stable/genindex.html

Sets up an unsupported handler. This method is part of the pypdfium2 SDK.

```APIDOC
## PdfUnspHandler.setup()

### Description
Sets up an unsupported handler.

### Method
setup()

### Parameters
None documented.

### Returns
None.
```

--------------------------------

### Get bookmark title with FPDFBookmark_GetTitle

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Get the title string of a bookmark using a two-call pattern: first query the required buffer size, then fill the buffer and decode it as UTF-16LE, removing the NUL terminator.

```python
# (Assuming `bookmark` is an FPDF_BOOKMARK)
# First call to get the required number of bytes (not units!), including space for a NUL terminator
n_bytes = pdfium_c.FPDFBookmark_GetTitle(bookmark, None, 0)
# Initialise the output buffer
buffer = ctypes.create_string_buffer(n_bytes)
# Second call with the actual buffer
pdfium_c.FPDFBookmark_GetTitle(bookmark, buffer, n_bytes)
# Decode to string, cutting off the NUL terminator (encoding: UTF-16LE)
title = decode(memoryview(buffer)[:n_bytes-2], "utf-16-le")

```

--------------------------------

### Get view mode with FPDFDest_GetView

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Get view mode and target position from an FPDF_DEST. The function fills a pre-allocated array and returns the number of parameters; slicing converts the C array to a Python list.

```python
# (Assuming `dest` is an FPDF_DEST)
n_params = ctypes.c_ulong()
# Create a C array to store up to four coordinates
view_pos = (pdfium_c.FS_FLOAT * 4)()
view_mode = pdfium_c.FPDFDest_GetView(dest, n_params, view_pos)
# Slice the array to the actual number of coordinates. This implicitly converts the C array to a Python list.
view_pos = view_pos[:n_params.value]

```

--------------------------------

### get_bufwriter

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets a buffer writer from a buffer.

```APIDOC
## get_bufwriter

### Description
Gets a buffer writer from a buffer.

### Signature
```python
get_bufwriter(buffer)
```

### Parameters
- **buffer** - The buffer to write to.

```

--------------------------------

### Build native with Clang

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Configure Clang symlinks and execute the native build script using the Clang compiler.

```bash
# Alternatively, build with Clang
sudo apt-get install llvm lld
VERSION=18
ARCH=$(uname -m)
sudo ln -s "/usr/lib/clang/$VERSION/lib/linux" "/usr/lib/clang/$VERSION/lib/$ARCH-unknown-linux-gnu"
sudo ln -s "/usr/lib/clang/$VERSION/lib/linux/libclang_rt.builtins-$ARCH.a" "/usr/lib/clang/$VERSION/lib/linux/libclang_rt.builtins.a"
python ./setupsrc/build_native.py --compiler clang
```

--------------------------------

### Build Sphinx HTML docs

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Build the Sphinx API documentation as HTML, either directly or via the `just` alias.

```bash
sphinx-build -b html ./docs/source ./docs/build/html/
just docs-build  # short alias
```

--------------------------------

### get_bufreader

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets a buffer reader from a buffer.

```APIDOC
## get_bufreader

### Description
Gets a buffer reader from a buffer.

### Signature
```python
get_bufreader(buffer)
```

### Parameters
- **buffer** - The buffer to read from.

```

--------------------------------

### pypdfium2 imgtopdf --help

Source: https://pypdfium2.readthedocs.io/en/stable/shell_api.html

Shows the help output for the imgtopdf command, which converts images to a PDF. Requires --output (or -o) for the target path. The --inline option uses PDFium's inline loading function for JPEG images.

```text
$ pypdfium2 imgtopdf --help
usage: pypdfium2 imgtopdf [-h] --output OUTPUT [--inline] images [images ...]

Convert images to PDF

positional arguments:
  images               Input images

options:
  -h, --help           show this help message and exit
  --output, -o OUTPUT  Target path for the new PDF
  --inline             If JPEG, whether to use PDFium's inline loading function.

```

--------------------------------

### get_buffer

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets a buffer from a pointer and size.

```APIDOC
## get_buffer

### Description
Gets a buffer from a pointer and size.

### Signature
```python
get_buffer(ptr, size)
```

### Parameters
- **ptr** - The pointer to the buffer.
- **size** - The size of the buffer.

```

--------------------------------

### Check pypdfium2 version with --version

Source: https://pypdfium2.readthedocs.io/en/stable/shell_api.html

Run `pypdfium2 --version` to display the pypdfium2 and PDFium versions along with the path to the PDFium library.

```bash
$ pypdfium2 --version
pypdfium2 5.14.0+1.g0e77f15c
pdfium 156.0.8076.0 at /home/docs/checkouts/readthedocs.org/user_builds/pypdfium2/envs/stable/lib/python3.14/site-packages/pypdfium2_raw/libpdfium.so

```

--------------------------------

### PdfImage.get_px_size()

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets the image dimension in pixels.

```APIDOC
## PdfImage.get_px_size()

### Description
Get the image dimension in pixels.

### Method
GET

### Endpoint
PdfImage.get_px_size()

### Returns
- **(int, int)** - Image dimension in pixels as a tuple of (width, height).

### Response Example
```
(width, height)
```
```

--------------------------------

### Document.get_metadata_dict

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Get the document's metadata as dictionary.

```APIDOC
## Document.get_metadata_dict(skip_empty=False)

### Description
Get the document's metadata as dictionary.

### Method
get_metadata_dict

### Parameters
- **skip_empty** (_bool_) - Optional - If True, skip items whose value is an empty string.

### Returns
- **dict** - PDF metadata.
```

--------------------------------

### init_forms(config=None)

Source: https://pypdfium2.readthedocs.io/en/stable/_modules/pypdfium2/_helpers/document.html

Initializes a form environment if the document has forms. If already initialized, does nothing. Optionally loads XFA forms if supported.

```APIDOC
## init_forms(config=None)

### Description
Initializes a form environment if the document has forms. If already initialized, does nothing. Optionally loads XFA forms if supported.

### Method
`init_forms(config=None)`

### Parameters
- **config** (FPDF_FORMFILLINFO | None) - Optional custom form config interface to use.

### Returns
- **bool** - True if initialization succeeded, False if no forms or already initialized.

### Raises
- **PdfiumWarning** - When an attempt to load XFA forms fails, a warning is issued with error code information.
```

--------------------------------

### PdfObject.get_matrix()

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets the pageobject's current transform matrix.

```APIDOC
## PdfObject.get_matrix()

### Description
Get the pageobject's current transform matrix.

### Method
GET

### Endpoint
PdfObject.get_matrix()

### Returns
- **PdfMatrix** - The pageobject's current transform matrix.

### Response Example
```
PdfMatrix instance
```
```

--------------------------------

### Import pypdfium2 libraries

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Import the high-level support model and the raw PDFium API.

```python
import pypdfium2 as pdfium
import pypdfium2.raw as pdfium_c

```

--------------------------------

### PdfTextPage.get_index(x, y, x_tol, y_tol)

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets the index of a character by position.

```APIDOC
## get_index(x, y, x_tol, y_tol)

### Description
Gets the index of a character by position.

### Parameters
- **x** (float) - Required - Horizontal position (in PDF canvas units).
- **y** (float) - Required - Vertical position.
- **x_tol** (float) - Required - Horizontal tolerance.
- **y_tol** (float) - Required - Vertical tolerance.

### Returns
- **int | None** - The index of the character at or nearby the point (x, y). May be None if there is no character. If an internal error occurred, an exception will be raised.
```

--------------------------------

### PdfTextPage._get_active_text_range method

Source: https://pypdfium2.readthedocs.io/en/stable/_modules/pypdfium2/_helpers/textpage.html

Internal method to find the range of active text characters within a given character index range. It recursively adjusts the start and end indices to skip passive characters, returning a tuple of start index, end index, and counts of passive characters on the left and right.

```python
def _get_active_text_range(self, c_start, c_end, l_passive=0, r_passive=0):
    
    if c_start > c_end:
        return 0  # no active chars in range
    
    t_start = pdfium_c.FPDFText_GetTextIndexFromCharIndex(self, c_start)
    if t_start == -1:
        return self._get_active_text_range(c_start+1, c_end, l_passive+1, r_passive)
    
    t_end = pdfium_c.FPDFText_GetTextIndexFromCharIndex(self, c_end)
    if t_end == -1:
        return self._get_active_text_range(c_start, c_end-1, l_passive, r_passive+1)
    
    return t_start, t_end, l_passive, r_passive
```

--------------------------------

### pypdfium2 arrange --help

Source: https://pypdfium2.readthedocs.io/en/stable/shell_api.html

Shows the usage and options for the 'arrange' subcommand, which rearranges or merges PDF files. Use '--pages' to specify page texts (use '_' for all pages), '--passwords' for encrypted PDFs, and '--output' for the target path.

```bash
$ pypdfium2 arrange --help
usage: pypdfium2 arrange [-h] [--pages PAGES [PAGES ...]]
                         [--passwords PASSWORDS [PASSWORDS ...]]
                         --output OUTPUT
                         inputs [inputs ...]

Rearrange/merge documents

positional arguments:
  inputs                Sequence of PDF files.

options:
  -h, --help            show this help message and exit
  --pages PAGES [PAGES ...]
                        Sequence of page texts, definig the pages to include from each PDF. Use '_' as placeholder for all pages.
  --passwords PASSWORDS [PASSWORDS ...]
                        Passwords to unlock encrypted PDFs. Any placeholder may be used for non-encrypted documents.
  --output, -o OUTPUT   Target path for the output document

```

--------------------------------

### PdfObject.get_bounds()

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets the bounds of the page object on the page in PDF page coordinates.

```APIDOC
## PdfObject.get_bounds()

### Description
Get the bounds of the object on the page.

### Method
GET

### Endpoint
PdfObject.get_bounds()

### Returns
- **tuple[float * 4]** - Left, bottom, right and top, in PDF page coordinates.

### Response Example
```
(left, bottom, right, top)
```
```

--------------------------------

### Build native with GCC

Source: https://pypdfium2.readthedocs.io/en/stable/readme.html

Execute the native build script using the GCC compiler.

```bash
# Build with GCC
python ./setupsrc/build_native.py --compiler gcc
```

--------------------------------

### PdfAttachment class source code

Source: https://pypdfium2.readthedocs.io/en/stable/_modules/pypdfium2/_helpers/attachment.html

Complete source code of the PdfAttachment helper class. It wraps PDFium's attachment API and provides methods to get the attachment name, get and set file data, and query the params dictionary. The class inherits from pdfium_i.AutoCastable and requires a valid PdfDocument reference.

```python
# SPDX-FileCopyrightText: 2026 geisserml <geisserml@gmail.com>
# SPDX-License-Identifier: Apache-2.0 OR BSD-3-Clause

__all__ = ("PdfAttachment", )

import ctypes
from codecs import decode
import pypdfium2.raw as pdfium_c
import pypdfium2.internal as pdfium_i
from pypdfium2.internal import FPDF_WCHAR_size
from pypdfium2._helpers.misc import PdfiumError




[docs]
class PdfAttachment (pdfium_i.AutoCastable):
    """
    Attachment helper class. See PDF 1.7, Section 7.11 "File Specifications".
    
    Attributes:
        raw (FPDF_ATTACHMENT):
            The underlying PDFium attachment handle.
        pdf (PdfDocument):
            Reference to the document this attachment belongs to. Must remain valid as long as the attachment is used.
    """
    
    # TODO consider using AutoCloseable machienery to guarantee `pdf` remains alive as long as the attachment object exists
    
    # Limitations of PDFium's attachment API: https://crbug.com/pdfium/893
    
    def __init__(self, raw, pdf):
        self.raw = raw
        self.pdf = pdf
    



[docs]
    def get_name(self):
        """
        Returns:
            str: Name of the attachment.
        """
        n_bytes = pdfium_c.FPDFAttachment_GetName(self, None, 0)
        if not n_bytes:
            raise PdfiumError("Failed to get attachment name.")
        n_units = -(n_bytes // -FPDF_WCHAR_size)  # ceildiv
        buffer = (pdfium_c.FPDF_WCHAR * n_units)()
        pdfium_c.FPDFAttachment_GetName(self, buffer, n_bytes)
        return decode(memoryview(buffer)[:n_units-1], "utf-16-le")


    


[docs]
    def get_data(self):
        """
        Returns:
            ctypes.Array: The attachment's file data (as :class:`~ctypes.c_char` array).
        """
                
        n_bytes = ctypes.c_ulong()
        pdfium_c.FPDFAttachment_GetFile(self, None, 0, n_bytes)
        n_bytes = n_bytes.value
        if not n_bytes:
            raise PdfiumError(f"Failed to extract attachment (no data).")
        
        buffer = (ctypes.c_char * n_bytes)()
        out_buflen = ctypes.c_ulong()
        ok = pdfium_c.FPDFAttachment_GetFile(self, buffer, n_bytes, out_buflen)
        out_buflen = out_buflen.value
        if not ok:
            raise PdfiumError("Failed to extract attachment (error status).")
        if n_bytes < out_buflen:
            raise PdfiumError(f"Failed to extract attachment (expected {n_bytes} bytes, but got {out_buflen}).")
        
        return buffer


    


[docs]
    def set_data(self, data):
        """
        Set the attachment's file data.
        If this function is called on an existing attachment, it will be changed to point at the new data, but the previous data will not be removed from the file (as of PDFium 5418).
        
        Parameters:
            data (bytes | ctypes.Array):
                New file data for the attachment. May be any data type that can be implicitly converted to :class:`~ctypes.c_void_p`.
        """
        ok = pdfium_c.FPDFAttachment_SetFile(self, self.pdf, data, len(data))
        if not ok:
            raise PdfiumError("Failed to set attachment data.")


    


[docs]
    def has_key(self, key):
        """
        Parameters:
            key (str):
                A key to look for in the attachment's params dictionary.
        Returns:
            bool: True if *key* is contained in the params dictionary, False otherwise.
        """
        return pdfium_c.FPDFAttachment_HasKey(self, (key+"\x00").encode("utf-8"))


    


[docs]
    def get_value_type(self, key):
        """
        Returns:
            int: Type of the value of *key* in the params dictionary (:attr:`FPDF_OBJECT_*`).
        """
        return pdfium_c.FPDFAttachment_GetValueType(self, (key+"\x00").encode("utf-8"))


    


[docs]
    def get_str_value(self, key):
        """
        Returns:
            str: The value of *key* in the params dictionary, if it is a string or name.
            Otherwise, an empty string will be returned. On other failures, an exception will be raised.
        """
        
        enc_key = (key+"\x00").encode("utf-8")
        n_bytes = pdfium_c.FPDFAttachment_GetStringValue(self, enc_key, None, 0)
        if n_bytes <= 0:
            raise PdfiumError(f"Failed to get value of key '{key}'.")
        
        n_units = -(n_bytes // -FPDF_WCHAR_size)  # ceildiv
        buffer = (pdfium_c.FPDF_WCHAR * n_units)()
        pdfium_c.FPDFAttachment_GetStringValue(self, enc_key, buffer, n_bytes)
        
        return decode(memoryview(buffer)[:n_units-1], "utf-16-le")


    

```

--------------------------------

### PdfSysfontBase.GetFont

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Callback method for getting a font handle. Part of the FPDF_SYSFONTINFO callback system.

```APIDOC
## PdfSysfontBase.GetFont

### Description
Callback method for getting a font handle. Part of the FPDF_SYSFONTINFO callback system.

### Method
GetFont

### Signature
`GetFont(___ , _face_)`

### Parameters
- **face** - Required - Font face name.

```

--------------------------------

### PdfImage.get_bitmap

Source: https://pypdfium2.readthedocs.io/en/stable/python_api.html

Gets a bitmap rasterization of the image, optionally rendering it with transforms and alpha masks.

```APIDOC
## get_bitmap(_render=False_, _scale_to_original=True_)

### Description
Get a bitmap rasterization of the image.

### Parameters
- **render** (bool) - Optional - Whether the image should be rendered, thereby applying possible transform matrices and alpha masks.
- **scale_to_original** (bool) - Optional - If render is True, whether to temporarily scale the image to its native resolution, or close to that (defaults to True). This should improve output quality. Ignored if render is False.

### Returns
Image bitmap (with a buffer allocated by PDFium).

### Return Type
PdfBitmap
```
Tokens:
Raw