OCRmyPDF

https://ocrmypdf.readthedocs.io/en/latest/
Admin
OCRmyPDF is a tool that adds a searchable optical character recognition (OCR) text layer to scanned...
Tokens:40,071
Snippets:608
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Clone and setup development environment

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Steps to clone the repository and install all development and test requirements.

```bash
git clone -b main https://github.com/ocrmypdf/OCRmyPDF.git
cd OCRmyPDF
uv sync --all-groups
```

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

### Install shell completions

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Manual installation commands for bash and fish shell completions.

```bash
cp misc/completion/ocrmypdf.bash /etc/bash_completion.d/ocrmypdf
cp misc/completion/ocrmypdf.fish ~/.config/fish/completions/ocrmypdf.fish
```

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

### Install in editable mode

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Clone the repository and install in editable mode for customization.

```bash
git clone -b main https://github.com/ocrmypdf/OCRmyPDF.git
cd OCRmyPDF
pip install -e .
```

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

### Install via Package Managers

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Standard installation commands for various operating systems.

```bash
brew install ocrmypdf
```

```bash
apt install ocrmypdf
```

```bash
dnf install ocrmypdf tesseract-osd
```

```bash
port install ocrmypdf
```

```bash
pkg install textproc/py-ocrmypdf
```

```bash
snap install ocrmypdf
```

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

### Install OCRmyPDF with uv

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Recommended method using a virtual environment for isolated installation.

```bash
pip install uv

uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install ocrmypdf

uv pip install --system ocrmypdf
```

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

### Install on RHEL 9

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Commands to prepare the environment and install dependencies on RHEL 9.

```bash
dnf install python3.12 python3.12-pip
```

```bash
dnf install ghostscript tesseract
```

```bash
python3.12 -m venv .venv
```

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

### Install pypdfium2

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Install the pypdfium2 library for fast PDF page rasterization.

```bash
pip install pypdfium2
```

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

### Install and Run watcher.py

Source: https://ocrmypdf.readthedocs.io/en/latest/batch.html

Install the necessary dependencies and execute the watcher script with environment variables to define input and output directories.

```bash
# Using uv (recommended)
uv sync --extra watcher

# Or using pip
pip3 install ocrmypdf[watcher]

env OCR_INPUT_DIRECTORY=/mnt/input-pdfs \
    OCR_OUTPUT_DIRECTORY=/mnt/output-pdfs \
    OCR_OUTPUT_STRUCTURE=YEAR_MONTH \
    python3 watcher.py
```

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

### Verify Docker Installation

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Run the hello-world container to confirm that Docker is correctly installed and configured on your system.

```bash
docker run hello-world
```

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

### Install directly from GitHub

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Install the latest version directly from the GitHub repository using pip.

```bash
pip install git+https://github.com/ocrmypdf/OCRmyPDF.git
```

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

### Activate virtual environment and verify installation

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Activate the created virtual environment and display the help menu.

```bash
source .venv/bin/activate
ocrmypdf --help
```

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

### Install OCRmyPDF via uv

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Install OCRmyPDF using the uv package manager.

```bash
pip install uv
uv pip install --user ocrmypdf
```

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

### Install required Python dependencies

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Install the necessary text layer rendering engine components.

```bash
pip install fpdf2 uharfbuzz
```

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

### Install OCRmyPDF from source using uv

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Clone the repository and use uv to sync dependencies and create a virtual environment.

```bash
git clone -b main https://github.com/ocrmypdf/OCRmyPDF.git
cd OCRmyPDF
pip install uv  # If not already installed
uv sync
```

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

### Install Latest Version on Ubuntu

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Commands to install system dependencies and upgrade to the latest version using uv.

```bash
# Install system dependencies first
sudo apt-get update
sudo apt-get -y install ocrmypdf

# Install uv and upgrade to the latest OCRmyPDF
pip install uv
uv pip install --user --upgrade ocrmypdf
```

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

### Launch the web service wrapper

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Starts the barebones HTTP web service included in the Docker image on port 5000.

```bash
docker run --entrypoint python -p 5000:5000 jbarlow83/ocrmypdf /app/webservice.py
```

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

### Install OCRmyPDF on Windows via pip

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Install OCRmyPDF using pip on Windows.

```bash
python3 -m pip install ocrmypdf
```

```bash
py -m pip install ocrmypdf
```

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

### Install uv package manager

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Command to install the uv package manager on Unix-like systems.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

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

