Skip to main content

A minimalist Python formatting tool

Project description

Parsimony

A minimalist line-breaker that adds the fewest breaks to fit the line.

Unlike black/blue/ruff, which explode the outermost bracket first and stack every closing bracket on its own line, Parsimony makes the smallest change that fits an over-long line, using two complementary strategies.

Explode a bracket — open the minimum number of brackets and coalesce adjacent ones:

response = authed_client().get(reverse('forwarding:detail', args=[c.id]))

becomes

response = authed_client().get(reverse(
    'forwarding:detail',
    args=[c.id],
))

Break a method chain — split a long .-chain one segment per line. This is done for lines that can't be shortened by exploding a bracket:

queryset = SomeModel.objects.filter(active=True).order_by('-last_modified_at')

becomes

queryset = (
    SomeModel
    .objects
    .filter(active=True)
    .order_by('-last_modified_at')
)

Both keep related calls grouped and give long pipelines a clean one-operation-per-line shape.

Usage

Format files or directories (recurses for *.py):

parsimony -i src/       # rewrite in place
parsimony --check src/  # print a diff, exit 1 if anything would change
parsimony src/file.py   # print formatted output to stdout

Read from stdin and write to stdout:

parsimony < src/file.py
cat src/file.py | parsimony

Installation

pip install kaapstorm-parsimony

Algorithm

While a physical line exceeds LINE_LENGTH, explode one container that intersects an over-long line, chosen by:

  1. multi-item containers only (>= 2 args/elements); single-item containers are never opened — see "Contract" below.
  2. outermost (shallowest) of those.

Then re-measure and repeat. "Explode" = each element on its own line at a +4 hanging indent, with a trailing comma, and the closing bracket dedented to the opening line's indent. Because we only open the chosen container and never its single-item parents, adjacent openers like get(reverse( remain coalesced. Coalescing is not about depth, only about not opening single-item wrappers.

When no multi-item container intersects a remaining over-long line, fall back to breaking the outermost method chain on it (>= 2 call segments, as shown above): wrap it in parentheses and put the head plus each .attr on its own +4 line. Bracket explosion is preferred — a chain is only broken when opening a bracket cannot fix the line — which keeps breaks minimal. Any brackets already opened inside a segment are re-indented to stay aligned under their now-deeper segment.

Contract

The tool only ever adds breaks to over-long lines; it never removes or rewrites existing breaks. This makes it idempotent, safe to re-run, and safe to combine with hand-formatting. Preserving existing line breaks is intentional, so it cannot be combined with ruff format, which would re-flow its output back into the staircase. Pair it with ruff-as-linter (E501 off) instead.

Multi-item-only is also a correctness guardrail: opening a single-item subscript would turn x[0] into x[0,] (== x[(0,)]), which changes meaning. Restricting to multi-item containers avoids that. It also avoids ugly single-element splits.

Limitations

  • Lines long for non-bracket, non-method-chain reasons — ternaries, boolean/arithmetic chains, pure attribute chains (no calls), long string literals — are left untouched and reported, not fixed.
  • No "join" pass: it will not re-flow code that another tool has already split. It only acts on lines that are physically too long.
  • Comments inside brackets and pre-existing trailing commas are not specially handled.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kaapstorm_parsimony-0.1.3.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kaapstorm_parsimony-0.1.3-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file kaapstorm_parsimony-0.1.3.tar.gz.

File metadata

  • Download URL: kaapstorm_parsimony-0.1.3.tar.gz
  • Upload date:
  • Size: 30.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kaapstorm_parsimony-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a856eb29a07d9d971c8e52bdf15f0146842783fd140cbd2bb27a6144eaa970b5
MD5 038a500a0ae52eecb50b949ced7d7e1e
BLAKE2b-256 ce2f190bef5c0b5871a82855b96aba9ff9b76bfa0440ebbf9c17aee4b871dd4c

See more details on using hashes here.

Provenance

The following attestation bundles were made for kaapstorm_parsimony-0.1.3.tar.gz:

Publisher: publish.yml on kaapstorm/parsimony

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kaapstorm_parsimony-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for kaapstorm_parsimony-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 48754ad517b7ffbcbc84cda6dad6abd3cf4ad2c2b4fb38322703171ab454e9fd
MD5 e453320e1f74a62a09a231cfa20a1fcc
BLAKE2b-256 8ef7517d260312ebb7fb943b8aec175cb70ae81d28a2a6a5ec3e9935690591b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for kaapstorm_parsimony-0.1.3-py3-none-any.whl:

Publisher: publish.yml on kaapstorm/parsimony

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page