pyink

library25.12.0pypypiunverified

Pyink is a Python code formatter, forked from Black, that offers slightly different formatting behaviors compared to upstream Black. It is actively maintained and regularly rebased on the latest Black releases to serve as an adoption helper for large monorepos with specific formatting requirements. The current stable version is 25.12.0.

testing

pip install pyink

github ↗package ↗changelog ↗

INSTALL

IMPORT

SIG · PYINK

pyink

testingpythonv25.12.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Pyink is primarily a command-line interface tool. To use it, simply invoke `pyink` followed by the file or directory you wish to format. All Black command-line options are supported, in addition to Pyink-specific options.

# To format a single file: pyink my_python_script.py # To format all Python files in the current directory and subdirectories: pyink . # To check for formatting issues without applying changes: pyink --check --diff .

pyink --version

Debug

Known issues

breakingThe `--pyink-lines` CLI option was deprecated in Pyink 23.12.1 and completely removed in 24.3.0. Using this option in newer versions will result in an error.

fix

Replace `--pyink-lines START-END` with Black's built-in `--line-ranges START-END` option (e.g., `pyink --line-ranges 10-20 my_file.py`).

affects: >=24.3.0

gotchaPyink intentionally implements several formatting differences compared to upstream Black, even when based on the same Black version. Code formatted by Pyink may not be identical to code formatted by Black.

fix

Review Pyink's README for a full list of divergences, including handling of imports (not wrapped in parentheses), class statement spacing, two-space indentation (`--pyink-indentation`), and majority-based quote style (`--pyink-use-majority-quotes`).

affects: All versions

gotchaPyink 24.10.0 had a dependency to the wrong Black version in its `pyproject.toml`, which was fixed in 24.10.1. This could lead to unexpected formatting behavior or internal inconsistencies.

fix

Upgrade to Pyink 24.10.1 or a newer version to ensure correct internal Black version alignment.

affects: 24.10.0

gotchaCertain Black features, such as Black v23.9.9's concise formatting for dummy implementations, have been temporarily disabled in specific Pyink releases to maintain Pyink's unique formatting style.

fix

Be aware that specific Black features may be selectively enabled or disabled in Pyink. Refer to the release notes for detailed information on such divergences.

affects: 23.9.1

Errors

Common errors & fixes

Error: No such option: --pyink-lines

The `--pyink-lines` option was removed in Pyink 24.3.0 after being deprecated.

fix

Use `--line-ranges` instead. For example, change `pyink --pyink-lines 10-20 my_file.py` to `pyink --line-ranges 10-20 my_file.py`.

My code is formatted differently by Pyink than by Black, even when they're supposed to be based on the same version.

Pyink has intentional formatting divergences from Black, such as handling of imports, class/method spacing, and support for 2-space indentation or majority quote styles.

fix

These are expected differences. Consult the Pyink README for a list of these divergences. Utilize Pyink-specific options like `--pyink-indentation 2` or `--pyink-use-majority-quotes` to customize behavior.

Jupyter notebooks are not formatted correctly or show unexpected changes when using Pyink.

Jupyter notebook formatting (especially `ipynb` files) has specific considerations for JSON content indentation and Unicode escaping that require dedicated options.

fix

Use Pyink's specific options for notebooks: `--pyink-ipynb-indentation` to control JSON indentation (available from 24.10.0) and `--pyink-ipynb-unicode-escape` for Unicode escaping (available from 24.10.1).

Upgrade

Version history

25.12.0latest on PyPI · released Jan 2, 2026

Audit

Dependencies

pythonrequiredRequires Python 3.10 or newer for execution.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/google/pyink ↗

packagehttps://pypi.org/project/pyink/ ↗

changeloghttps://github.com/google/pyink/blob/pyink/CHANGES.md ↗