### Install OCRmyPDF with pip

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Standard installation using pip, optionally upgrading if already satisfied.

```bash
pip install --user ocrmypdf
```

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

### Install project dependencies with uv

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Use these commands to sync dependencies with specific extras enabled.

```bash
uv sync --extra watcher        # File watching service
uv sync --extra webservice     # Streamlit web UI
uv sync --extra watcher --extra webservice  # Multiple features
```

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

### Verify OCRmyPDF installation

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Check the installed version of the tool.

```bash
ocrmypdf --version
```

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

### Install development tools with uv

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Sync specific dependency groups for testing, documentation, or enhanced development environments.

```bash
# Testing infrastructure
uv sync --group test

# Documentation building
uv sync --group docs

# Enhanced Streamlit development
uv sync --group streamlit-dev

# All development groups
uv sync
```

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

### Verify WSL Installation

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Check the installed version of OCRmyPDF within WSL.

```bash
wsl ocrmypdf --version
```

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

### Install Tesseract Language Packs via Homebrew

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Optional command to install all available Tesseract language packs.

```bash
brew install tesseract-lang  # Optional: Install all language packs
```

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

### Install Tesseract language packs on Arch Linux

Source: https://ocrmypdf.readthedocs.io/en/latest/languages.html

Use pacman to search for and install Tesseract data packages.

```bash
# Display a list of all Tesseract language packs
pacman -Ss tesseract-data

# Install German language pack
pacman -S tesseract-data-deu
```

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

### Install Tesseract language packs on Fedora

Source: https://ocrmypdf.readthedocs.io/en/latest/languages.html

Use dnf to search for and install Tesseract language packages.

```bash
# Display a list of all Tesseract language packs
dnf search tesseract

# Install Chinese Simplified language pack
dnf install tesseract-langpack-chi_sim
```

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

### Install Tesseract language packs on Debian and Ubuntu

Source: https://ocrmypdf.readthedocs.io/en/latest/languages.html

Use apt-cache to find available packs and apt-get to install the desired language.

```bash
# Display a list of all Tesseract language packs
apt-cache search tesseract-ocr

# Install Chinese Simplified language pack
apt-get install tesseract-ocr-chi-sim
```

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

### Install OCRmyPDF on Gentoo Linux

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Enable the guru repository and emerge the OCRmyPDF package.

```bash
eselect repository enable guru
emaint sync --repo guru
emerge --ask app-text/OCRmyPDF
```

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

### Build and install jbig2enc from source

Source: https://ocrmypdf.readthedocs.io/en/latest/jbig2.html

Commands to clone, configure, and compile the jbig2enc encoder from the official repository.

```bash
git clone https://github.com/agl/jbig2enc
cd jbig2enc
./autogen.sh
./configure && make
[sudo] make install
```

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

### Cygwin64 Prerequisite Packages

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

List of required packages for Cygwin64 installation.

```text
python311 (or later)
python3?-devel
python3?-pip
python3?-lxml
python3?-imaging

   (where 3? means match the version of python3 you installed)

gcc-g++
ghostscript
libexempi3
libexempi-devel
libffi6
libffi-devel
pngquant
qpdf
libqpdf-devel
tesseract-ocr
tesseract-ocr-devel
```

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

### Install OCRmyPDF on FreeBSD

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Command to install the OCRmyPDF package using the FreeBSD pkg manager.

```bash
pkg install textproc/py-ocrmypdf
```

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

### Install Noto fonts for text rendering

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

System-specific commands to install Noto fonts for proper multilingual text rendering.

```bash
apt install fonts-noto
```

```bash
dnf install google-noto-fonts-all
```

```bash
brew install --cask font-noto-sans font-noto-serif
brew install --cask font-noto-sans-arabic font-noto-sans-cjk
```

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

### Install OCRmyPDF on Cygwin

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Commands to install the wheel package and OCRmyPDF using the Cygwin Python package manager.

```bash
pip3 install wheel
pip3 install ocrmypdf
```

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

### Install Tesseract language data on Arch Linux

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Install English language data for Tesseract to enable OCR functionality.

```bash
sudo pacman -S tesseract-data-eng
```

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

### Install OCRmyPDF on Alpine Linux

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Use the apk package manager to install OCRmyPDF on Alpine Linux.

```bash
apk add ocrmypdf
```

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

### Install build dependencies on Ubuntu

Source: https://ocrmypdf.readthedocs.io/en/latest/jbig2.html

Required system packages for building the encoder on Ubuntu-based distributions.

```bash
[sudo] apt install autotools-dev automake libtool libleptonica-dev pkg-config
```

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

### Install OCRmyPDF from AUR

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Download, extract, and build the OCRmyPDF package from the Arch User Repository.

```bash
curl -O https://aur.archlinux.org/cgit/aur.git/snapshot/ocrmypdf.tar.gz
tar xvzf ocrmypdf.tar.gz
cd ocrmypdf
makepkg -sri
```

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

### Install or run OCRmyPDF with pipx

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Use pipx for isolated command-line tool management.

```bash
pipx install ocrmypdf
```

```bash
pipx run ocrmypdf
```

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

### Install base-devel on Arch Linux

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Install the base-devel package group to provide necessary build tools for AUR packages.

```bash
sudo pacman -S --needed base-devel
```

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

### Configure Ghostscript JPEG quality and DPI

Source: https://ocrmypdf.readthedocs.io/en/latest/advanced.html

Example command demonstrating the use of Ghostscript-specific JPEG quality and DPI capping options during PDF/A conversion.

```bash
ocrmypdf --output-type pdfa \
    --ghostscript-jpeg-quality 80 \
    --ghostscript-jpeg-maxdpi 150 \
    in.pdf out.pdf
```

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

### Start an ephemeral Docker container

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Basic command to run the OCRmyPDF Docker image as an ephemeral process.

```bash
docker run --rm -i jbarlow83/ocrmypdf-alpine (... all other arguments here...) - -
```

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

### Execute the test suite

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Runs the OCRmyPDF test suite installed within the Docker image.

```bash
docker run --rm --workdir /app --entrypoint python jbarlow83/ocrmypdf -m pytest
```

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

### Select a rasterizer

Source: https://ocrmypdf.readthedocs.io/en/latest/cookbook.html

Choose between pypdfium2 and Ghostscript for PDF page rasterization. pypdfium2 is generally faster and preferred when installed.

```bash
# Automatic selection (default) - prefers pypdfium when available
ocrmypdf --rasterizer auto input.pdf output.pdf

# Explicitly use pypdfium2 (requires pip install pypdfium2)
ocrmypdf --rasterizer pypdfium input.pdf output.pdf

# Explicitly use Ghostscript
ocrmypdf --rasterizer ghostscript input.pdf output.pdf
```

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

### Implement custom OCR engine plugin

Source: https://ocrmypdf.readthedocs.io/en/latest/plugins.html

Example of a custom OCR engine plugin using the OcrEngine base class to return an OcrElement tree.

```python
from pathlib import Path
from ocrmypdf.pluginspec import OcrEngine
from ocrmypdf import OcrElement, OcrClass, BoundingBox


class MyOcrEngine(OcrEngine):
    def generate_ocr(
        self,
        input_file: Path,
        options,
        context,
    ) -> OcrElement:
        # Perform OCR and return OcrElement tree directly
        # No need to generate hOCR XML
        return OcrElement(
            ocr_class=OcrClass.PAGE,
            bbox=BoundingBox(0, 0, width, height),
            dpi=300,
            children=[
                OcrElement(
                    ocr_class=OcrClass.LINE,
                    bbox=BoundingBox(100, 50, 500, 80),
                    children=[
                        OcrElement(
                            ocr_class=OcrClass.WORD,
                            bbox=BoundingBox(100, 50, 200, 80),
                            text="Hello",
                        ),
                        # ... more words
                    ],
                ),
                # ... more lines
            ],
        )

    def supports_generate_ocr(self) -> bool:
        return True  # Indicate this engine uses generate_ocr()
```

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

### Install OCRmyPDF via MacPorts

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Use MacPorts to install OCRmyPDF on macOS.

```bash
sudo port install ocrmypdf
```

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

### Access Help

Source: https://ocrmypdf.readthedocs.io/en/latest/cookbook.html

Displays the built-in help documentation for the command-line interface.

```bash
ocrmypdf --help
```

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

### Install OCRmyPDF via Homebrew

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Use Homebrew to install OCRmyPDF and its dependencies on macOS or Linux.

```bash
brew install ocrmypdf
```

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

### ocrmypdf.api.setup_plugin_infrastructure

Source: https://ocrmypdf.readthedocs.io/en/latest/apiref.html

Initializes the plugin infrastructure for OCRmyPDF, handling plugin manager creation and initialization hooks.

```APIDOC
## ocrmypdf.api.setup_plugin_infrastructure

### Description
Sets up the plugin infrastructure by creating or validating the plugin manager and calling initialization hooks.

### Parameters
- **plugins** (Sequence[Path | str] | None) - Optional - List of plugin paths or names to load.
- **plugin_manager** (OcrmypdfPluginManager | None) - Optional - An existing plugin manager instance.

### Returns
- **OcrmypdfPluginManager** - The properly initialized plugin manager.

### Raises
- **ValueError** - If both plugins and plugin_manager are provided simultaneously.
```

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

### Run OCRmyPDF with a settings file

Source: https://ocrmypdf.readthedocs.io/en/latest/releasenotes/version03.html

Use the @ prefix to pass a configuration file containing arguments to the command.

```bash
ocrmypdf input.pdf output.pdf @settings.txt
```

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

### Configure plugin entrypoint in pyproject.toml

Source: https://ocrmypdf.readthedocs.io/en/latest/plugins.html

Define an entrypoint in the ocrmypdf namespace to enable automatic plugin loading.

```toml
[project]
name = "ocrmypdf-exampleplugin"

[project.entry-points."ocrmypdf"]
exampleplugin = "exampleplugin.pluginmodule"
```

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

### Configure Tesseract with custom parameters

Source: https://ocrmypdf.readthedocs.io/en/latest/advanced.html

Create a configuration file to disable the system dictionary and apply it during execution.

```text
load_system_dawg 0
language_model_penalty_non_dict_word 0
language_model_penalty_non_freq_dict_word 0
```

```bash
ocrmypdf --tesseract-config no-dict.cfg input.pdf output.pdf
```

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

### configure_logging()

Source: https://ocrmypdf.readthedocs.io/en/latest/apiref.html

Sets up logging to match the command line interface behavior, including support for progress bars and colored output.

```APIDOC
## configure_logging()

### Description
Set up logging to match the command line interface behavior, with support for progress bars and colored output.
```

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

### Configure WSL Symlink

Source: https://ocrmypdf.readthedocs.io/en/latest/installation.html

Create a symlink to run OCRmyPDF from the Windows command prompt.

```bash
wsl sudo ln -s  /home/$USER/.local/bin/ocrmypdf /usr/local/bin/ocrmypdf
```

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

### Define settings file content

Source: https://ocrmypdf.readthedocs.io/en/latest/releasenotes/version03.html

Format the settings file with one argument per line.

```text
-l
deu
--author
A. Merkel
--pdf-renderer
tesseract
```

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

### OCR with Non-English Languages

Source: https://ocrmypdf.readthedocs.io/en/latest/cookbook.html

Specifies the language for OCR processing. Requires corresponding language packs to be installed.

```bash
ocrmypdf -l fra LeParisien.pdf LeParisien.pdf
ocrmypdf -l eng+fra Bilingual-English-French.pdf Bilingual-English-French.pdf
```

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

### Process huge images with OCRmyPDF

Source: https://ocrmypdf.readthedocs.io/en/latest/advanced.html

Examples for handling oversized images by adjusting timeout and downsampling thresholds.

```bash
# Allow 600 seconds for OCR on huge images
ocrmypdf --tesseract-timeout 600 \
    --tesseract-downsample-large-images \
    bigfile.pdf output.pdf

# Downsample images above 5000 pixels on the longest dimension to
# 5000 pixels
ocrmypdf --tesseract-timeout 120 \
    --tesseract-downsample-large-images \
    --tesseract-downsample-above 5000 \
    bigfile.pdf output_downsampled_ocr.pdf
```

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

### Invoke a plugin via command line

Source: https://ocrmypdf.readthedocs.io/en/latest/plugins.html

Use the --plugin flag followed by the module name to load a plugin during execution.

```bash
ocrmypdf --plugin ocrmypdf_fancypants.pockets.contents input.pdf output.pdf
```

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

### Bind-mount volumes with Podman

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Configuration for Podman using user namespace mapping to maintain correct file ownership.

```bash
alias podman_ocrmypdf='podman run --rm -i --user "$(id -u):$(id -g)" --userns keep-id -v "$PWD:/data" jbarlow83/ocrmypdf-alpine'
podman_ocrmypdf input.pdf output.pdf
```

```bash
alias podman_ocrmypdf='podman run --rm -i --user "$(id -u):$(id -g)" --userns keep-id -v "$PWD:/data" --security-opt label=disable jbarlow83/ocrmypdf-alpine'
podman_ocrmypdf input.pdf output.pdf
```

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

### Copy training data to container

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Use the docker cp command to inject training data into a running container instance.

```bash
docker cp mycustomtraining.traineddata name_of_container:/usr/share/tesseract-ocr/<tesseract version>/tessdata/
```

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

### Determine Tesseract data version

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Run this command to identify the installed Tesseract data version required for path configuration.

```bash
docker run -i --rm --entrypoint /bin/ls jbarlow83/ocrmypdf /usr/share/tesseract-ocr
```

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

### Configure Tesseract language packs on Gentoo

Source: https://ocrmypdf.readthedocs.io/en/latest/languages.html

Manage language support via USE flags or L10N settings in portage configuration files.

```bash
# Display a list of all Tesseract language packs
equery uses app-text/tessdata_fast

# Add English and German language support for Tesseract only
echo 'app-text/tessdata_fast l10n_de l10n_en' >> /etc/portage/package.use

# Add global English and German language support (the `l10n_` from equery has to be omitted)
echo L10N="de en" >> /etc/portage/make.conf

# update system to reflect changed USE flags
emerge --update --deep --newuse @world
```

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

### Initialize OcrElement and related classes

Source: https://ocrmypdf.readthedocs.io/en/latest/plugins.html

Basic instantiation of OcrElement, BoundingBox, and OcrClass constants.

```python
from ocrmypdf import OcrElement, OcrClass, BoundingBox

# OcrElement - represents any OCR structural unit
page = OcrElement(
    ocr_class=OcrClass.PAGE, bbox=BoundingBox(0, 0, 612, 792), children=[...]
)

# BoundingBox - axis-aligned bounding box (left, top, right, bottom)
bbox = BoundingBox(left=100, top=50, right=300, bottom=80)

# OcrClass - constants for element types
OcrClass.PAGE  # "ocr_page"
OcrClass.LINE  # "ocr_line"
OcrClass.WORD  # "ocrx_word"
OcrClass.PARAGRAPH  # "ocr_par"
```

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

### Add languages via Dockerfile

Source: https://ocrmypdf.readthedocs.io/en/latest/docker.html

Create a custom Dockerfile based on the official image to install additional Tesseract language packs.

```dockerfile
FROM jbarlow83/ocrmypdf

# The image runs as the non-root "app" user, so switch back to root for
# build steps that install packages, then drop back to "app".
USER root
# Example: add Italian
RUN apt-get update && apt-get install -y tesseract-ocr-ita
USER app
```

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

### Configure PDF/A conversion

Source: https://ocrmypdf.readthedocs.io/en/latest/cookbook.html

Control PDF/A output generation using verapdf or Ghostscript.

```bash
# Uses speculative conversion with verapdf validation (default)
ocrmypdf --output-type auto input.pdf output.pdf

# Explicitly request Ghostscript-based PDF/A conversion
ocrmypdf --output-type pdfa input.pdf output.pdf
```

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

### Implement a custom progress bar plugin

Source: https://ocrmypdf.readthedocs.io/en/latest/plugins.html

A complete example of a custom progress bar class inheriting from ProgressBar and registering it via the get_progressbar_class hook.

```python
from ocrmypdf.pluginspec import ProgressBar
from ocrmypdf import hookimpl

class ConsoleProgressBar(ProgressBar):
    def __init__(self, *, total=None, desc=None, unit=None, disable=False,
                 **kwargs):
        self.total = total
        self.desc = desc
        self.unit = unit
        self.disable = disable
        self.current = 0

    def __enter__(self):
        if not self.disable:
            print(f"Starting {self.desc or 'an OCR task'} "
                  f"(total={self.total} {self.unit})"
            )
        return self

    def __exit__(self, exc_type, exc_value, traceback):
        if not self.disable:
            if exc_type is None:
                print("Completed successfully.")
            else:
                print(f"Task ended with error: {exc_value}")
        return False  # Let OCRmyPDF raise any exceptions

    def update(self, n=1, *, completed=None):
        if completed is not None:
            # If 'completed' is given, set self.current
            # but let's just read it to show usage
            print(f"Absolute completion reported: {completed}")
        # Otherwise, we increment by 'n'
        self.current += n
        if not self.disable:
            if self.total:
                percent = (self.current / self.total) * 100
                print(
                    f"{self.desc}: {self.current}"
                    f"/{self.total} ({percent:.1f}%)"
                )
            else:
                print(f"{self.desc}: {self.current} units done")

@hookimpl
def get_progressbar_class():
    return MyProgressBar
```
Tokens:
Raw