pax_global_header 0000666 0000000 0000000 00000000064 15262335054 0014517 g ustar 00root root 0000000 0000000 52 comment=258e7dbf348bc23cb70b8cdf693481c04634ebcc
psf-black-258e7db/ 0000775 0000000 0000000 00000000000 15262335054 0014003 5 ustar 00root root 0000000 0000000 psf-black-258e7db/.flake8 0000664 0000000 0000000 00000000463 15262335054 0015161 0 ustar 00root root 0000000 0000000 [flake8]
ignore = E203, E266, E501, E701, E704, W503, B907
# line length is intentionally set to 80 here because black uses Bugbear
# See https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#bugbear for more details
max-line-length = 80
max-complexity = 18
select = B,E,F,W,T4,B9
psf-black-258e7db/.git_archival.txt 0000664 0000000 0000000 00000000153 15262335054 0017255 0 ustar 00root root 0000000 0000000 node: 258e7dbf348bc23cb70b8cdf693481c04634ebcc
node-date: 2026-10-09T21:08:12-07:00
describe-name: 26.10.1
psf-black-258e7db/.gitattributes 0000664 0000000 0000000 00000000061 15262335054 0016673 0 ustar 00root root 0000000 0000000 .git_archival.txt export-subst
*.py diff=python
psf-black-258e7db/.github/ 0000775 0000000 0000000 00000000000 15262335054 0015343 5 ustar 00root root 0000000 0000000 psf-black-258e7db/.github/CODE_OF_CONDUCT.md 0000664 0000000 0000000 00000001052 15262335054 0020140 0 ustar 00root root 0000000 0000000 # Treat each other well
Everyone participating in the _Black_ project, and in particular in the issue tracker,
pull requests, and social media activity, is expected to treat other people with respect
and more generally to follow the guidelines articulated in the
[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
At the same time, humor is encouraged. In fact, basic familiarity with Monty Python's
Flying Circus is expected. We are not savages.
And if you _really_ need to slap somebody, do it with a fish while dancing.
psf-black-258e7db/.github/ISSUE_TEMPLATE/ 0000775 0000000 0000000 00000000000 15262335054 0017526 5 ustar 00root root 0000000 0000000 psf-black-258e7db/.github/ISSUE_TEMPLATE/bug_report.md 0000664 0000000 0000000 00000003027 15262335054 0022222 0 ustar 00root root 0000000 0000000 ---
name: Bug report
about: Create a report to help us improve Black's quality
title: ""
labels: "T: bug"
assignees: ""
---
**Describe the bug**
**To Reproduce**
For example, take this code:
```python
this = "code"
```
And run it with these arguments:
```sh
$ black file.py --target-version py310
```
The resulting error is:
> cannot format file.py: INTERNAL ERROR: ...
**Expected behavior**
**Environment**
- Black's version:
- OS and Python version:
**Additional context**
psf-black-258e7db/.github/ISSUE_TEMPLATE/config.yml 0000664 0000000 0000000 00000001034 15262335054 0021514 0 ustar 00root root 0000000 0000000 # See also: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
# This is the default and blank issues are useful so let's keep 'em.
blank_issues_enabled: true
contact_links:
- name: Chat on Python Discord
url: https://discord.gg/RtVdv86PrH
about: >-
User support, questions, and other lightweight requests can be handled via the
#black-formatter text channel we have on Python Discord.
psf-black-258e7db/.github/ISSUE_TEMPLATE/docs-issue.md 0000664 0000000 0000000 00000001264 15262335054 0022131 0 ustar 00root root 0000000 0000000 ---
name: Documentation
about: Report a problem with or suggest something for the documentation
title: ""
labels: "T: documentation"
assignees: ""
---
**Is this related to a problem? Please describe.**
**Describe the solution you'd like**
**Describe alternatives you've considered**
**Additional context**
psf-black-258e7db/.github/ISSUE_TEMPLATE/feature_request.md 0000664 0000000 0000000 00000001211 15262335054 0023246 0 ustar 00root root 0000000 0000000 ---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: "T: enhancement"
assignees: ""
---
**Is your feature request related to a problem? Please describe.**
**Describe the solution you'd like**
**Describe alternatives you've considered**
**Additional context**
psf-black-258e7db/.github/ISSUE_TEMPLATE/style_issue.md 0000664 0000000 0000000 00000001336 15262335054 0022423 0 ustar 00root root 0000000 0000000 ---
name: Code style issue
about: Help us improve the Black code style
title: ""
labels: "T: style"
assignees: ""
---
**Describe the style change**
**Examples in the current _Black_ style**
```python
def f():
"""This code should be formatted as per the current Black style"""
pass
```
**Desired style**
```python
def f(
):
"""This code can be formatted however you suggest!"""
pass
```
**Additional context**
psf-black-258e7db/.github/PULL_REQUEST_TEMPLATE.md 0000664 0000000 0000000 00000003715 15262335054 0021152 0 ustar 00root root 0000000 0000000
### Description
### Checklist - did you ...
- [ ] Implement any code style changes under the `--preview` style, following the stability policy?
- [ ] Add an entry in `CHANGES.md` if necessary?
- [ ] Add / update tests if necessary?
- [ ] Add new / update outdated documentation?
psf-black-258e7db/.github/dependabot.yml 0000664 0000000 0000000 00000001136 15262335054 0020174 0 ustar 00root root 0000000 0000000 # https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "github-actions"
# Workflow files in .github/workflows will be checked
directory: "/"
labels: ["ci: skip news", "C: dependencies", "C: maintenance"]
schedule:
interval: daily
cooldown:
default-days: 2
- package-ecosystem: "pip"
directory: "/"
labels: ["ci: skip news", "C: dependencies"]
schedule:
interval: daily
cooldown:
default-days: 2
psf-black-258e7db/.github/workflows/ 0000775 0000000 0000000 00000000000 15262335054 0017400 5 ustar 00root root 0000000 0000000 psf-black-258e7db/.github/workflows/changelog.yml 0000664 0000000 0000000 00000001452 15262335054 0022054 0 ustar 00root root 0000000 0000000 name: changelog
on:
pull_request:
types: [opened, synchronize, labeled, unlabeled, reopened]
env:
PIP_UPLOADED_PRIOR_TO: P2D
permissions:
contents: read
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Grep CHANGES.md for PR number
if: >
contains(github.event.pull_request.labels.*.name, 'ci: skip news') != true
run: |
grep -P '\((#\d+,\s+)*#${{ github.event.pull_request.number }}(,\s+#\d+)*\)$' CHANGES.md || \
(echo "Please add '(#${{ github.event.pull_request.number }})' change line to CHANGES.md (or if appropriate, ask a maintainer to add the 'ci: skip news' label)" && \
exit 1)
psf-black-258e7db/.github/workflows/cut_release.yml 0000664 0000000 0000000 00000015616 15262335054 0022427 0 ustar 00root root 0000000 0000000 name: cut release
on:
pull_request:
branches: main
types: closed
paths: docs/integrations/source_version_control.md
workflow_dispatch:
permissions: {}
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
release:
if:
github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged &&
github.event.pull_request.head.repo.full_name == 'psf/black' &&
startsWith(github.head_ref, 'ci/prepare-release/'))
runs-on: ubuntu-latest
outputs:
version: ${{ steps.version.outputs.version }}
permissions:
contents: write # Needed to create release
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group release
- name: Get version
id: version
run: |
version=$(echo "$HEAD" | cut -d'/' -f3)
if [ "$REF" == "refs/heads/main" ]; then
echo "version=$version" >> "$GITHUB_OUTPUT"
else
echo "version=$(python scripts/release.py prerelease $version)" >> "$GITHUB_OUTPUT"
fi
env:
HEAD: ${{ github.head_ref || github.ref_name }}
REF: ${{ github.ref }}
- name: Delete previous release if exists
run: gh release delete "$VERSION" --yes || true
env:
GITHUB_TOKEN: ${{ github.token }}
VERSION: ${{ steps.version.outputs.version }}
- name: Get changelog
id: changelog
run: python scripts/release.py changes >> /tmp/changes
- name: Create draft release
run:
gh release create "$VERSION" --target "$REF" -d -t "$VERSION" -F /tmp/changes
env:
GITHUB_TOKEN: ${{ github.token }}
REF: ${{ github.ref }}
VERSION: ${{ steps.version.outputs.version }}
new-changelog:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
needs: release
permissions:
contents: write # Needed to push to new branch
pull-requests: write # Needed to create PR
steps:
- name: Checkout main branch
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: main
fetch-depth: 0
persist-credentials: true # Needed for git-auto-commit-action
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group release
- name: Add new changelog
run: python scripts/release.py add
- name: Commit new changelog
uses: stefanzweifel/git-auto-commit-action@4a55954c782fc1ea30b9056cd3e7a2b40ca8887d # v7.2.0
with:
commit_message: Add new changelog
branch: ci/new-changelog
create_branch: true
env:
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN || github.token }}
- name: Create PR
run: |
gh pr create \
-t "Add new changelog" -b "This PR is automated" \
-l "ci: skip news" -l "C: maintenance" \
-a "$USER"
env:
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN || github.token }}
USER: ${{ github.triggering_actor }}
binaries:
name: build-binaries (${{ matrix.os }})
runs-on: ${{ matrix.os }}
needs: release
strategy:
fail-fast: false
matrix:
include:
- os: windows-latest
pathsep: ";"
asset_name: black_windows.exe
strip: false
- os: windows-11-arm
pathsep: ";"
asset_name: black_windows-arm.exe
strip: false
- os: ubuntu-latest
pathsep: ":"
asset_name: black_linux
strip: true
- os: ubuntu-24.04-arm
pathsep: ":"
asset_name: black_linux-arm
strip: true
- os: macos-latest
pathsep: ":"
asset_name: black_macos
strip: false
permissions:
contents: write # Needed to upload to release
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install ".[colorama]" --group pyinstaller
- name: Create version file
shell: bash
run: echo "version = \"$VERSION\"" > src/_black_version.py
env:
VERSION: ${{ needs.release.outputs.version }}
- name: Build executable with PyInstaller
shell: bash
run:
python -m PyInstaller --add-data 'src/blib2to3${{ matrix.pathsep }}blib2to3'
-F ${{ matrix.strip && '--strip' || '' }} --name ${{ matrix.asset_name }}
src/black/__main__.py
- name: Quickly test executable
shell: bash
run: |
./dist/${{ matrix.asset_name }} --version
[[ $(./dist/${{ matrix.asset_name }} --version) != *" $VERSION "* ]] && exit 1
./dist/${{ matrix.asset_name }} src --check --verbose
env:
VERSION: ${{ needs.release.outputs.version }}
- name: Upload assets
shell: bash
run: gh release upload "$VERSION" dist/${{ matrix.asset_name }} --clobber
env:
GITHUB_TOKEN: ${{ github.token }}
VERSION: ${{ needs.release.outputs.version }}
update-stable:
runs-on: ubuntu-latest
needs: [release, binaries]
permissions:
contents: write # Needed to publish release & push to stable
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
persist-credentials: true # needed for `git push` below
- name: Publish release
run: |
gh release edit "$VERSION" --draft=false \
${{ case(github.ref == 'refs/heads/main', '', '--prerelease') }}
env:
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }} # no fallback, error if CI won't trigger
VERSION: ${{ needs.release.outputs.version }}
- name: Update stable branch to release tag & push
if: github.ref == 'refs/heads/main'
run: |
git checkout stable
git fetch
git reset --hard "$VERSION"
git push
env:
VERSION: ${{ needs.release.outputs.version }}
psf-black-258e7db/.github/workflows/diff_shades.yml 0000664 0000000 0000000 00000020315 15262335054 0022363 0 ustar 00root root 0000000 0000000 name: diff-shades
on:
push:
branches: [main]
paths:
- src/**
- pyproject.toml
- scripts/diff_shades_gha_helper.py
- .github/workflows/diff_shades.yml
- .github/workflows/diff_shades_comment.yml
pull_request:
paths:
- src/**
- pyproject.toml
- scripts/diff_shades_gha_helper.py
- .github/workflows/diff_shades.yml
- .github/workflows/diff_shades_comment.yml
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
cancel-in-progress: true
env:
HATCH_BUILD_HOOKS_ENABLE: "1"
PIP_UPLOADED_PRIOR_TO: P2D
# Clang is less picky with the C code it's given than gcc (and may generate faster
# binaries too).
CC: clang-18
permissions: {}
jobs:
configure:
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.set-config.outputs.matrix }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group diff-shades --group diff-shades-comment
- name: Calculate run configuration & metadata
id: set-config
env:
GITHUB_TOKEN: ${{ github.token }}
run: python scripts/diff_shades_gha_helper.py config
analysis-base:
name: analysis / base / ${{ matrix.mode }}
needs: configure
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(needs.configure.outputs.matrix) }}
steps:
- name: Checkout this repository (full clone)
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
# The baseline revision could be rather old so a full clone is ideal.
fetch-depth: 0
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group diff-shades
- name: Configure git
run: |
git config user.name "diff-shades-gha"
git config user.email "diff-shades-gha@example.com"
- name: Attempt to use cached baseline analysis
id: baseline-cache
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
path: ${{ matrix.baseline-analysis }}
key: ${{ matrix.baseline-cache-key }}
- name: Build and install baseline revision
if: steps.baseline-cache.outputs.cache-hit != 'true'
env:
GITHUB_TOKEN: ${{ github.token }}
run: |
${{ matrix.baseline-setup-cmd }}
python -m pip install .
- name: Analyze baseline revision
if: steps.baseline-cache.outputs.cache-hit != 'true'
run:
diff-shades analyze ${{ matrix.baseline-analysis }} --work-dir projects-cache/
--force-${{ matrix.style }}-style -v
- name: Upload baseline analysis
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: ${{ matrix.baseline-analysis }}
path: ${{ matrix.baseline-analysis }}
analysis-target:
name: analysis / target / ${{ matrix.mode }}
needs: configure
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(needs.configure.outputs.matrix) }}
steps:
- name: Checkout this repository (full clone)
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
# The baseline revision could be rather old so a full clone is ideal.
fetch-depth: 0
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group diff-shades
- name: Configure git
run: |
git config user.name "diff-shades-gha"
git config user.email "diff-shades-gha@example.com"
- name: Build and install target revision
env:
GITHUB_TOKEN: ${{ github.token }}
run: |
${{ matrix.target-setup-cmd }}
python -m pip install .
# Pull it from previous runs - we're NOT trying to get it from this run
# (but it wouldn't cause problems if we theoretically did)
- name: Attempt to find baseline analysis
id: baseline-cache
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
path: ${{ matrix.baseline-analysis }}
key: ${{ matrix.baseline-cache-key }}
- name: Analyze target revision (with repeated projects)
if: steps.baseline-cache.outputs.cache-hit == 'true'
run: |
diff-shades analyze ${{ matrix.target-analysis }} --work-dir projects-cache/ \
--force-${{ matrix.style }}-style -v \
--repeat-projects-from ${{ matrix.baseline-analysis }}
- name: Analyze target revision (without repeated projects)
if: steps.baseline-cache.outputs.cache-hit != 'true'
run:
diff-shades analyze ${{ matrix.target-analysis }} --work-dir projects-cache/
--force-${{ matrix.style }}-style -v
- name: Upload target analysis
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: ${{ matrix.target-analysis }}
path: ${{ matrix.target-analysis }}
- name: Check for failed files for target revision
run: diff-shades show-failed --check --show-log ${{ matrix.target-analysis }}
compare:
name: compare / ${{ matrix.mode }}
needs: ["configure", "analysis-base", "analysis-target"]
if: ${{ !cancelled() }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(needs.configure.outputs.matrix) }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
merge-multiple: true
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group diff-shades --group diff-shades-comment
- name: Generate HTML diff report
run: |
diff-shades --dump-html diff.html \
compare --diff ${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }}
- name: Upload diff report
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: ${{ matrix.style }}-diff.html
path: diff.html
- name: Generate summary file (PR only)
if: github.event_name == 'pull_request'
env:
GITHUB_TOKEN: ${{ github.token }}
run: |
python scripts/diff_shades_gha_helper.py comment-body \
${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }} \
${{ matrix.style }} ${{ matrix.mode }}
- name: Upload summary file (PR only)
if: github.event_name == 'pull_request'
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: .${{ matrix.style }}.pr-comment.md
path: .${{ matrix.style }}.pr-comment.md
include-hidden-files: true
- name: Verify zero changes (PR only)
if: matrix.mode == 'assert-no-changes'
run: |
diff-shades compare --check \
${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }} || \
(echo "Please verify you didn't change the stable code style unintentionally!" \
&& exit 1)
psf-black-258e7db/.github/workflows/diff_shades_comment.yml 0000664 0000000 0000000 00000010621 15262335054 0024104 0 ustar 00root root 0000000 0000000 name: diff-shades comment
on:
workflow_run:
workflows: [diff-shades]
types: [completed]
permissions: {}
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
comment:
runs-on: ubuntu-latest
# We want to comment even if there were failed files or the stable style changed
# That would cause the main workflow to "fail"
if:
github.event.workflow_run.event == 'pull_request' &&
contains(fromJSON('["success", "failure"]'), github.event.workflow_run.conclusion)
permissions:
pull-requests: write # Needed to comment on PR
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
id: artifacts
with:
merge-multiple: true
pattern: ".*.pr-comment.md"
path: ${{ runner.temp }}/diff-shades-artifacts
github-token: ${{ github.token }}
run-id: ${{ github.event.workflow_run.id }}
- name: Validate downloaded comment artifacts
id: comment-artifacts
shell: bash
run: |
set -euo pipefail
artifact_dir="${RUNNER_TEMP}/diff-shades-artifacts"
preview_artifact="${artifact_dir}/.preview.pr-comment.md"
stable_artifact="${artifact_dir}/.stable.pr-comment.md"
if [ ! -d "$artifact_dir" ]; then
echo "::error::Artifact directory does not exist: ${artifact_dir}"
exit 1
fi
while IFS= read -r -d '' entry; do
if [ "$(dirname "$entry")" != "$artifact_dir" ]; then
echo "::error::Unexpected nested artifact path: ${entry}"
exit 1
fi
case "$(basename "$entry")" in
.preview.pr-comment.md|.stable.pr-comment.md) ;;
*)
echo "::error::Unexpected artifact path: ${entry}"
exit 1
;;
esac
if [ ! -f "$entry" ] || [ -L "$entry" ]; then
echo "::error::Artifact must be a regular file: ${entry}"
exit 1
fi
done < <(find "$artifact_dir" -mindepth 1 -print0)
for artifact in "$preview_artifact" "$stable_artifact"; do
if [ ! -f "$artifact" ] || [ -L "$artifact" ]; then
echo "::error::Missing expected artifact file: ${artifact}"
exit 1
fi
done
{
echo "preview=${preview_artifact}"
echo "stable=${stable_artifact}"
} >> "$GITHUB_OUTPUT"
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group diff-shades-comment
- name: Get PR number
id: pr
run:
echo pr=$(gh pr list --search $sha --json number --jq ".[0].number") >>
"$GITHUB_OUTPUT"
env:
GITHUB_TOKEN: ${{ github.token }}
sha: ${{ github.event.workflow_run.head_sha }}
- name: Get details from initial workflow run
id: metadata
run: |
python scripts/diff_shades_gha_helper.py comment-details \
"$pr" "$run_id" "$preview_artifact" "$stable_artifact"
env:
GITHUB_TOKEN: ${{ github.token }}
pr: ${{ steps.pr.outputs.pr }}
run_id: ${{ github.event.workflow_run.id }}
preview_artifact: ${{ steps.comment-artifacts.outputs.preview }}
stable_artifact: ${{ steps.comment-artifacts.outputs.stable }}
- name: Try to find pre-existing PR comment
id: find-comment
uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad # v4.0.0
with:
issue-number: ${{ steps.pr.outputs.pr }}
comment-author: "github-actions[bot]"
body-includes: "diff-shades"
- name: Create or update PR comment
uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
with:
comment-id: ${{ steps.find-comment.outputs.comment-id }}
issue-number: ${{ steps.pr.outputs.pr }}
body: ${{ steps.metadata.outputs.comment-body }}
edit-mode: replace
psf-black-258e7db/.github/workflows/docker.yml 0000664 0000000 0000000 00000007240 15262335054 0021375 0 ustar 00root root 0000000 0000000 name: docker
on:
push:
branches:
- "main"
release:
types: [published]
permissions:
contents: read
env:
PIP_UPLOADED_PRIOR_TO: P2D
REGISTRY: pyfound/black
jobs:
build:
if: github.repository == 'psf/black'
runs-on: ${{ matrix.runner }}
name: build (${{ matrix.platform }})
strategy:
matrix:
include:
- platform: linux/amd64
runner: ubuntu-latest
- platform: linux/arm64
runner: ubuntu-24.04-arm
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
- name: Login to DockerHub
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Prepare
id: prepare
run: echo "platform=${platform//\//-}" >> $GITHUB_OUTPUT
env:
platform: ${{ matrix.platform }}
- name: Build and push
id: build
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
with:
context: .
platforms: ${{ matrix.platform }}
outputs: type=image,push-by-digest=true,name-canonical=true,push=true
tags: ${{ env.REGISTRY }}
cache-from: type=gha,scope=${{ steps.prepare.outputs.platform }}
cache-to: type=gha,scope=${{ steps.prepare.outputs.platform }},mode=max
- name: Export digest
run: |
mkdir -p digests
touch "digests/${digest#sha256:}"
env:
digest: ${{ steps.build.outputs.digest }}
- name: Upload digest
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: digests-${{ steps.prepare.outputs.platform }}
path: digests/*
if-no-files-found: error
push:
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Download digests
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
path: digests
pattern: digests-*
merge-multiple: true
- name: Login to DockerHub
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
- name: Create manifest list and push
run: |
TAGS="-t $REGISTRY:latest"
if [[ "$EVENT_NAME" == "release" ]]; then
TAGS="$TAGS -t $REGISTRY:$(git describe --candidates=0 --tags)"
if [[ "$PRERELEASE" == "true" ]]; then
TAGS="$TAGS -t $REGISTRY:latest_prerelease"
else
TAGS="$TAGS -t $REGISTRY:latest_release"
fi
else
TAGS="$TAGS -t $REGISTRY:latest_non_release"
fi
cd digests
docker buildx imagetools create $TAGS $(printf "$REGISTRY@sha256:%s " *)
env:
EVENT_NAME: ${{ github.event_name }}
PRERELEASE: ${{ github.event.release.prerelease }}
- name: Inspect image
run: docker buildx imagetools inspect $REGISTRY:latest
psf-black-258e7db/.github/workflows/docs.yml 0000664 0000000 0000000 00000001732 15262335054 0021056 0 ustar 00root root 0000000 0000000 name: docs
on:
push:
paths:
- docs/**
- src/**
- pyproject.toml
- .github/workflows/docs.yml
pull_request:
paths:
- docs/**
- src/**
- pyproject.toml
- .github/workflows/docs.yml
permissions:
contents: read
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
docs:
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install -e ".[d]" --group docs
- name: Build documentation
run: sphinx-build -a -b html -W --keep-going docs/ docs/_build
psf-black-258e7db/.github/workflows/fuzz.yml 0000664 0000000 0000000 00000006374 15262335054 0021133 0 ustar 00root root 0000000 0000000 name: fuzz
on:
push:
branches: main
pull_request:
paths:
- .github/workflows/fuzz.yml
- scripts/fuzz.py
schedule:
- cron: "0 0 * * *"
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
permissions:
contents: read
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
fuzz:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
pip-version: "26.1"
- name: Install dependencies
run: python -m pip install --group tox
- name: Run fuzz tests
id: fuzz
run: tox -e fuzz --result-json $python_ver
env:
python_ver: ${{ matrix.python-version }}
- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
if: failure() && steps.fuzz.outcome == 'failure'
with:
name: ${{ matrix.python-version }}
path: ${{ matrix.python-version }}
create-issue:
runs-on: ubuntu-latest
needs: fuzz
if:
github.repository == 'psf/black' && github.event_name != 'pull_request' &&
failure()
permissions:
issues: write # Needed to create issue
steps:
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
merge-multiple: true
path: ./output
- name: Generate issue data
run: |
output=issue-body.html
touch $output
for FILE in ./output/*; do
echo "**Python $(basename $FILE)**" >> $output
echo -e "\`\`\`py" >> $output
echo -e "# stdout:" >> $output
echo -e "$(jq .testenvs.fuzz.test[-1].output $FILE -r)\n" >> $output
echo -e "# stderr:" >> $output
echo -e "$(jq .testenvs.fuzz.test[-1].err $FILE -r)" >> $output
echo -e "\`\`\`\n" >> $output
done
- name: Get existing issue
id: issue
run: |
echo "ISSUE=$( gh issue list \
-A github-actions[bot] -l 'ci: fuzz error' \
--json number -q .[0].number \
-R $REPO )" >> $GITHUB_OUTPUT
env:
GITHUB_TOKEN: ${{ github.token }}
REPO: ${{ github.repository }}
- name: Create new issue
if: steps.issue.outputs.ISSUE == ''
run: >
gh issue create -t "Fuzz test failure" -F issue-body.html -l "ci: fuzz error"
-R $REPO
env:
GITHUB_TOKEN: ${{ github.token }}
REPO: ${{ github.repository }}
- name: Edit existing issue
if: steps.issue.outputs.ISSUE != ''
run: gh issue edit $ISSUE -F issue-body.html -R $REPO
env:
GITHUB_TOKEN: ${{ github.token }}
REPO: ${{ github.repository }}
ISSUE: ${{ steps.issue.outputs.ISSUE }}
psf-black-258e7db/.github/workflows/lint.yml 0000664 0000000 0000000 00000002764 15262335054 0021102 0 ustar 00root root 0000000 0000000 name: lint and format
on: [push, pull_request]
permissions: {}
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
lint:
# We want to run on external PRs, but not on our own internal PRs as they'll be run
# by the push to the branch. Without this if check, checks are duplicated since
# internal PRs match both the push and pull_request events.
if:
github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
github.repository
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Assert PR target is main
if: github.event_name == 'pull_request' && github.repository == 'psf/black'
run: |
if [ "$GITHUB_BASE_REF" != "main" ]; then
echo "::error::PR targeting '$GITHUB_BASE_REF', please refile targeting 'main'." && exit 1
fi
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install -e . --group tox
- name: Run pre-commit hooks
uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
- name: Format ourselves
run: tox -e run_self
- name: Regenerate schema
run: |
tox -e generate_schema
git diff --exit-code
psf-black-258e7db/.github/workflows/prepare_release.yml 0000664 0000000 0000000 00000007176 15262335054 0023274 0 ustar 00root root 0000000 0000000 name: prepare release
on:
workflow_dispatch:
inputs:
Version_Override:
type: string
push:
branches: ci/prepare-release/*
permissions: {}
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
create:
if: github.event_name == 'workflow_dispatch'
runs-on: ubuntu-latest
permissions:
contents: write # Needed to push to new branch
pull-requests: write # Needed to create PR
outputs:
version: ${{ steps.version.outputs.version }}
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
persist-credentials: true # Needed for git-auto-commit-action
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group release
- name: Prepare repo
run: python scripts/release.py prepare "$VERSION"
env:
VERSION: ${{ inputs.Version_Override }}
- name: Get version
id: version
run:
echo "version=${VERSION:-$(python scripts/release.py version)}" >>
"$GITHUB_OUTPUT"
env:
VERSION: ${{ inputs.Version_Override }}
- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@4a55954c782fc1ea30b9056cd3e7a2b40ca8887d # v7.2.0
with:
commit_message: "Prepare release ${{ steps.version.outputs.version }}"
branch: "ci/prepare-release/${{ steps.version.outputs.version }}"
create_branch: true
env:
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN || github.token }}
- name: Create release PR
run: |
gh pr create \
-t "Prepare release $VERSION" -b "" \
-l "ci: skip news" -l "C: maintenance" \
-a "$USER"
env:
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN || github.token }}
USER: ${{ github.triggering_actor }}
VERSION: ${{ steps.version.outputs.version }}
update:
needs: create
if:
always() && (needs.create.result == 'skipped' || needs.create.result == 'success')
runs-on: ubuntu-latest
permissions:
pull-requests: write # Needed to edit PR
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
persist-credentials: false
- name: Write PR description
run: |
{
echo ""
echo "Please follow the process in [the docs](https://black.readthedocs.io/en/latest/contributing/release_process.html#cutting-a-release) to cut a release."
echo "Changelog Diff
"
echo
echo '`````diff'
git diff origin/stable "origin/$BRANCH" -- CHANGES.md
echo '`````'
echo
echo " "
echo "This PR is automated"
} > description.md
env:
BRANCH: |-
${{ needs.create.outputs.version
&& format('ci/prepare-release/{0}', needs.create.outputs.version)
|| github.ref_name }}
- name: Edit release PR
run: gh pr edit "$BRANCH" -F description.md
env:
GITHUB_TOKEN: ${{ github.token }}
BRANCH: |-
${{ needs.create.outputs.version
&& format('ci/prepare-release/{0}', needs.create.outputs.version)
|| github.ref_name }}
psf-black-258e7db/.github/workflows/pypi_upload.yml 0000664 0000000 0000000 00000013436 15262335054 0022457 0 ustar 00root root 0000000 0000000 name: build and publish
on:
release:
types: published
pull_request:
push:
branches: main
permissions: {}
env:
PIP_UPLOADED_PRIOR_TO: P2D
PROJECT: https://pypi.org/p/black
jobs:
configure:
name: generate wheels matrix
runs-on: ubuntu-latest
outputs:
include: ${{ steps.set-matrix.outputs.include }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group cibw
- name: generate matrix
if: |
github.event_name != 'pull_request' || contains(github.event.pull_request.labels.*.name, 'ci: build all wheels')
run: |
{
cibuildwheel --print-build-identifiers --platform linux \
| jq -Rn '[{"only": inputs, "os": "ubuntu-latest"}]'
cibuildwheel --print-build-identifiers --platform macos \
| jq -Rn '[{"only": inputs, "os": "macos-latest"}]'
cibuildwheel --print-build-identifiers --platform windows \
| jq -Rn '[{"only": inputs, "os": "windows-latest"}]'
cibuildwheel --print-build-identifiers --platform windows --archs ARM64 \
| jq -Rn '[{"only": inputs, "os": "windows-11-arm"}]'
} | jq -cs 'add' > /tmp/matrix
env:
CIBW_ARCHS_LINUX: x86_64
CIBW_ARCHS_MACOS: x86_64 arm64
CIBW_ARCHS_WINDOWS: AMD64
- name: generate matrix (PR)
if: |
github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'ci: build all wheels')
run: |
{
CIBW_BUILD="cp310-*" cibuildwheel --print-build-identifiers --platform linux \
| jq -Rn '[{"only": inputs, "os": "ubuntu-latest"}]'
CIBW_BUILD="cp312-*" cibuildwheel --print-build-identifiers --platform macos \
| jq -Rn '[{"only": inputs, "os": "macos-latest"}]'
CIBW_BUILD="cp314-*" cibuildwheel --print-build-identifiers --platform windows \
| jq -Rn '[{"only": inputs, "os": "windows-latest"}]'
} | jq -cs 'add' > /tmp/matrix
env:
CIBW_ARCHS_LINUX: x86_64
- id: set-matrix
run: echo "include=$(cat /tmp/matrix)" | tee -a $GITHUB_OUTPUT
mypyc:
name: mypyc wheels ${{ matrix.only }}
needs: configure
runs-on: ${{ matrix.os }}
strategy:
matrix:
include: ${{ fromJson(needs.configure.outputs.include) }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group cibw
- name: Run cibuildwheel
run: cibuildwheel . --only ${{ matrix.only }}
- name: Upload wheels as workflow artifacts
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: ${{ matrix.only }}-mypyc-wheels
path: wheelhouse/
hatch:
name: sdist + pure wheel
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install --group hatch
- name: Calculate PIP_UPLOADED_PRIOR_TO
# virtualenv 20.39 uses pip 26.0 - manually calculate this until we bump virtualenv/hatch
id: uploaded_prior_to
run:
echo "date=$(date -u -d "2 days ago" +%Y-%m-%dT%H:%M:%SZ)" >> "$GITHUB_OUTPUT"
- name: Build wheel and source distributions
run: python -m hatch build
env:
PIP_UPLOADED_PRIOR_TO: ${{ steps.uploaded_prior_to.outputs.date }}
- name: Store the distribution packages
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: sdist-and-pure-wheel
path: dist/
publish-mypyc:
if: github.event_name == 'release'
needs: mypyc
runs-on: ubuntu-latest
environment:
name: release
url: ${{ env.PROJECT }}
permissions:
id-token: write # Required for PyPI trusted publishing
steps:
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
pattern: "*-mypyc-wheels"
path: wheelhouse/
merge-multiple: true
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
with:
packages-dir: wheelhouse/
verbose: true
publish-hatch:
if: github.event_name == 'release'
needs: hatch
runs-on: ubuntu-latest
environment:
name: release
url: ${{ env.PROJECT }}
permissions:
id-token: write # Required for PyPI trusted publishing
steps:
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: sdist-and-pure-wheel
path: dist/
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
with:
verbose: true
psf-black-258e7db/.github/workflows/release_tests.yml 0000664 0000000 0000000 00000003000 15262335054 0022756 0 ustar 00root root 0000000 0000000 name: test release tool
on:
push:
paths:
- .github/workflows/release_tests.yml
- scripts/release.py
- scripts/release_tests.py
pull_request:
paths:
- .github/workflows/release_tests.yml
- scripts/release.py
- scripts/release_tests.py
permissions: {}
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
test-release-tool:
runs-on: ${{ matrix.os }}
strategy:
matrix:
python-version: ["3.12", "3.13", "3.14", "3.15"]
os: [macOS-latest, ubuntu-latest, windows-latest]
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
# Give us all history, branches and tags
fetch-depth: 0
persist-credentials: false
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
pip-version: "26.1"
- name: Install dependencies
run: python -m pip install --group coverage --group release
- name: Print Python Version
run: python --version --version && which python
- name: Print Pip Version
run: pip --version && which pip
- name: Print Git Version
run: git --version && which git
- name: Run unit tests via coverage + print report
run: |
coverage run scripts/release_tests.py
coverage report --show-missing
psf-black-258e7db/.github/workflows/test.yml 0000664 0000000 0000000 00000007200 15262335054 0021101 0 ustar 00root root 0000000 0000000 name: test
on:
push:
paths:
- .github/workflows/test.yml
- src/**
- tests/**
- tox.ini
- pyproject.toml
pull_request:
paths:
- .github/workflows/test.yml
- src/**
- tests/**
- tox.ini
- pyproject.toml
- docs/integrations/source_version_control.md # Run on "Prepare Release" PRs
permissions:
contents: read
env:
PIP_UPLOADED_PRIOR_TO: P2D
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
cancel-in-progress: true
jobs:
test:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
python-version:
["3.10", "3.11", "3.12.10", "3.13", "3.14", "3.15", "pypy3.11-v7.3.22"]
os: [ubuntu-latest, macOS-latest, windows-latest, windows-11-arm]
exclude:
# setup-python only supports CPython 3.11+ on arm64 windows
- os: windows-11-arm
python-version: "3.10"
- os: windows-11-arm
python-version: "pypy3.11-v7.3.22"
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
pip-version: "26.1"
- name: Install dependencies
run: python -m pip install --group tox
- name: Unit tests
if: "!startsWith(matrix.python-version, 'pypy')"
run:
tox -e ci-py$(echo ${{ matrix.python-version }} | tr -d '.') -- -v --color=yes
- name: Unit tests (pypy)
if: "startsWith(matrix.python-version, 'pypy')"
run: tox -e ci-pypy3 -- -v --color=yes
- name: Upload coverage to Coveralls
# Upload coverage if we are on the main repository and
# we're running on Linux (this action only supports Linux)
if:
github.repository == 'psf/black' && matrix.os == 'ubuntu-latest' &&
!startsWith(matrix.python-version, 'pypy')
uses: AndreMiras/coveralls-python-action@ac868b9540fad490f7ca82b8ca00480fd751ed19
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
parallel: true
flag-name: py${{ matrix.python-version }}-${{ matrix.os }}
debug: true
coveralls-finish:
needs: test
if: github.repository == 'psf/black'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Send finished signal to Coveralls
uses: AndreMiras/coveralls-python-action@ac868b9540fad490f7ca82b8ca00480fd751ed19
with:
parallel-finished: true
debug: true
uvloop:
if:
github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
github.repository
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macOS-latest, windows-latest, windows-11-arm]
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.15"
allow-prereleases: true
- name: Install dependencies
run: python -m pip install -e ".[uvloop]"
- name: Format ourselves
run: python -m black --check .
psf-black-258e7db/.github/workflows/zizmor.yml 0000664 0000000 0000000 00000001173 15262335054 0021457 0 ustar 00root root 0000000 0000000 name: zizmor
on:
push:
branches: ["main"]
paths: ["**.yml"]
pull_request:
paths: ["**.yml"]
permissions: {}
env:
PIP_UPLOADED_PRIOR_TO: P2D
jobs:
zizmor:
name: zizmor
runs-on: ubuntu-latest
permissions:
security-events: write # Required for upload-sarif (used by zizmor-action) to upload SARIF files.
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Run zizmor
uses: zizmorcore/zizmor-action@cc914d7f3750a2d13d75c7f184a1060aa0e9d482 # v0.6.4
psf-black-258e7db/.github/zizmor.yml 0000664 0000000 0000000 00000000616 15262335054 0017423 0 ustar 00root root 0000000 0000000 rules:
dangerous-triggers:
ignore:
# The diff-shades comment workflow intentionally runs after the unprivileged
# diff-shades workflow so it can publish the generated PR comment. It must
# treat artifacts as untrusted and only read validated files from an isolated
# artifact directory.
- diff_shades_comment.yml
dependabot-cooldown:
config:
days: 2
psf-black-258e7db/.gitignore 0000664 0000000 0000000 00000000464 15262335054 0015777 0 ustar 00root root 0000000 0000000 .venv
.coverage
.coverage.*
_build
.DS_Store
.vscode
.python-version
docs/_static/pypi.svg
.tox
__pycache__
# Packaging artifacts
black.egg-info
black.dist-info
build/
dist/
pip-wheel-metadata/
.eggs
src/_black_version.py
.idea
.dmypy.json
*.swp
.hypothesis/
venv/
.ipynb_checkpoints/
node_modules/
*.pyd
psf-black-258e7db/.pre-commit-config.yaml 0000664 0000000 0000000 00000002654 15262335054 0020273 0 ustar 00root root 0000000 0000000 # Note: don't use this config for your own repositories. Instead, see
# "Version control integration" in docs/integrations/source_version_control.md
exclude: ^(profiling/|tests/data/)
repos:
- repo: https://github.com/pycqa/isort
rev: 9.0.1
hooks:
- id: isort
- repo: https://github.com/pycqa/flake8
rev: 7.3.0
hooks:
- id: flake8
additional_dependencies:
- flake8-bugbear
- flake8-comprehensions
- flake8-simplify
exclude: ^src/blib2to3/
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v2.3.1
hooks:
- id: mypy
exclude: ^docs/conf\.py$
args: []
additional_dependencies:
- click>=8.0.0
- packaging>=22.0
- platformdirs>=2
- pytokens~=0.4.0
- tomli>=1.1.0
- uvloop>=0.15.2; sys_platform != 'win32'
- winloop>=0.5.0; sys_platform == 'win32'
# blackd
- aiohttp>=3.10
# tests
- pytest>=7
# fuzz
- hypothesis
- hypothesmith
- types-atheris
# diff-shades
- urllib3
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.9.8
hooks:
- id: prettier
types_or: [markdown, yaml, json]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: end-of-file-fixer
- id: trailing-whitespace
psf-black-258e7db/.pre-commit-hooks.yaml 0000664 0000000 0000000 00000001251 15262335054 0020141 0 ustar 00root root 0000000 0000000 # Note that we recommend using https://github.com/psf/black-pre-commit-mirror instead
# This will work about 2x as fast as using the hooks in this repository
- id: black
name: black
description: "Black: The uncompromising Python code formatter"
entry: black
language: python
minimum_pre_commit_version: 2.9.2
require_serial: true
types_or: [python, pyi]
- id: black-jupyter
name: black-jupyter
description:
"Black: The uncompromising Python code formatter (with Jupyter Notebook support)"
entry: black
language: python
minimum_pre_commit_version: 2.9.2
require_serial: true
types_or: [python, pyi, jupyter]
additional_dependencies: [".[jupyter]"]
psf-black-258e7db/.prettierrc.yaml 0000664 0000000 0000000 00000000274 15262335054 0017133 0 ustar 00root root 0000000 0000000 proseWrap: always
printWidth: 88
endOfLine: auto
overrides:
- files:
- ".github/ISSUE_TEMPLATE/*.md"
- ".github/PULL_REQUEST_TEMPLATE.md"
options:
proseWrap: never
psf-black-258e7db/.readthedocs.yaml 0000664 0000000 0000000 00000000365 15262335054 0017236 0 ustar 00root root 0000000 0000000 version: 2
formats:
- htmlzip
build:
os: ubuntu-lts-latest
tools:
python: "3.14"
jobs:
install:
- pip install --upgrade pip
- pip install .[d]
- pip install --group docs
sphinx:
configuration: docs/conf.py
psf-black-258e7db/AUTHORS.md 0000664 0000000 0000000 00000020002 15262335054 0015444 0 ustar 00root root 0000000 0000000 # Authors
Glued together by [�ukasz Langa](mailto:lukasz@langa.pl).
Maintained with:
- [Carol Willing](mailto:carolcode@willingconsulting.com)
- [Carl Meyer](mailto:carl@oddbird.net)
- [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com)
- [Mika Naylor](mailto:mail@autophagy.io)
- [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com)
- [Cooper Lees](mailto:me@cooperlees.com)
- [Richard Si](mailto:sichard26@gmail.com)
- [Felix Hildén](mailto:felix.hilden@gmail.com)
- [Batuhan Taskaya](mailto:batuhan@python.org)
- [Shantanu Jain](mailto:hauntsaninja@gmail.com)
Multiple contributions by:
- [Abdur-Rahmaan Janhangeer](mailto:arj.python@gmail.com)
- [Adam Johnson](mailto:me@adamj.eu)
- [Adam Williamson](mailto:adamw@happyassassin.net)
- [Alexander Huynh](mailto:ahrex-gh-psf-black@e.sc)
- [Alexandr Artemyev](mailto:mogost@gmail.com)
- [Alex Vandiver](mailto:github@chmrr.net)
- [Allan Simon](mailto:allan.simon@supinfo.com)
- Anders-Petter Ljungquist
- [Amethyst Reese](mailto:amy@n7.gg)
- [Andrew Thorp](mailto:andrew.thorp.dev@gmail.com)
- [Andrew Zhou](mailto:andrewfzhou@gmail.com)
- [Andrey](mailto:dyuuus@yandex.ru)
- [Andy Freeland](mailto:andy@andyfreeland.net)
- [Anthony Sottile](mailto:asottile@umich.edu)
- [Antonio Ossa Guerra](mailto:aaossa+black@uc.cl)
- [Arjaan Buijk](mailto:arjaan.buijk@gmail.com)
- [Arnav Borbornah](mailto:arnavborborah11@gmail.com)
- [Artem Malyshev](mailto:proofit404@gmail.com)
- [Asger Hautop Drewsen](mailto:asgerdrewsen@gmail.com)
- [Augie Fackler](mailto:raf@durin42.com)
- [Aviskar KC](mailto:aviskarkc10@gmail.com)
- Batuhan TaÅŸkaya
- [Benjamin Wohlwend](mailto:bw@piquadrat.ch)
- [Benjamin Woodruff](mailto:github@benjam.info)
- [Bharat Raghunathan](mailto:bharatraghunthan9767@gmail.com)
- [Brandt Bucher](mailto:brandtbucher@gmail.com)
- [Brett Cannon](mailto:brett@python.org)
- [Bryan Bugyi](mailto:bryan.bugyi@rutgers.edu)
- [Bryan Forbes](mailto:bryan@reigndropsfall.net)
- [Calum Lind](mailto:calumlind@gmail.com)
- [Charles](mailto:peacech@gmail.com)
- Charles Reid
- [Christian Clauss](mailto:cclauss@bluewin.ch)
- [Christian Heimes](mailto:christian@python.org)
- [Chuck Wooters](mailto:chuck.wooters@microsoft.com)
- [Chris Rose](mailto:offline@offby1.net)
- Codey Oxley
- [Cong](mailto:congusbongus@gmail.com)
- [Cooper Ry Lees](mailto:me@cooperlees.com)
- [Dan Davison](mailto:dandavison7@gmail.com)
- [Daniel Hahler](mailto:github@thequod.de)
- [Daniel M. Capella](mailto:polycitizen@gmail.com)
- Daniele Esposti
- [David Hotham](mailto:david.hotham@metaswitch.com)
- [David Lukes](mailto:dafydd.lukes@gmail.com)
- [David Szotten](mailto:davidszotten@gmail.com)
- [Denis Laxalde](mailto:denis@laxalde.org)
- [Douglas Thor](mailto:dthor@transphormusa.com)
- dylanjblack
- [Eli Treuherz](mailto:eli@treuherz.com)
- [Emil Hessman](mailto:emil@hessman.se)
- [Felix Kohlgrüber](mailto:felix.kohlgrueber@gmail.com)
- [Florent Thiery](mailto:fthiery@gmail.com)
- Francisco
- [Giacomo Tagliabue](mailto:giacomo.tag@gmail.com)
- [Greg Gandenberger](mailto:ggandenberger@shoprunner.com)
- [Gregory P. Smith](mailto:greg@krypto.org)
- Gustavo Camargo
- hauntsaninja
- [Hadi Alqattan](mailto:alqattanhadizaki@gmail.com)
- [Hassan Abouelela](mailto:hassan@hassanamr.com)
- [Heaford](mailto:dan@heaford.com)
- [Hugo Barrera](mailto:hugo@barrera.io)
- Hugo van Kemenade
- [Hynek Schlawack](mailto:hs@ox.cx)
- [Ionite](mailto:dev@ionite.io)
- [Ivan Katanić](mailto:ivan.katanic@gmail.com)
- [Jakub Kadlubiec](mailto:jakub.kadlubiec@skyscanner.net)
- [Jakub Warczarek](mailto:jakub.warczarek@gmail.com)
- [Jan Hnátek](mailto:jan.hnatek@gmail.com)
- [Jason Fried](mailto:me@jasonfried.info)
- [Jason Friedland](mailto:jason@friedland.id.au)
- [jgirardet](mailto:ijkl@netc.fr)
- Jim Brännlund
- [Jimmy Jia](mailto:tesrin@gmail.com)
- [Joe Antonakakis](mailto:jma353@cornell.edu)
- [Jon Dufresne](mailto:jon.dufresne@gmail.com)
- [Jonas Obrist](mailto:ojiidotch@gmail.com)
- [Jonty Wareing](mailto:jonty@jonty.co.uk)
- [Jose Nazario](mailto:jose.monkey.org@gmail.com)
- [Joseph Larson](mailto:larson.joseph@gmail.com)
- [Josh Bode](mailto:joshbode@fastmail.com)
- [Josh Holland](mailto:anowlcalledjosh@gmail.com)
- [Joshua Cannon](mailto:joshdcannon@gmail.com)
- [José Padilla](mailto:jpadilla@webapplicate.com)
- [Juan Luis Cano RodrÃguez](mailto:hello@juanlu.space)
- [kaiix](mailto:kvn.hou@gmail.com)
- [Katie McLaughlin](mailto:katie@glasnt.com)
- Katrin Leinweber
- [Keith Smiley](mailto:keithbsmiley@gmail.com)
- [Kenyon Ralph](mailto:kenyon@kenyonralph.com)
- [Kevin Kirsche](mailto:Kev.Kirsche+GitHub@gmail.com)
- [Kyle Hausmann](mailto:kyle.hausmann@gmail.com)
- [Kyle Sunden](mailto:sunden@wisc.edu)
- Lawrence Chan
- [Linus Groh](mailto:mail@linusgroh.de)
- [Loren Carvalho](mailto:comradeloren@gmail.com)
- [Luka Sterbic](mailto:luka.sterbic@gmail.com)
- [LukasDrude](mailto:mail@lukas-drude.de)
- Mahmoud Hossam
- Mariatta
- [Matt VanEseltine](mailto:vaneseltine@gmail.com)
- [Matthew Clapp](mailto:itsayellow+dev@gmail.com)
- [Matthew Walster](mailto:matthew@walster.org)
- Max Smolens
- [Michael Aquilina](mailto:michaelaquilina@gmail.com)
- [Michael Flaxman](mailto:michael.flaxman@gmail.com)
- [Michael J. Sullivan](mailto:sully@msully.net)
- [Michael McClimon](mailto:michael@mcclimon.org)
- [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
- [Mike](mailto:roshi@fedoraproject.org)
- [mikehoyio](mailto:mikehoy@gmail.com)
- [Min ho Kim](mailto:minho42@gmail.com)
- [Miroslav Shubernetskiy](mailto:miroslav@miki725.com)
- MomIsBestFriend
- [Nathan Goldbaum](mailto:ngoldbau@illinois.edu)
- [Nathan Hunt](mailto:neighthan.hunt@gmail.com)
- [Neraste](mailto:neraste.herr10@gmail.com)
- [Nikolaus Waxweiler](mailto:madigens@gmail.com)
- [Ofek Lev](mailto:ofekmeister@gmail.com)
- [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
- [otstrel](mailto:otstrel@gmail.com)
- [Pablo Galindo](mailto:Pablogsal@gmail.com)
- [Paul Ganssle](mailto:p.ganssle@gmail.com)
- [Paul Meinhardt](mailto:mnhrdt@gmail.com)
- [Paul S. Reid](mailto:paul@reid-family.org)
- [Peter Bengtsson](mailto:mail@peterbe.com)
- [Peter Grayson](mailto:pete@jpgrayson.net)
- [Peter Stensmyr](mailto:peter.stensmyr@gmail.com)
- pmacosta
- [Quentin Pradet](mailto:quentin@pradet.me)
- [Ralf Schmitt](mailto:ralf@systemexit.de)
- [Ramón Valles](mailto:mroutis@protonmail.com)
- [Richard Fearn](mailto:richardfearn@gmail.com)
- [Rishikesh Jha](mailto:rishijha424@gmail.com)
- [Rupert Bedford](mailto:rupert@rupertb.com)
- Russell Davis
- [Sagi Shadur](mailto:saroad2@gmail.com)
- [Rémi Verschelde](mailto:rverschelde@gmail.com)
- [Sami Salonen](mailto:sakki@iki.fi)
- [Samuel Cormier-Iijima](mailto:samuel@cormier-iijima.com)
- [Sanket Dasgupta](mailto:sanketdasgupta@gmail.com)
- Sergi
- [Scott Stevenson](mailto:scott@stevenson.io)
- Shantanu
- [shaoran](mailto:shaoran@sakuranohana.org)
- [Shinya Fujino](mailto:shf0811@gmail.com)
- springstan
- [Stavros Korokithakis](mailto:hi@stavros.io)
- [Stephen Rosen](mailto:sirosen@globus.org)
- [Steven M. Vascellaro](mailto:S.Vascellaro@gmail.com)
- [Sunil Kapil](mailto:snlkapil@gmail.com)
- [Sébastien Eustace](mailto:sebastien.eustace@gmail.com)
- [Tal Amuyal](mailto:TalAmuyal@gmail.com)
- [Terrance](mailto:git@terrance.allofti.me)
- [Thom Lu](mailto:thomas.c.lu@gmail.com)
- [Thomas Grainger](mailto:tagrain@gmail.com)
- [Tim Gates](mailto:tim.gates@iress.com)
- [Tim Swast](mailto:swast@google.com)
- [Timo](mailto:timo_tk@hotmail.com)
- Toby Fleming
- [Tom Christie](mailto:tom@tomchristie.com)
- [Tony Narlock](mailto:tony@git-pull.com)
- [Tsuyoshi Hombashi](mailto:tsuyoshi.hombashi@gmail.com)
- [Tushar Chandra](mailto:tusharchandra2018@u.northwestern.edu)
- [Tushar Sadhwani](mailto:tushar.sadhwani000@gmail.com)
- [Tzu-ping Chung](mailto:uranusjr@gmail.com)
- [Utsav Shah](mailto:ukshah2@illinois.edu)
- utsav-dbx
- vezeli
- [Ville Skyttä](mailto:ville.skytta@iki.fi)
- [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
- [Vlad Emelianov](mailto:volshebnyi@gmail.com)
- [williamfzc](mailto:178894043@qq.com)
- [wouter bolsterlee](mailto:wouter@bolsterl.ee)
- Yazdan
- [Yngve Høiseth](mailto:yngve@hoiseth.net)
- [Yurii Karabas](mailto:1998uriyyo@gmail.com)
- [Zac Hatfield-Dodds](mailto:zac@zhd.dev)
psf-black-258e7db/CHANGES.md 0000664 0000000 0000000 00000275335 15262335054 0015414 0 ustar 00root root 0000000 0000000 # Change Log
## Version 26.10.1
### Highlights
This release fixes a security issue in Black's bundled GitHub Action. Repositories that
use the action are encouraged to update to the latest version of Black immediately. This
update is received automatically when using `psf/black@stable`, and is independent of
the version of Black installed by the action.
When the GitHub Action reads version specifiers from `tool.black.required-version`, it
now only accepts released versions of Black, as it already did for `black` requirements
in dependency lists. Other values, such as URL references, are now rejected. This issue
has been registered as `GHSA-cg8m-r9f2-5wm2`; a CVE identifier is pending.
### Stable style
- Fix a long Jupyter notebook assignment magic (for example `x = !ls -la`) being wrapped
in parentheses, which IPython can no longer run; such cells are now left unchanged
(#5481)
- Keep repeated lines outside the selected `--line-ranges` unchanged (#5436)
- Fix `--line-ranges` formatting lines that follow a statement when formatting joins or
re-indents that statement (#5484)
- Fix `--line-ranges` crashing with an internal error when an unselected statement has a
`# fmt: skip` comment on the last line before a closing bracket (#5477)
- Prevent moving an encoding declaration (for example `# -*- coding: latin-1 -*-`) onto
the first two lines of a file (#5487)
- Fix adding an extra trailing blank line inside a multi-line module docstring when its
last line is near the line length limit (#5494)
### Preview style
- Do not split short expressions on delimiters (such as binary operators, comparisons,
or comprehensions) inside brackets when preceded by a standalone comment (#5455)
- Fix the unstable `string_processing` feature removing backslash-newline sequences from
raw strings, which changed their value (#5482)
- Avoid adding unnecessary parentheses around unbreakable right-hand side expressions in
assignments (such as annotated assignments or subscript targets) (#5473)
- Parenthesize expressions with parameter comments when they exceed the line length
under `--preview` (#5442)
- Fix `wrap_long_dict_values_in_parens` dropping the parentheses around a right-hand
side that contains a dictionary, leaving a line over the length limit (#5492)
- Fix the unstable `string_processing` feature adding a space after `*` or `**` in a PEP
695 type parameter (`* Ts = ...`) when it splits a string in the parameter's default
(#5504)
- Avoid unnecessary line splits of trailers (such as indexing/subscripts) when an
earlier bracket split exceeds the line length only due to a trailing comment (#5498)
### Configuration
- Add `--cache-dir` to configure the cache directory from the command line (#5433)
- Don't cache a file as formatted after formatting or checking it with `--line-ranges`,
which made a later full `black --check` pass and `black` skip the unformatted lines
(#5476)
- Respect a `.gitignore` that starts with a UTF-8 byte order mark. The mark became part
of the first pattern, so that pattern never matched and Black formatted files that git
ignores (#5497)
### Performance
- Avoid quadratic runtime when splitting very long lines with many trailing bracket
pairs (such as consecutive subscripts) (#5475)
### Integrations
- Fix the GitHub Action crashing on dependency-group includes when `use_pyproject` is
enabled (#5479)
- When the GitHub Action reads version specifiers from `tool.black.required-version`, it
now only accepts released versions of Black, as it already did for `black`
requirements in dependency lists. Other values, such as URL references, are now
rejected. (#5510)
## Version 26.10.0
### Stable style
- `--line-ranges` no longer inserts an empty line after a docstring when the range
covers only the docstring itself (#5312)
- Fix `# fmt: skip` on a bracketed ternary turning the surrounding tuple into a call
(#5464)
- Fix crash when `# fmt: skip` is placed on a one-line function or class with PEP 695
type parameters (#5429)
- Fix an inline comment after the closing bracket of optional parentheses being moved
inside the parentheses when the parenthesized expression contains own-line comments
(#5395)
- Fix unparseable output when `# fmt: skip` is placed on a bracket of an `if`, `while`,
`for`, or `with` header (#5401, #5405)
- Fix crash when formatting parenthesized expressions with multiple inline comments and
`# fmt: skip` (#5414)
- Fix parsing Jupyter notebook assignment magics when non-ASCII characters appear
earlier on the line (#5381)
- Preserve blank lines that come immediately before a `# fmt: on` comment (#5300)
- Keep the parentheses around the target of an annotated assignment (e.g.
`(x): int = 5`), which prevent CPython from including the name in `__annotations__`
(#5321)
- Stop treating a t-string in docstring position as a docstring (e.g. `t" spam "` as
the first statement of a module, class or function) (#5287)
- Fix unparseable output for a t-string whose replacement field contains a quote (e.g.
`t'\'{a["b"]}\''`) (#5265)
- Fix unparseable output for a triple-quoted string whose body ends in an
already-escaped double quote (e.g. `'''\'''\"'''`) (#5262)
- Fix `--skip-magic-trailing-comma` dropping the trailing comma from a split
single-element tuple used as a lambda parameter default (#5246)
- Fix unstable formatting when an inline comment sits on optional parentheses (e.g. a
parenthesized assert message) (#5241)
- Fix `--skip-magic-trailing-comma` dropping the trailing comma of a one-element
subscript (`a[x,]`) when the line is long enough to be split and contains a power
operator (#5272)
- Fix crash when a standalone comment sits between tokens of a comprehension or lambda
(#5144)
- Fix inline comments on a bracket inside a comprehension being dropped (#5330)
- Respect the magic trailing comma in a PEP 695 type parameter list containing a
`*TypeVarTuple` or `**ParamSpec` (#5244)
- Fix crash when a comment-only `# fmt: off`/`# fmt: on` block is followed by a `with`
statement after another standalone comment (#5189)
- Fix a crash when splitting `case case if ...` match patterns at very small line
lengths (#5147)
- Fix multiline docstring indentation when leading tabs are used inside indented
docstrings (#5148)
- Respect `# fmt: skip` on a line that opens a bracket (e.g.
`from x import ( # fmt: skip`) when a standalone comment is among the bracket's
contents (#5161)
- Fix an AST safety error when separate `# type: ignore` comments in a parenthesized
attribute chain were merged onto one physical line (#5297)
- Preserve comments and blank lines outside requested ranges when formatting with
`--line-ranges` (#5175)
- Fix crash when `# fmt: skip` is used on one-line `async def`, `async with`, and
`async for` statements containing a semicolon (#5311)
- Stop converting form feeds or other similar characters in docstrings into newlines
(#5461)
- Fix `--skip-source-first-line` turning the skipped line's CRLF ending into `\r\r\n`
when reformatting a file with CRLF line endings (#5438)
### Preview style
#### New preview features
- Add missing blank lines after classes whose last method has an ellipsis body (#5439)
- Split only the brackets holding a magic trailing comma when more trailers follow them
(e.g. stop splitting inside the `[2]` of `[1,][2](3)`) (#5448)
- Keep dictionary keys containing operators together on one line when the value can be
wrapped onto a new line instead (#5435)
- Remove redundant parentheses around individual variables in unpacking targets (e.g.
`for (x), (y) in points:` becomes `for x, y in points:`) (#5416)
- Normalize uppercase `T` prefixes on t-strings to lowercase (#5425)
- Remove redundant parentheses around generator expressions (#5304, #5369)
- Preserve two blank lines before a top-level class starting inside a `# fmt: off` block
after an import (#5238)
- Fix unnecessary parentheses around short right-hand expressions in indexed assignments
(e.g. `x[key] = expr`) (#5095)
- Parenthesize tuple expressions in `yield` statements for consistency with function
calls and returns (#5170)
- Stop splitting between a variable and its operator (`not in`, `==`, `is`, ...) when
the right-hand side is a bracketed expression, and instead split inside the brackets
(#5135)
- In `.pyi` stub files, enforce a blank line after a function or method that has a
docstring-only body when another comment or statement follows it (#5158)
#### Updates to existing preview features
- Fix crash in stub files when `# fmt: skip` is placed on a function in a group of
same-name decorated functions (e.g. `@overload`s or a property setter) (#5430)
- Keep the parentheses around a lambda used as the iterable of a comprehension (e.g.
`[x for x in (lambda: 0) if x]`) (#5176, #5200)
#### Updates to existing unstable features
- Do not treat multi-line expressions with merged strings and trailing `# type: ignore`
comments as single-line unsplittable expressions (#5466)
- Fix duplicated inline comment when stripping the parentheses around a string or
merging a backslash-continued string on the same line (#5449)
- Split long stringified return annotations even when the function has parameters
(#5427)
- Don't hug brackets when doing so would join two `# type: ignore` comments onto one
line (#5271)
- Fix a crash when `# type: ignore` is lost during formatting of a long parenthesized
string (#5329)
- Fix only the first part of an implicitly concatenated unmergeable string (e.g.
`r"..." r"..."`) being wrapped in parentheses (#5434)
### Configuration
- Add support for `NO_COLOR` environment variable to disable ANSI output (#5129)
- Remove spurious target version warning when runtime version is included in a
`--target-version` flag (#5167)
- Fix `--force-exclude` not excluding files whose path contains `..` (e.g.
`black ../generated/file.py` run from a subdirectory) (#5471)
- Fall back to the default configuration, with a warning, when the given sources share
no common project root (e.g. they are on different drives on Windows) instead of
crashing (#5386)
- Fix loading a stale cached `pyproject.toml` path when `--code` is used from different
working directories in the same process (#5152)
- Add validation for `--line-ranges` values (#5107)
- Ignore empty cache files instead of raising an `EOFError` (#5192)
- Reject non-string `include` and `force-exclude` values in `pyproject.toml` (#5193)
- Validate `BLACK_NUM_WORKERS` values and report invalid values as usage errors instead
of crashing (#5211)
- Ignore permission errors when reading cache (#5258)
### Packaging
- Reduce the size of Linux standalone binaries by stripping debug symbols during the
PyInstaller release build (#5223)
- Black is now released using GitHub
[Immutable Releases](https://docs.github.com/code-security/concepts/supply-chain-security/immutable-releases)
(#5296)
### Performance
- Fix superlinear runtime growth with the number of input files (#5450)
- Improve performance on strings containing many consecutive backslashes (#5163)
- Improve performance on files with many `# fmt: skip`/`# fmt: off`/`# fmt: on` comments
(#5169, #5190, #5232)
- Improve performance on long calls and collections (#5177)
- Improve performance on multiline strings inside large collections (e.g. a dict literal
with triple-quoted strings as values) (#5188)
- Improve performance on files with many soft keywords (e.g. `match`/`case` blocks)
(#5186)
- Improve performance on long semicolon-separated statements (in the stable style) and
large dict literals (in `--preview`) (#5184)
- Improve performance of `--line-ranges` on files with many sibling blocks (a long
`if`/`elif` chain, a `match` with many cases, or many top-level definitions) (#5213)
- Improve performance on deeply nested bracketed expressions (#5171, #5242)
- Improve performance on lists and subscripts holding one long expression without
operators (e.g. a long run of implicitly concatenated strings inside `[]`) (#5239)
- Improve performance on deeply chained operations (e.g. a long `a ** b ** c ** ...`
chain) (#5235)
- Improve performance on long `if`/`elif` chains and other compound statements with many
clauses (#5322)
- Improve performance of `string_processing`:
- when merging implicitly concatenated f-strings containing long string literals
(#5165)
- when merging long implicitly concatenated strings (#5173, #5194)
- when rewriting large nodes (e.g. `"%s ..." % (a, b, c, ...)`) (#5178, #5199, #5220)
- when splitting long string literals (#5183)
### Output
- Report parser failures using editor-friendly `path:line:column` locations (#5237)
- Fix crash when writing formatted code or diffs to a `sys.stdout` that has no `buffer`
attribute (e.g. in Jupyter notebooks) (#5411)
- Report parse failures on Black's own output as internal errors (#5383)
### _Blackd_
- Return HTTP 400 instead of 500 when the `X-Python-Variant` header is empty or has an
empty entry (e.g. a trailing comma) (#5428)
- Allow optional whitespace around comma-separated versions and `pyi` in the
`X-Python-Variant` header (#5441)
### Integrations
- Remove unused `migrate-black` script (#5319)
- Support PEP 440 version specifiers in `tool.black.required-version` for the GitHub
Action (#5399)
- Add outputs (`is_formatted`, `change_count`, `same_count`, `failure_count`) to GitHub
Action runs (#5408)
### Documentation
- Document `vim-python-pep8-indent`, which provides an `indentexpr` for Black-style
insert-mode indentation (#5288)
## Version 26.5.1
### Stable style
- Fix unstable formatting of annotated assignments whose subscript annotation contains
an inline comment (e.g. `x: list[ # pyright: ignore[...]`) (#5130)
- Preserve inline comments (including `# type: ignore`) immediately before a
`# fmt: skip` line, avoiding AST equivalence failures (#5139)
### Packaging
- Correct the version in the published executables (#5137)
### Documentation
- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
(#5124)
## Version 26.5.0
### Highlights
- Add support for unpacking in comprehensions (PEP 798) and for lazy imports (PEP 810),
both new syntactic features in Python 3.15 (#5048)
- Python 3.15 is now supported. Compiled wheels are not yet provided for Python 3.15, so
performance may be slower than on existing Python versions. Wheels will be provided
once Python 3.15 is later in its release cycle. (#5127)
### Stable style
- Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in`
clauses (#4903)
- Add syntactic support for Python 3.15 (#5048)
- Fix crash when an f-string follows a `# fmt: off` comment inside brackets (#5097)
- Preserve multiline compound statement headers when `# fmt: skip` is placed on the
colon line (#5117)
### Preview style
- Improve heuristics around whether blank lines should appear before, within and after
groups of same-name decorated functions (such as `@overload` groups) in `.pyi` stub
files (#5021)
- Fix blank lines being removed between a function and a decorated class in `.pyi` stub
files (#5092)
- Prevent string merger from creating unsplittable long lines when a pragma comment
(e.g. `# type: ignore`) follows the closing bracket (#5096)
### Packaging
- Run CI on 3.15 (#5127)
### Output
- Improve parse error readability by showing multi-line output with an error pointer.
(#5068)
- Add `SourceASTParseError` to distinguish source parse failures from internal safety
errors, improving error reporting when Black's lenient parser accepts input that
`ast.parse()` rejects (#5080)
### _Blackd_
- Return HTTP 400 (Bad Request) for source parse failures instead of HTTP 500, keeping
HTTP 500 only for genuine internal safety errors (#5080)
### Integrations
- Added documentation for doctest formatting tools and updated the integrations index to
match (#4916)
### Documentation
- Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs
(#5063)
- Note in the editor integrations that the SublimeText `sublack` plugin is archived and
unmaintained (#5082)
## Version 26.3.1
### Stable style
- Prevent Jupyter notebook magic masking collisions from corrupting cells by using
exact-length placeholders for short magics and aborting if a placeholder can no longer
be unmasked safely (#5038)
### Configuration
- Always hash cache filename components derived from `--python-cell-magics` so custom
magic names cannot affect cache paths (#5038)
### _Blackd_
- Disable browser-originated requests by default, add configurable origin allowlisting
and request body limits, and bound executor submissions to improve backpressure
(#5039)
## Version 26.3.0
### Stable style
- Don't double-decode input, causing non-UTF-8 files to be corrupted (#4964)
- Fix crash on standalone comment in lambda default arguments (#4993)
- Preserve parentheses when `# type: ignore` comments would be merged with other
comments on the same line, preventing AST equivalence failures (#4888)
### Preview style
- Fix bug where `if` guards in `case` blocks were incorrectly split when the pattern had
a trailing comma (#4884)
- Fix `string_processing` crashing on unassigned long string literals with trailing
commas (one-item tuples) (#4929)
- Simplify implementation of the power operator "hugging" logic (#4918)
### Packaging
- Fix shutdown errors in PyInstaller builds on macOS by disabling multiprocessing in
frozen environments (#4930)
### Performance
- Introduce winloop for windows as an alternative to uvloop (#4996)
- Remove deprecated function `uvloop.install()` in favor of `uvloop.new_event_loop()`
(#4996)
- Rename `maybe_install_uvloop` function to `maybe_use_uvloop` to simplify loop
installation and creation of either a uvloop/winloop eventloop or default eventloop
(#4996)
### Output
- Emit a clear warning when the target Python version is newer than the running Python
version, since AST safety checks cannot parse newer syntax. Also replace the
misleading "INTERNAL ERROR" message with an actionable error explaining the version
mismatch (#4983)
### _Blackd_
- Introduce winloop to be used when windows in use which enables blackd to run faster on
windows when winloop is installed. (#4996)
### Integrations
- Remove unused gallery script (#5030)
- Harden parsing of `black` requirements in the GitHub Action when `use_pyproject` is
enabled so that only version specifiers are accepted and direct references such as
`black @ https://...` are rejected. Users should upgrade to the latest version of the
action as soon as possible. This update is received automatically when using
`psf/black@stable`, and is independent of the version of Black installed by the
action. (#5031)
### Documentation
- Expand preview style documentation with detailed examples for `wrap_comprehension_in`,
`simplify_power_operator_hugging`, and `wrap_long_dict_values_in_parens` features
(#4987)
- Add detailed documentation for formatting Jupyter Notebooks (#5009)
## Version 26.1.0
### Highlights
Introduces the 2026 stable style (#4892), stabilizing the following changes:
- `always_one_newline_after_import`: Always force one blank line after import
statements, except when the line after the import is a comment or an import statement
(#4489)
- `fix_fmt_skip_in_one_liners`: Fix `# fmt: skip` behavior on one-liner declarations,
such as `def foo(): return "mock" # fmt: skip`, where previously the declaration would
have been incorrectly collapsed (#4800)
- `fix_module_docstring_detection`: Fix module docstrings being treated as normal
strings if preceded by comments (#4764)
- `fix_type_expansion_split`: Fix type expansions split in generic functions (#4777)
- `multiline_string_handling`: Make expressions involving multiline strings more compact
(#1879)
- `normalize_cr_newlines`: Add `\r` style newlines to the potential newlines to
normalize file newlines both from and to (#4710)
- `remove_parens_around_except_types`: Remove parentheses around multiple exception
types in `except` and `except*` without `as` (#4720)
- `remove_parens_from_assignment_lhs`: Remove unnecessary parentheses from the left-hand
side of assignments while preserving magic trailing commas and intentional multiline
formatting (#4865)
- `standardize_type_comments`: Format type comments which have zero or more spaces
between `#` and `type:` or between `type:` and value to `# type: (value)` (#4645)
The following change was not in any previous stable release:
- Regenerated the `_width_table.py` and added tests for the Khmer language (#4253)
This release also bumps `pathspec` to v1 and fixes inconsistencies with Git's
`.gitignore` logic (#4958). Now, files will be ignored if a pattern matches them, even
if the parent directory is directly unignored. For example, Black would previously
format `exclude/not_this/foo.py` with this `.gitignore`:
```
exclude/
!exclude/not_this/
```
Now, `exclude/not_this/foo.py` will remain ignored. To ensure `exclude/not_this/` and
all of its children are included in formatting (and in Git), use this `.gitignore`:
```
*/exclude/*
!*/exclude/not_this/
```
This new behavior matches Git. The leading `*/` are only necessary if you wish to ignore
matching subdirectories (like the previous behavior did), and not just matching root
directories.
### Output
- Explicitly shutdown the multiprocessing manager when run in diff mode too (#4952)
### Integrations
- Upgraded PyPI upload workflow to use Trusted Publishing (#4611)
## Version 25.12.0
### Highlights
- Black no longer supports running with Python 3.9 (#4842)
### Stable style
- Fix bug where comments preceding `# fmt: off`/`# fmt: on` blocks were incorrectly
removed, particularly affecting Jupytext's `# %% [markdown]` comments (#4845)
- Fix crash when multiple `# fmt: skip` comments are used in a multi-part if-clause, on
string literals, or on dictionary entries with long lines (#4872)
- Fix possible crash when `fmt: ` directives aren't on the top level (#4856)
### Preview style
- Fix `fmt: skip` skipping the line after instead of the line it's on (#4855)
- Remove unnecessary parentheses from the left-hand side of assignments while preserving
magic trailing commas and intentional multiline formatting (#4865)
- Fix `fix_fmt_skip_in_one_liners` crashing on `with` statements (#4853)
- Fix `fix_fmt_skip_in_one_liners` crashing on annotated parameters (#4854)
- Fix new lines being added after imports with `# fmt: skip` on them (#4894)
### Packaging
- Releases now include arm64 Windows binaries and wheels (#4814)
### Integrations
- Add `output-file` input to GitHub Action `psf/black` to write formatter output to a
file for artifact capture and log cleanliness (#4824)
## Version 25.11.0
### Highlights
- Enable base 3.14 support (#4804)
- Add support for the new Python 3.14 t-string syntax introduced by PEP 750 (#4805)
### Stable style
- Fix bug where comments between `# fmt: off` and `# fmt: on` were reformatted (#4811)
- Comments containing fmt directives now preserve their exact formatting instead of
being normalized (#4811)
### Preview style
- Move `multiline_string_handling` from `--unstable` to `--preview` (#4760)
- Fix bug where module docstrings would be treated as normal strings if preceded by
comments (#4764)
- Fix bug where python 3.12 generics syntax split line happens weirdly (#4777)
- Standardize type comments to form `# type: ` (#4645)
- Fix `fix_fmt_skip_in_one_liners` preview feature to respect `# fmt: skip` for compound
statements with semicolon-separated bodies (#4800)
### Configuration
- Add `no_cache` option to control caching behavior. (#4803)
### Packaging
- Releases now include arm64 Linux binaries (#4773)
### Output
- Write unchanged content to stdout when excluding formatting from stdin using pipes
(#4610)
### _Blackd_
- Implemented BlackDClient. This simple python client allows to easily send formatting
requests to blackd (#4774)
### Integrations
- Enable 3.14 base CI (#4804)
- Enhance GitHub Action `psf/black` to support the `required-version` major-version-only
"stability" format when using pyproject.toml (#4770)
- Improve error message for vim plugin users. It now handles independently vim version
- Vim: Warn on unsupported Vim and Python versions independently (#4772)
- Vim: Print the import paths when importing black fails (#4675)
- Vim: Fix handling of virtualenvs that have a different Python version (#4675)
## Version 25.9.0
### Highlights
- Remove support for pre-python 3.7 `await/async` as soft keywords/variable names
(#4676)
### Stable style
- Fix crash while formatting a long `del` statement containing tuples (#4628)
- Fix crash while formatting expressions using the walrus operator in complex `with`
statements (#4630)
- Handle `# fmt: skip` followed by a comment at the end of file (#4635)
- Fix crash when a tuple appears in the `as` clause of a `with` statement (#4634)
- Fix crash when tuple is used as a context manager inside a `with` statement (#4646)
- Fix crash when formatting a `\` followed by a `\r` followed by a comment (#4663)
- Fix crash on a `\\r\n` (#4673)
- Fix crash on `await ...` (where `...` is a literal `Ellipsis`) (#4676)
- Fix crash on parenthesized expression inside a type parameter bound (#4684)
- Fix crash when using line ranges excluding indented single line decorated items
(#4670)
### Preview style
- Fix a bug where one-liner functions/conditionals marked with `# fmt: skip` would still
be formatted (#4552)
- Improve `multiline_string_handling` with ternaries and dictionaries (#4657)
- Fix a bug where `string_processing` would not split f-strings directly after
expressions (#4680)
- Wrap the `in` clause of comprehensions across lines if necessary (#4699)
- Remove parentheses around multiple exception types in `except` and `except*` without
`as`. (#4720)
- Add `\r` style newlines to the potential newlines to normalize file newlines both from
and to (#4710)
### Parser
- Rewrite tokenizer to improve performance and compliance (#4536)
- Fix bug where certain unusual expressions (e.g., lambdas) were not accepted in type
parameter bounds and defaults. (#4602)
### Performance
- Avoid using an extra process when running with only one worker (#4734)
### Integrations
- Fix the version check in the vim file to reject Python 3.8 (#4567)
- Enhance GitHub Action `psf/black` to read Black version from an additional section in
pyproject.toml: `[project.dependency-groups]` (#4606)
- Build gallery docker image with python3-slim and reduce image size (#4686)
### Documentation
- Add FAQ entry for windows emoji not displaying (#4714)
## Version 25.1.0
### Highlights
This release introduces the new 2025 stable style (#4558), stabilizing the following
changes:
- Normalize casing of Unicode escape characters in strings to lowercase (#2916)
- Fix inconsistencies in whether certain strings are detected as docstrings (#4095)
- Consistently add trailing commas to typed function parameters (#4164)
- Remove redundant parentheses in if guards for case blocks (#4214)
- Add parentheses to if clauses in case blocks when the line is too long (#4269)
- Whitespace before `# fmt: skip` comments is no longer normalized (#4146)
- Fix line length computation for certain expressions that involve the power operator
(#4154)
- Check if there is a newline before the terminating quotes of a docstring (#4185)
- Fix type annotation spacing between `*` and more complex type variable tuple (#4440)
The following changes were not in any previous release:
- Remove parentheses around sole list items (#4312)
- Generic function definitions are now formatted more elegantly: parameters are split
over multiple lines first instead of type parameter definitions (#4553)
### Stable style
- Fix formatting cells in IPython notebooks with magic methods and starting or trailing
empty lines (#4484)
- Fix crash when formatting `with` statements containing tuple generators/unpacking
(#4538)
### Preview style
- Fix/remove string merging changing f-string quotes on f-strings with internal quotes
(#4498)
- Collapse multiple empty lines after an import into one (#4489)
- Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing
parentheses around long dictionary values (#4377)
- Move `wrap_long_dict_values_in_parens` from the unstable to preview style (#4561)
### Packaging
- Store license identifier inside the `License-Expression` metadata field, see
[PEP 639](https://peps.python.org/pep-0639/). (#4479)
### Performance
- Speed up the `is_fstring_start` function in Black's tokenizer (#4541)
### Integrations
- If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be
formatted. (#4539)
## Version 24.10.0
### Highlights
- Black is now officially tested with Python 3.13 and provides Python 3.13
mypyc-compiled wheels. (#4436) (#4449)
- Black will issue an error when used with Python 3.12.5, due to an upstream memory
safety issue in Python 3.12.5 that can cause Black's AST safety checks to fail. Please
use Python 3.12.6 or Python 3.12.4 instead. (#4447)
- Black no longer supports running with Python 3.8 (#4452)
### Stable style
- Fix crashes involving comments in parenthesised return types or `X | Y` style unions.
(#4453)
- Fix skipping Jupyter cells with unknown `%%` magic (#4462)
### Preview style
- Fix type annotation spacing between * and more complex type variable tuple (i.e.
`def fn(*args: *tuple[*Ts, T]) -> None: pass`) (#4440)
### Caching
- Fix bug where the cache was shared between runs with and without `--unstable` (#4466)
### Packaging
- Upgrade version of mypyc used to 1.12 beta (#4450) (#4449)
- `blackd` now requires a newer version of aiohttp. (#4451)
### Output
- Added Python target version information on parse error (#4378)
- Add information about Black version to internal error messages (#4457)
## Version 24.8.0
### Stable style
- Fix crash when `# fmt: off` is used before a closing parenthesis or bracket. (#4363)
### Packaging
- Packaging metadata updated: docs are explicitly linked, the issue tracker is now also
linked. This improves the PyPI listing for Black. (#4345)
### Parser
- Fix regression where Black failed to parse a multiline f-string containing another
multiline string (#4339)
- Fix regression where Black failed to parse an escaped single quote inside an f-string
(#4401)
- Fix bug with Black incorrectly parsing empty lines with a backslash (#4343)
- Fix bugs with Black's tokenizer not handling `\{` inside f-strings very well (#4422)
- Fix incorrect line numbers in the tokenizer for certain tokens within f-strings
(#4423)
### Performance
- Improve performance when a large directory is listed in `.gitignore` (#4415)
### _Blackd_
- Fix blackd (and all extras installs) for docker container (#4357)
## Version 24.4.2
This is a bugfix release to fix two regressions in the new f-string parser introduced in
24.4.1.
### Parser
- Fix regression where certain complex f-strings failed to parse (#4332)
### Performance
- Fix bad performance on certain complex string literals (#4331)
## Version 24.4.1
### Highlights
- Add support for the new Python 3.12 f-string syntax introduced by PEP 701 (#3822)
### Stable style
- Fix crash involving indented dummy functions containing newlines (#4318)
### Parser
- Add support for type parameter defaults, a new syntactic feature added to Python 3.13
by PEP 696 (#4327)
### Integrations
- Github Action now works even when `git archive` is skipped (#4313)
## Version 24.4.0
### Stable style
- Fix unwanted crashes caused by AST equivalency check (#4290)
### Preview style
- `if` guards in `case` blocks are now wrapped in parentheses when the line is too long.
(#4269)
- Stop moving multiline strings to a new line unless inside brackets (#4289)
### Integrations
- Add a new option `use_pyproject` to the GitHub Action `psf/black`. This will read the
Black version from `pyproject.toml`. (#4294)
## Version 24.3.0
### Highlights
This release is a milestone: it fixes Black's first CVE security vulnerability. If you
run Black on untrusted input, or if you habitually put thousands of leading tab
characters in your docstrings, you are strongly encouraged to upgrade immediately to fix
[CVE-2024-21503](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2024-21503).
This release also fixes a bug in Black's AST safety check that allowed Black to make
incorrect changes to certain f-strings that are valid in Python 3.12 and higher.
### Stable style
- Don't move comments along with delimiters, which could cause crashes (#4248)
- Strengthen AST safety check to catch more unsafe changes to strings. Previous versions
of Black would incorrectly format the contents of certain unusual f-strings containing
nested strings with the same quote type. Now, Black will crash on such strings until
support for the new f-string syntax is implemented. (#4270)
- Fix a bug where line-ranges exceeding the last code line would not work as expected
(#4273)
### Performance
- Fix catastrophic performance on docstrings that contain large numbers of leading tab
characters. This fixes
[CVE-2024-21503](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2024-21503).
(#4278)
### Documentation
- Note what happens when `--check` is used with `--quiet` (#4236)
## Version 24.2.0
### Stable style
- Fixed a bug where comments where mistakenly removed along with redundant parentheses
(#4218)
### Preview style
- Move the `hug_parens_with_braces_and_square_brackets` feature to the unstable style
due to an outstanding crash and proposed formatting tweaks (#4198)
- Fixed a bug where base expressions caused inconsistent formatting of \*\* in ternary
expression (#4154)
- Checking for newline before adding one on docstring that is almost at the line limit
(#4185)
- Remove redundant parentheses in `case` statement `if` guards (#4214).
### Configuration
- Fix issue where _Black_ would ignore input files in the presence of symlinks (#4222)
- _Black_ now ignores `pyproject.toml` that is missing a `tool.black` section when
discovering project root and configuration. Since _Black_ continues to use version
control as an indicator of project root, this is expected to primarily change behavior
for users in a monorepo setup (desirably). If you wish to preserve previous behavior,
simply add an empty `[tool.black]` to the previously discovered `pyproject.toml`
(#4204)
### Output
- Black will swallow any `SyntaxWarning`s or `DeprecationWarning`s produced by the `ast`
module when performing equivalence checks (#4189)
### Integrations
- Add a JSONSchema and provide a validate-pyproject entry-point (#4181)
## Version 24.1.1
Bugfix release to fix a bug that made Black unusable on certain file systems with strict
limits on path length.
### Preview style
- Consistently add trailing comma on typed parameters (#4164)
### Configuration
- Shorten the length of the name of the cache file to fix crashes on file systems that
do not support long paths (#4176)
## Version 24.1.0
### Highlights
This release introduces the new 2024 stable style (#4106), stabilizing the following
changes:
- Add parentheses around `if`-`else` expressions (#2278)
- Dummy class and function implementations consisting only of `...` are formatted more
compactly (#3796)
- If an assignment statement is too long, we now prefer splitting on the right-hand side
(#3368)
- Hex codes in Unicode escape sequences are now standardized to lowercase (#2916)
- Allow empty first lines at the beginning of most blocks (#3967, #4061)
- Add parentheses around long type annotations (#3899)
- Enforce newline after module docstrings (#3932, #4028)
- Fix incorrect magic trailing comma handling in return types (#3916)
- Remove blank lines before class docstrings (#3692)
- Wrap multiple context managers in parentheses if combined in a single `with` statement
(#3489)
- Fix bug in line length calculations for power operations (#3942)
- Add trailing commas to collection literals even if there's a comment after the last
entry (#3393)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
subscript expressions with more than 1 element (#3209)
- Add extra blank lines in stubs in a few cases (#3564, #3862)
- Accept raw strings as docstrings (#3947)
- Split long lines in case blocks (#4024)
- Stop removing spaces from walrus operators within subscripts (#3823)
- Fix incorrect formatting of certain async statements (#3609)
- Allow combining `# fmt: skip` with other comments (#3959)
There are already a few improvements in the `--preview` style, which are slated for the
2025 stable style. Try them out and
[share your feedback](https://github.com/psf/black/issues). In the past, the preview
style has included some features that we were not able to stabilize. This year, we're
adding a separate `--unstable` style for features with known problems. Now, the
`--preview` style only includes features that we actually expect to make it into next
year's stable style.
### Stable style
Several bug fixes were made in features that are moved to the stable style in this
release:
- Fix comment handling when parenthesising conditional expressions (#4134)
- Fix bug where spaces were not added around parenthesized walruses in subscripts,
unlike other binary operators (#4109)
- Remove empty lines before docstrings in async functions (#4132)
- Address a missing case in the change to allow empty lines at the beginning of all
blocks, except immediately before a docstring (#4130)
- For stubs, fix logic to enforce empty line after nested classes with bodies (#4141)
### Preview style
- Add `--unstable` style, covering preview features that have known problems that would
block them from going into the stable style. Also add the `--enable-unstable-feature`
flag; for example, use
`--enable-unstable-feature hug_parens_with_braces_and_square_brackets` to apply this
preview feature throughout 2024, even if a later Black release downgrades the feature
to unstable (#4096)
- Format module docstrings the same as class and function docstrings (#4095)
- Fix crash when using a walrus in a dictionary (#4155)
- Fix unnecessary parentheses when wrapping long dicts (#4135)
- Stop normalizing spaces before `# fmt: skip` comments (#4146)
### Configuration
- Print warning when configuration in `pyproject.toml` contains an invalid key (#4165)
- Fix symlink handling, properly ignoring symlinks that point outside of root (#4161)
- Fix cache mtime logic that resulted in false positive cache hits (#4128)
- Remove the long-deprecated `--experimental-string-processing` flag. This feature can
currently be enabled with `--preview --enable-unstable-feature string_processing`.
(#4096)
### Integrations
- Revert the change to run Black's pre-commit integration only on specific git hooks
(#3940) for better compatibility with older versions of pre-commit (#4137)
## Version 23.12.1
### Packaging
- Fixed a bug that included dependencies from the `d` extra by default (#4108)
## Version 23.12.0
### Highlights
It's almost 2024, which means it's time for a new edition of _Black_'s stable style!
Together with this release, we'll put out an alpha release 24.1a1 showcasing the draft
2024 stable style, which we'll finalize in the January release. Please try it out and
[share your feedback](https://github.com/psf/black/issues/4042).
This release (23.12.0) will still produce the 2023 style. Most but not all of the
changes in `--preview` mode will be in the 2024 stable style.
### Stable style
- Fix bug where `# fmt: off` automatically dedents when used with the `--line-ranges`
option, even when it is not within the specified line range. (#4084)
- Fix feature detection for parenthesized context managers (#4104)
### Preview style
- Prefer more equal signs before a break when splitting chained assignments (#4010)
- Standalone form feed characters at the module level are no longer removed (#4021)
- Additional cases of immediately nested tuples, lists, and dictionaries are now
indented less (#4012)
- Allow empty lines at the beginning of all blocks, except immediately before a
docstring (#4060)
- Fix crash in preview mode when using a short `--line-length` (#4086)
- Keep suites consisting of only an ellipsis on their own lines if they are not
functions or class definitions (#4066) (#4103)
### Configuration
- `--line-ranges` now skips _Black_'s internal stability check in `--safe` mode. This
avoids a crash on rare inputs that have many unformatted same-content lines. (#4034)
### Packaging
- Upgrade to mypy 1.7.1 (#4049) (#4069)
- Faster compiled wheels are now available for CPython 3.12 (#4070)
### Integrations
- Enable 3.12 CI (#4035)
- Build docker images in parallel (#4054)
- Build docker images with 3.12 (#4055)
## Version 23.11.0
### Highlights
- Support formatting ranges of lines with the new `--line-ranges` command-line option
(#4020)
### Stable style
- Fix crash on formatting bytes strings that look like docstrings (#4003)
- Fix crash when whitespace followed a backslash before newline in a docstring (#4008)
- Fix standalone comments inside complex blocks crashing Black (#4016)
- Fix crash on formatting code like `await (a ** b)` (#3994)
- No longer treat leading f-strings as docstrings. This matches Python's behaviour and
fixes a crash (#4019)
### Preview style
- Multiline dicts and lists that are the sole argument to a function are now indented
less (#3964)
- Multiline unpacked dicts and lists as the sole argument to a function are now also
indented less (#3992)
- In f-string debug expressions, quote types that are visible in the final string are
now preserved (#4005)
- Fix a bug where long `case` blocks were not split into multiple lines. Also enable
general trailing comma rules on `case` blocks (#4024)
- Keep requiring two empty lines between module-level docstring and first function or
class definition (#4028)
- Add support for single-line format skip with other comments on the same line (#3959)
### Configuration
- Consistently apply force exclusion logic before resolving symlinks (#4015)
- Fix a bug in the matching of absolute path names in `--include` (#3976)
### Performance
- Fix mypyc builds on arm64 on macOS (#4017)
### Integrations
- Black's pre-commit integration will now run only on git hooks appropriate for a code
formatter (#3940)
## Version 23.10.1
### Highlights
- Maintenance release to get a fix out for GitHub Action edge case (#3957)
### Preview style
- Fix merging implicit multiline strings that have inline comments (#3956)
- Allow empty first line after block open before a comment or compound statement (#3967)
### Packaging
- Change Dockerfile to hatch + compile black (#3965)
### Integrations
- The summary output for GitHub workflows is now suppressible using the `summary`
parameter. (#3958)
- Fix the action failing when Black check doesn't pass (#3957)
### Documentation
- It is known Windows documentation CI is broken
https://github.com/psf/black/issues/3968
## Version 23.10.0
### Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
### Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across
multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
### Configuration
- Fix cache versioning logic when `BLACK_CACHE_DIR` is set (#3937)
### Parser
- Fix bug where attributes named `type` were not accepted inside `match` statements
(#3950)
- Add support for PEP 695 type aliases containing lambdas and other unusual expressions
(#3949)
### Output
- Black no longer attempts to provide special errors for attempting to format Python 2
code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode
(#3938)
### Integrations
- The action output displayed in the job summary is now wrapped in Markdown (#3914)
## Version 23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc
wheels, which make Black significantly faster. These issues have now been fixed, and
this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12
wheels in a future release as soon as the mypyc bug is fixed.
### Packaging
- Upgrade to mypy 1.5.1 (#3864)
### Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and
decreasing the size of the cache (#3877)
## Version 23.9.0
### Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
`if sys.version_info > (3, x):`) and a function definition on the same level (#3862)
- Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
### Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
### Performance
- Avoid importing `IPython` if notebook cells do not contain magics (#3782)
- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
### _Blackd_
- Fix an issue in `blackd` with single character input (#3558)
### Integrations
- Black now has an
[official pre-commit mirror](https://github.com/psf/black-pre-commit-mirror). Swapping
`https://github.com/psf/black` to `https://github.com/psf/black-pre-commit-mirror` in
your `.pre-commit-config.yaml` will make Black about 2x faster (#3828)
- The `.black.env` folder specified by `ENV_PATH` will now be removed on the completion
of the GitHub Action (#3759)
## Version 23.7.0
### Highlights
- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
supported until further notice (#3765)
### Stable style
- Fix a bug where an illegal trailing comma was added to return type annotations using
PEP 604 unions (#3735)
- Fix several bugs and crashes where comments in stub files were removed or mishandled
under some circumstances (#3745)
- Fix a crash with multi-line magic comments like `type: ignore` within parentheses
(#3740)
- Fix error in AST validation when _Black_ removes trailing whitespace in a type comment
(#3773)
### Preview style
- Implicitly concatenated strings used as function args are no longer wrapped inside
parentheses (#3640)
- Remove blank lines between a class definition and its docstring (#3692)
### Configuration
- The `--workers` argument to _Black_ can now be specified via the `BLACK_NUM_WORKERS`
environment variable (#3743)
- `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (#3691)
- Fix _Black_ not honouring `pyproject.toml` settings when running `--stdin-filename`
and the `pyproject.toml` found isn't in the current working directory (#3719)
- _Black_ will now error if `exclude` and `extend-exclude` have invalid data types in
`pyproject.toml`, instead of silently doing the wrong thing (#3764)
### Packaging
- Upgrade mypyc from 0.991 to 1.3 (#3697)
- Remove patching of Click that mitigated errors on Python 3.6 with `LANG=C` (#3768)
### Parser
- Add support for the new PEP 695 syntax in Python 3.12 (#3703)
### Performance
- Speed up _Black_ significantly when the cache is full (#3751)
- Avoid importing `IPython` in a case where we wouldn't need it (#3748)
### Output
- Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728)
- Change verbose logging to exactly mirror _Black_'s logic for source discovery (#3749)
### _Blackd_
- The `blackd` argument parser now shows the default values for options in their help
text (#3712)
### Integrations
- Black is now tested with
[`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning)
(#3763)
- Update GitHub Action to display black output in the job summary (#3688)
### Documentation
- Add a CITATION.cff file to the root of the repository, containing metadata on how to
cite this software (#3723)
- Update the _classes_ and _exceptions_ documentation in Developer reference to match
the latest code base (#3755)
## Version 23.3.0
### Highlights
This release fixes a longstanding confusing behavior in Black's GitHub action, where the
version of the action did not determine the version of Black being run (issue #3382). In
addition, there is a small bug fix around imports and a number of improvements to the
preview style.
Please try out the
[preview style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html#preview-style)
with `black --preview` and tell us your feedback. All changes in the preview style are
expected to become part of Black's stable style in January 2024.
### Stable style
- Import lines with `# fmt: skip` and `# fmt: off` no longer have an extra blank line
added when they are right after another import line (#3610)
### Preview style
- Add trailing commas to collection literals even if there's a comment after the last
entry (#3393)
- `async def`, `async for`, and `async with` statements are now formatted consistently
compared to their non-async version. (#3609)
- `with` statements that contain two context managers will be consistently wrapped in
parentheses (#3589)
- Let string splitters respect [East Asian Width](https://www.unicode.org/reports/tr11/)
(#3445)
- Now long string literals can be split after East Asian commas and periods (`�` U+3001
IDEOGRAPHIC COMMA, `。` U+3002 IDEOGRAPHIC FULL STOP, & `,` U+FF0C FULLWIDTH COMMA)
besides before spaces (#3445)
- For stubs, enforce one blank line after a nested class with a body other than just
`...` (#3564)
- Improve handling of multiline strings by changing line split behavior (#1879)
### Parser
- Added support for formatting files with invalid type comments (#3594)
### Integrations
- Update GitHub Action to use the version of Black equivalent to action's version if
version input is not specified (#3543)
- Fix missing Python binary path in autoload script for vim (#3508)
### Documentation
- Document that only the most recent release is supported for security issues;
vulnerabilities should be reported through Tidelift (#3612)
## Version 23.1.0
### Highlights
This is the first release of 2023, and following our
[stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy),
it comes with a number of improvements to our stable style, including improvements to
empty line handling, removal of redundant parentheses in several contexts, and output
that highlights implicitly concatenated strings better.
There are also many changes to the preview style; try out `black --preview` and give us
feedback to help us set the stable style for next year.
In addition to style changes, Black now automatically infers the supported Python
versions from your `pyproject.toml` file, removing the need to set Black's target
versions separately.
### Stable style
- Introduce the 2023 stable style, which incorporates most aspects of last year's
preview style (#3418). Specific changes:
- Enforce empty lines before classes and functions with sticky leading comments
(#3302) (22.12.0)
- Reformat empty and whitespace-only files as either an empty file (if no newline is
present) or as a single newline character (if a newline is present) (#3348)
(22.12.0)
- Implicitly concatenated strings used as function args are now wrapped inside
parentheses (#3307) (22.12.0)
- Correctly handle trailing commas that are inside a line's leading non-nested parens
(#3370) (22.12.0)
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
normalized as expected (#3168) (since 22.8.0)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
subscript expressions with more than 1 element (#3209) (22.8.0)
- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
parentheses (#3162) (22.8.0)
- Fix a string merging/split issue when a comment is present in the middle of
implicitly concatenated strings on its own line (#3227) (22.8.0)
- Docstring quotes are no longer moved if it would violate the line length limit
(#3044, #3430) (22.6.0)
- Parentheses around return annotations are now managed (#2990) (22.6.0)
- Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
- Remove unnecessary parentheses in `with` statements (#2926) (22.6.0)
- Remove trailing newlines after code block open (#3035) (22.6.0)
- Code cell separators `#%%` are now standardised to `# %%` (#2919) (22.3.0)
- Remove unnecessary parentheses from `except` statements (#2939) (22.3.0)
- Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945) (22.3.0)
- Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
- Fix a crash when a colon line is marked between `# fmt: off` and `# fmt: on` (#3439)
### Preview style
- Format hex codes in unicode escape sequences in string literals (#2916)
- Add parentheses around `if`-`else` expressions (#2278)
- Improve performance on large expressions that contain many strings (#3467)
- Fix a crash in preview style with assert + parenthesized string (#3415)
- Fix crashes in preview style with walrus operators used in function return annotations
and except clauses (#3423)
- Fix a crash in preview advanced string processing where mixed implicitly concatenated
regular and f-strings start with an empty span (#3463)
- Fix a crash in preview advanced string processing where a standalone comment is placed
before a dict's value (#3469)
- Fix an issue where extra empty lines are added when a decorator has `# fmt: skip`
applied or there is a standalone comment between decorators (#3470)
- Do not put the closing quotes in a docstring on a separate line, even if the line is
too long (#3430)
- Long values in dict literals are now wrapped in parentheses; correspondingly
unnecessary parentheses around short values in dict literals are now removed; long
string lambda values are now wrapped in parentheses (#3440)
- Fix two crashes in preview style involving edge cases with docstrings (#3451)
- Exclude string type annotations from improved string processing; fix crash when the
return type annotation is stringified and spans across multiple lines (#3462)
- Wrap multiple context managers in parentheses when targeting Python 3.9+ (#3489)
- Fix several crashes in preview style with walrus operators used in `with` statements
or tuples (#3473)
- Fix an invalid quote escaping bug in f-string expressions where it produced invalid
code. Implicitly concatenated f-strings with different quotes can now be merged or
quote-normalized by changing the quotes used in expressions. (#3509)
- Fix crash on `await (yield)` when Black is compiled with mypyc (#3533)
### Configuration
- Black now tries to infer its `--target-version` from the project metadata specified in
`pyproject.toml` (#3219)
### Packaging
- Upgrade mypyc from `0.971` to `0.991` so mypycified _Black_ can be built on armv7
(#3380)
- This also fixes some crashes while using compiled Black with a debug build of
CPython
- Drop specific support for the `tomli` requirement on 3.11 alpha releases, working
around a bug that would cause the requirement not to be installed on any non-final
Python releases (#3448)
- Black now depends on `packaging` version `22.0` or later. This is required for new
functionality that needs to parse part of the project metadata (#3219)
### Output
- Calling `black --help` multiple times will return the same help contents each time
(#3516)
- Verbose logging now shows the values of `pyproject.toml` configuration variables
(#3392)
- Fix false symlink detection messages in verbose output due to using an incorrect
relative path to the project root (#3385)
### Integrations
- Move 3.11 CI to normal flow now that all dependencies support 3.11 (#3446)
- Docker: Add new `latest_prerelease` tag automation to follow latest black alpha
release on docker images (#3465)
### Documentation
- Expand `vim-plug` installation instructions to offer more explicit options (#3468)
## Version 22.12.0
### Preview style
- Enforce empty lines before classes and functions with sticky leading comments (#3302)
- Reformat empty and whitespace-only files as either an empty file (if no newline is
present) or as a single newline character (if a newline is present) (#3348)
- Implicitly concatenated strings used as function args are now wrapped inside
parentheses (#3307)
- For assignment statements, prefer splitting the right hand side if the left hand side
fits on a single line (#3368)
- Correctly handle trailing commas that are inside a line's leading non-nested parens
(#3370)
### Configuration
- Fix incorrectly applied `.gitignore` rules by considering the `.gitignore` location
and the relative path to the target file (#3338)
- Fix incorrectly ignoring `.gitignore` presence when more than one source directory is
specified (#3336)
### Parser
- Parsing support has been added for walruses inside generator expression that are
passed as function args (for example,
`any(match := my_re.match(text) for text in texts)`) (#3327).
### Integrations
- Vim plugin: Optionally allow using the system installation of Black via
`let g:black_use_virtualenv = 0`(#3309)
## Version 22.10.0
### Highlights
- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
supported until further notice.
### Stable style
- Fix a crash when `# fmt: on` is used on a different block level than `# fmt: off`
(#3281)
### Preview style
- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
(#3262)
### Configuration
- `.ipynb_checkpoints` directories are now excluded by default (#3293)
- Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
while formatting (#3299)
### Packaging
- Executables made with PyInstaller will no longer crash when formatting several files
at once on macOS. Native x86-64 executables for macOS are available once again.
(#3275)
- Hatchling is now used as the build backend. This will not have any effect for users
who install Black with its wheels from PyPI. (#3233)
- Faster compiled wheels are now available for CPython 3.11 (#3276)
### _Blackd_
- Windows style (CRLF) newlines will be preserved (#3257).
### Integrations
- Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (#3246)
- Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
option (#3282)
- Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
version (#3265)
## Version 22.8.0
### Highlights
- Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as
of publishing (#3234)
- This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6
code will continue to be supported until further notice)
- Reword the stability policy to say that we may, in rare cases, make changes that
affect code that was not previously formatted by _Black_ (#3155)
### Stable style
- Fix an infinite loop when using `# fmt: on/off` in the middle of an expression or code
block (#3158)
- Fix incorrect handling of `# fmt: skip` on colon (`:`) lines (#3148)
- Comments are no longer deleted when a line had spaces removed around power operators
(#2874)
### Preview style
- Single-character closing docstring quotes are no longer moved to their own line as
this is invalid. This was a bug introduced in version 22.6.0. (#3166)
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
normalized as expected (#3168)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
subscript expressions with more than 1 element (#3209)
- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
parentheses (#3162)
- Fix a string merging/split issue when a comment is present in the middle of implicitly
concatenated strings on its own line (#3227)
### _Blackd_
- `blackd` now supports enabling the preview style via the `X-Preview` header (#3217)
### Configuration
- Black now uses the presence of debug f-strings to detect target version (#3215)
- Fix misdetection of project root and verbose logging of sources in cases involving
`--stdin-filename` (#3216)
- Immediate `.gitignore` files in source directories given on the command line are now
also respected, previously only `.gitignore` files in the project root and
automatically discovered directories were respected (#3237)
### Documentation
- Recommend using BlackConnect in IntelliJ IDEs (#3150)
### Integrations
- Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
- Docker: changed to a /opt/venv installation + added to PATH to be available to
non-root users (#3202)
### Output
- Change from deprecated `asyncio.get_event_loop()` to create our event loop which
removes DeprecationWarning (#3164)
- Remove logging from internal `blib2to3` library since it regularly emits error logs
about failed caching that can and should be ignored (#3193)
### Parser
- Type comments are now included in the AST equivalence check consistently so accidental
deletion raises an error. Though type comments can't be tracked when running on PyPy
3.7 due to standard library limitations. (#2874)
### Performance
- Reduce Black's startup time when formatting a single file by 15-30% (#3211)
## Version 22.6.0
### Style
- Fix unstable formatting involving `#fmt: skip` and `# fmt:skip` comments (notice the
lack of spaces) (#2970)
### Preview style
- Docstring quotes are no longer moved if it would violate the line length limit (#3044)
- Parentheses around return annotations are now managed (#2990)
- Remove unnecessary parentheses around awaited objects (#2991)
- Remove unnecessary parentheses in `with` statements (#2926)
- Remove trailing newlines after code block open (#3035)
### Integrations
- Add `scripts/migrate-black.py` script to ease introduction of Black to a Git project
(#3038)
### Output
- Output Python version and implementation as part of `--version` flag (#2997)
### Packaging
- Use `tomli` instead of `tomllib` on Python 3.11 builds where `tomllib` is not
available (#2987)
### Parser
- [PEP 654](https://peps.python.org/pep-0654/#except) syntax (for example,
`except *ExceptionGroup:`) is now supported (#3016)
- [PEP 646](https://peps.python.org/pep-0646) syntax (for example,
`Array[Batch, *Shape]` or `def fn(*args: *T) -> None`) is now supported (#3071)
### Vim Plugin
- Fix `strtobool` function. It didn't parse true/on/false/off. (#3025)
## Version 22.3.0
### Preview style
- Code cell separators `#%%` are now standardised to `# %%` (#2919)
- Remove unnecessary parentheses from `except` statements (#2939)
- Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945)
- Avoid magic-trailing-comma in single-element subscripts (#2942)
### Configuration
- Do not format `__pypackages__` directories by default (#2836)
- Add support for specifying stable version with `--required-version` (#2832).
- Avoid crashing when the user has no homedir (#2814)
- Avoid crashing when md5 is not available (#2905)
- Fix handling of directory junctions on Windows (#2904)
### Documentation
- Update pylint config documentation (#2931)
### Integrations
- Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
### Output
- In verbose mode, log when _Black_ is using user-level config (#2861)
### Packaging
- Fix Black to work with Click 8.1.0 (#2966)
- On Python 3.11 and newer, use the standard library's `tomllib` instead of `tomli`
(#2903)
- `black-primer`, the deprecated internal devtool, has been removed and copied to a
[separate repository](https://github.com/cooperlees/black-primer) (#2924)
### Parser
- Black can now parse starred expressions in the target of `for` and `async for`
statements, e.g `for item in *items_1, *items_2: pass` (#2879).
## Version 22.1.0
At long last, _Black_ is no longer a beta product! This is the first non-beta release
and the first release covered by our new
[stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy).
### Highlights
- **Remove Python 2 support** (#2740)
- Introduce the `--preview` flag (#2752)
### Style
- Deprecate `--experimental-string-processing` and move the functionality under
`--preview` (#2789)
- For stubs, one blank line between class attributes and methods is now kept if there's
at least one pre-existing blank line (#2736)
- Black now normalizes string prefix order (#2297)
- Remove spaces around power operators if both operands are simple (#2726)
- Work around bug that causes unstable formatting in some cases in the presence of the
magic trailing comma (#2807)
- Use parentheses for attribute access on decimal float and int literals (#2799)
- Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex
literals (#2799)
- Treat blank lines in stubs the same inside top-level `if` statements (#2820)
- Fix unstable formatting with semicolons and arithmetic expressions (#2817)
- Fix unstable formatting around magic trailing comma (#2572)
### Parser
- Fix mapping cases that contain as-expressions, like `case {"key": 1 | 2 as password}`
(#2686)
- Fix cases that contain multiple top-level as-expressions, like `case 1 as a, 2 as b`
(#2716)
- Fix call patterns that contain as-expressions with keyword arguments, like
`case Foo(bar=baz as quux)` (#2749)
- Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (#2700)
- Unparenthesized tuples on annotated assignments (e.g
`values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (#2708)
- Fix handling of standalone `match()` or `case()` when there is a trailing newline or a
comment inside of the parentheses. (#2760)
- `from __future__ import annotations` statement now implies Python 3.7+ (#2690)
### Performance
- Speed-up the new backtracking parser about 4X in general (enabled when
`--target-version` is set to 3.10 and higher). (#2728)
- _Black_ is now compiled with [mypyc](https://github.com/mypyc/mypyc) for an overall 2x
speed-up. 64-bit Windows, MacOS, and Linux (not including musl) are supported. (#1009,
#2431)
### Configuration
- Do not accept bare carriage return line endings in pyproject.toml (#2408)
- Add configuration option (`python-cell-magics`) to format cells with custom magics in
Jupyter Notebooks (#2744)
- Allow setting custom cache directory on all platforms with environment variable
`BLACK_CACHE_DIR` (#2739).
- Enable Python 3.10+ by default, without any extra need to specify
`--target-version=py310`. (#2758)
- Make passing `SRC` or `--code` mandatory and mutually exclusive (#2804)
### Output
- Improve error message for invalid regular expression (#2678)
- Improve error message when parsing fails during AST safety check by embedding the
underlying SyntaxError (#2693)
- No longer color diff headers white as it's unreadable in light themed terminals
(#2691)
- Text coloring added in the final statistics (#2712)
- Verbose mode also now describes how a project root was discovered and which paths will
be formatted. (#2526)
### Packaging
- All upper version bounds on dependencies have been removed (#2718)
- `typing-extensions` is no longer a required dependency in Python 3.10+ (#2772)
- Set `click` lower bound to `8.0.0` (#2791)
### Integrations
- Update GitHub action to support containerized runs (#2748)
### Documentation
- Change protocol in pip installation instructions to `https://` (#2761)
- Change HTML theme to Furo primarily for its responsive design and mobile support
(#2793)
- Deprecate the `black-primer` tool (#2809)
- Document Python support policy (#2819)
## Version 21.12b0
### _Black_
- Fix determination of f-string expression spans (#2654)
- Fix bad formatting of error messages about EOF in multi-line statements (#2343)
- Functions and classes in blocks now have more consistent surrounding spacing (#2472)
#### Jupyter Notebook support
- Cell magics are now only processed if they are known Python cell magics. Earlier, all
cell magics were tokenized, leading to possible indentation errors e.g. with
`%%writefile`. (#2630)
- Fix assignment to environment variables in Jupyter Notebooks (#2642)
#### Python 3.10 support
- Point users to using `--target-version py310` if we detect 3.10-only syntax (#2668)
- Fix `match` statements with open sequence subjects, like `match a, b:` or
`match a, *b:` (#2639) (#2659)
- Fix `match`/`case` statements that contain `match`/`case` soft keywords multiple
times, like `match re.match()` (#2661)
- Fix `case` statements with an inline body (#2665)
- Fix styling of starred expressions inside `match` subject (#2667)
- Fix parser error location on invalid syntax in a `match` statement (#2649)
- Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
- Improve parsing performance on code that uses `match` under `--target-version py310`
up to ~50% (#2670)
### Packaging
- Remove dependency on `regex` (#2644) (#2663)
## Version 21.11b1
### _Black_
- Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
## Version 21.11b0
### _Black_
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled
when `--target-version py310` is explicitly specified (#2586)
- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
### Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (#2613)
## Version 21.10b0
### _Black_
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new `--workers` parameter (#2514)
- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
### _Blackd_
- Remove dependency on aiohttp-cors (#2500)
- Bump required aiohttp version to 3.7.4 (#2509)
### _Black-Primer_
- Add primer support for --projects (#2555)
- Print primer summary after individual failures (#2570)
### Integrations
- Allow to pass `target_version` in the vim plugin (#1319)
- Install build tools in docker file and use multi-stage build to keep the image size
down (#2582)
## Version 21.9b0
### Packaging
- Fix missing modules in self-contained binaries (#2466)
- Fix missing toml extra used during installation (#2475)
## Version 21.8b0
### _Black_
- Add support for formatting Jupyter Notebook files (#2357)
- Move from `appdirs` dependency to `platformdirs` (#2375)
- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been
hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a
trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set
comprehensions, and indices (#2447).
- Pin `setuptools-scm` build-time dependency version (#2457)
- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10
(#2460)
### _Blackd_
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that
scan installed packages (#2440)
### Integrations
- The provided pre-commit hooks no longer specify `language_version` to avoid overriding
`default_language_version` (#2430)
## Version 21.7b0
### _Black_
- Configuration files using TOML features higher than spec v0.5.0 are now supported
(#2301)
- Add primer support and test for code piped into black via STDIN (#2315)
- Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (#2332)
- Accept empty stdin (#2346)
- Provide a more useful error when parsing fails during AST safety checks (#2304)
### Docker
- Add new `latest_release` tag automation to follow latest black release on docker
images (#2374)
### Integrations
- The vim plugin now searches upwards from the directory containing the current buffer
instead of the current working directory for pyproject.toml. (#1871)
- The vim plugin now reads the correct string normalization option in pyproject.toml
(#1869)
- The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
(#1869)
## Version 21.6b0
### _Black_
- Fix failure caused by `fmt: skip` and indentation (#2281)
- Account for += assignment when deciding whether to split string (#2312)
- Correct max string length calculation when there are string operators (#2292)
- Fixed option usage when using the `--code` flag (#2259)
- Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
- Added `--required-version` option to require a specific version to be running (#2300)
- Fix incorrect custom breakpoint indices when string group contains fake f-strings
(#2311)
- Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
- Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
used (#2319)
### Integrations
- The official Black action now supports choosing what version to use, and supports the
major 3 OSes. (#1940)
## Version 21.5b2
### _Black_
- A space is no longer inserted into empty docstrings (#2249)
- Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
- Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
`.gitignore` rules like `git` does) (#2225)
- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
- Add extra uvloop install + import support if in python env (#2258)
- Fix --experimental-string-processing crash when matching parens are not found (#2283)
- Make sure to split lines that start with a string operator (#2286)
- Fix regular expression that black uses to identify f-expressions (#2287)
### _Blackd_
- Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
supported. (#2231)
### Packaging
- Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
(#2198)
- Always build binaries with the latest available Python (#2260)
### Documentation
- Add discussion of magic comments to FAQ page (#2272)
- `--experimental-string-processing` will be enabled by default in the future (#2273)
- Fix typos discovered by codespell (#2228)
- Fix Vim plugin installation instructions. (#2235)
- Add new Frequently Asked Questions page (#2247)
- Fix encoding + symlink issues preventing proper build on Windows (#2262)
## Version 21.5b1
### _Black_
- Refactor `src/black/__init__.py` into many files (#2206)
### Documentation
- Replaced all remaining references to the
[`master`](https://github.com/psf/black/tree/main) branch with the
[`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
the source code were also made. (#2210)
- Significantly reorganized the documentation to make much more sense. Check them out by
heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
(#2174)
## Version 21.5b0
### _Black_
- Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
being called but with no arguments (#2182)
### _Black-Primer_
- Add `--no-diff` to black-primer to suppress formatting changes (#2187)
## Version 21.4b2
### _Black_
- Fix crash if the user configuration directory is inaccessible. (#2158)
- Clarify
[circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
in which _Black_ may change the AST (#2159)
- Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
or on the command line. (#2170)
### _Packaging_
- Install `primer.json` (used by `black-primer` by default) with black. (#2154)
## Version 21.4b1
### _Black_
- Fix crash on docstrings ending with "\\ ". (#2142)
- Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
- Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
in the name of the cache file. Without this fix, changes in these flags would not take
effect if the cache had already been populated. (#2131)
- Don't remove necessary parentheses from assignment expression containing assert /
return statements. (#2143)
### _Packaging_
- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
## Version 21.4b0
### _Black_
- Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by `Black` and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
duplicates. (#2126)
- `Black` now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (#1740)
- `Black` now cleans up leading non-breaking spaces in comments (#2092)
- `Black` now respects `--skip-string-normalization` when normalizing multiline
docstring quotes (#1637)
- `Black` no longer removes all empty lines between non-function code and decorators
when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
- `Black` no longer adds an incorrect space after a parenthesized assignment expression
in if/while statements (#1655)
- Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
to split lines (#1824)
- fixed a crash when PWD=/ on POSIX (#1631)
- fixed "I/O operation on closed file" when using --diff (#1664)
- Prevent coloured diff output being interleaved with multiple files (#1673)
- Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
- Added parsing support for unparenthesized tuples and yield expressions in annotated
assignments (#1835)
- added `--extend-exclude` argument (PR #2005)
- speed up caching by avoiding pathlib (#1950)
- `--diff` correctly indicates when a file doesn't end in a newline (#1662)
- Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
(#1780)
- Lines ending with `fmt: skip` will now be not formatted (#1800)
- PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
- PR #2053: Python 2 support is now optional, install with
`python3 -m pip install black[python2]` to maintain support.
- Exclude `venv` directory by default (#1683)
- Fixed "Black produced code that is not equivalent to the source" when formatting
Python 2 docstrings (#2037)
### _Packaging_
- Self-contained native _Black_ binaries are now provided for releases via GitHub
Releases (#1743)
## Version 20.8b1
### _Packaging_
- explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
older than 7.0
## Version 20.8b0
### _Black_
- re-implemented support for explicit trailing commas: now it works consistently within
any bracket pair, including nested structures (#1288 and duplicates)
- `Black` now reindents docstrings when reindenting code around it (#1053)
- `Black` now shows colored diffs (#1266)
- `Black` is now packaged using 'py3' tagged wheels (#1388)
- `Black` now supports Python 3.8 code, e.g. star expressions in return statements
(#1121)
- `Black` no longer normalizes capital R-string prefixes as those have a
community-accepted meaning (#1244)
- `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
- `Black` now works on AWS Lambda (#1141)
- added `--force-exclude` argument (#1032)
- removed deprecated `--py36` option (#1236)
- fixed `--diff` output when EOF is encountered (#526)
- fixed `# fmt: off` handling around decorators (#560)
- fixed unstable formatting with some `# type: ignore` comments (#1113)
- fixed invalid removal on organizing brackets followed by indexing (#1575)
- introduced `black-primer`, a CI tool that allows us to run regression tests against
existing open source users of Black (#1402)
- introduced property-based fuzzing to our test suite based on Hypothesis and
Hypothersmith (#1566)
- implemented experimental and disabled by default long string rewrapping (#1132),
hidden under a `--experimental-string-processing` flag while it's being worked on;
this is an undocumented and unsupported feature, you lose Internet points for
depending on it (#1609)
### Vim plugin
- prefer virtualenv packages over global packages (#1383)
## Version 19.10b0
- added support for PEP 572 assignment expressions (#711)
- added support for PEP 570 positional-only arguments (#943)
- added support for async generators (#593)
- added support for pre-splitting collections by putting an explicit trailing comma
inside (#826)
- added `black -c` as a way to format code passed from the command line (#761)
- --safe now works with Python 2 code (#840)
- fixed grammar selection for Python 2-specific code (#765)
- fixed feature detection for trailing commas in function definitions and call sites
(#763)
- `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
code now behave correctly (#1005)
- _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
- _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
- _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
- _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
- _Black_ no longer fails on comments in from-imports (#671)
- _Black_ no longer fails when the file starts with a backslash (#922)
- _Black_ no longer merges regular comments with type comments (#1027)
- _Black_ no longer splits long lines that contain type comments (#997)
- removed unnecessary parentheses around `yield` expressions (#834)
- added parentheses around long tuples in unpacking assignments (#832)
- added parentheses around complex powers when they are prefixed by a unary operator
(#646)
- fixed bug that led _Black_ format some code with a line length target of 1 (#762)
- _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
(#863)
- if _Black_ puts parenthesis around a single expression, it moves comments to the
wrapped expression instead of after the brackets (#872)
- `blackd` now returns the version of _Black_ in the response headers (#1013)
- `blackd` can now output the diff of formats on source code when the `X-Diff` header is
provided (#969)
## Version 19.3b0
- new option `--target-version` to control which Python versions _Black_-formatted code
should target (#618)
- deprecated `--py36` (use `--target-version=py36` instead) (#724)
- _Black_ no longer normalizes numeric literals to include `_` separators (#696)
- long `del` statements are now split into multiple lines (#698)
- type comments are no longer mangled in function signatures
- improved performance of formatting deeply nested data structures (#509)
- _Black_ now properly formats multiple files in parallel on Windows (#632)
- _Black_ now creates cache files atomically which allows it to be used in parallel
pipelines (like `xargs -P8`) (#673)
- _Black_ now correctly indents comments in files that were previously formatted with
tabs (#262)
- `blackd` now supports CORS (#622)
## Version 18.9b0
- numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
- numeric literals are normalized to include `_` separators on Python 3.6+ code
- added `--skip-numeric-underscore-normalization` to disable the above behavior and
leave numeric underscores as they were in the input
- code with `_` in numeric literals is recognized as Python 3.6+
- most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
- hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
- added `blackd`, see
[its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
more info (#349)
- adjacent string literals are now correctly split into multiple lines (#463)
- trailing comma is now added to single imports that don't fit on a line (#250)
- cache is now populated when `--check` is successful for a file which speeds up
consecutive checks of properly formatted unmodified files (#448)
- whitespace at the beginning of the file is now removed (#399)
- fixed mangling [pweave](http://mpastell.com/pweave/) and
[Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
- fixed unstable formatting when unpacking big tuples (#267)
- fixed parsing of `__future__` imports with renames (#389)
- fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
- fixed formatting of lambda expressions with default arguments (#468)
- fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
- note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
be a bad idea (#415)
## Version 18.6b4
- hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
## Version 18.6b3
- typing stub files (`.pyi`) now have blank lines added after constants (#340)
- `# fmt: off` and `# fmt: on` are now much more dependable:
- they now work also within bracket pairs (#329)
- they now correctly work across function/class boundaries (#335)
- they now work when an indentation block starts with empty lines or misaligned
comments (#334)
- made Click not fail on invalid environments; note that Click is right but the
likelihood we'll need to access non-ASCII file paths when dealing with Python source
code is low (#277)
- fixed improper formatting of f-strings with quotes inside interpolated expressions
(#322)
- fixed unnecessary slowdown when long list literals where found in a file
- fixed unnecessary slowdown on AST nodes with very many siblings
- fixed cannibalizing backslashes during string normalization
- fixed a crash due to symbolic links pointing outside of the project directory (#338)
## Version 18.6b2
- added `--config` (#65)
- added `-h` equivalent to `--help` (#316)
- fixed improper unmodified file caching when `-S` was used
- fixed extra space in string unpacking (#305)
- fixed formatting of empty triple quoted strings (#313)
- fixed unnecessary slowdown in comment placement calculation on lines without comments
## Version 18.6b1
- hotfix: don't output human-facing information on stdout (#299)
- hotfix: don't output cake emoji on non-zero return code (#300)
## Version 18.6b0
- added `--include` and `--exclude` (#270)
- added `--skip-string-normalization` (#118)
- added `--verbose` (#283)
- the header output in `--diff` now actually conforms to the unified diff spec
- fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
- fixed unnecessary parentheses when a line contained multiline strings (#232)
- fixed stdin handling not working correctly if an old version of Click was used (#276)
- _Black_ now preserves line endings when formatting a file in place (#258)
## Version 18.5b1
- added `--pyi` (#249)
- added `--py36` (#249)
- Python grammar pickle caches are stored with the formatting caches, making _Black_
work in environments where site-packages is not user-writable (#192)
- _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
fields) and the first method
- fixed invalid code produced when standalone comments were present in a trailer that
was omitted from line splitting on a large expression (#237)
- fixed optional parentheses being removed within `# fmt: off` sections (#224)
- fixed invalid code produced when stars in very long imports were incorrectly wrapped
in optional parentheses (#234)
- fixed unstable formatting when inline comments were moved around in a trailer that was
omitted from line splitting on a large expression (#238)
- fixed extra empty line between a class declaration and the first method if no class
docstring or fields are present (#219)
- fixed extra empty line between a function signature and an inner function or inner
class (#196)
## Version 18.5b0
- call chains are now formatted according to the
[fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
- data structure literals (tuples, lists, dictionaries, and sets) are now also always
exploded like imports when they don't fit in a single line (#152)
- slices are now formatted according to PEP 8 (#178)
- parentheses are now also managed automatically on the right-hand side of assignments
and return statements (#140)
- math operators now use their respective priorities for delimiting multiline
expressions (#148)
- optional parentheses are now omitted on expressions that start or end with a bracket
and only contain a single operator (#177)
- empty parentheses in a class definition are now removed (#145, #180)
- string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
#199)
- typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
484 (#207, #210)
- progress when reformatting many files is now reported incrementally
- fixed trailers (content with brackets) being unnecessarily exploded into their own
lines after a dedented closing bracket (#119)
- fixed an invalid trailing comma sometimes left in imports (#185)
- fixed non-deterministic formatting when multiple pairs of removable parentheses were
used (#183)
- fixed multiline strings being unnecessarily wrapped in optional parentheses in long
assignments (#215)
- fixed not splitting long from-imports with only a single name
- fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
This fixed non-deterministic formatting if trailing commas where used both in function
signatures with stars and function calls with stars but the former would be
reformatted to a single line.
- fixed crash on dealing with optional parentheses (#193)
- fixed "is", "is not", "in", and "not in" not considered operators for splitting
purposes
- fixed crash when dead symlinks where encountered
## Version 18.4a4
- don't populate the cache on `--check` (#175)
## Version 18.4a3
- added a "cache"; files already reformatted that haven't changed on disk won't be
reformatted again (#109)
- `--check` and `--diff` are no longer mutually exclusive (#149)
- generalized star expression handling, including double stars; this fixes
multiplication making expressions "unsafe" for trailing commas (#132)
- _Black_ no longer enforces putting empty lines behind control flow statements (#90)
- _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
- fixed comment indentation when a standalone comment closes a block (#16, #32)
- fixed standalone comments receiving extra empty lines if immediately preceding a
class, def, or decorator (#56, #154)
- fixed `--diff` not showing entire path (#130)
- fixed parsing of complex expressions after star and double stars in function calls
(#2)
- fixed invalid splitting on comma in lambda arguments (#133)
- fixed missing splits of ternary expressions (#141)
## Version 18.4a2
- fixed parsing of unaligned standalone comments (#99, #112)
- fixed placement of dictionary unpacking inside dictionary literals (#111)
- Vim plugin now works on Windows, too
- fixed unstable formatting when encountering unnecessarily escaped quotes in a string
(#120)
## Version 18.4a1
- added `--quiet` (#78)
- added automatic parentheses management (#4)
- added [pre-commit](https://pre-commit.com) integration (#103, #104)
- fixed reporting on `--check` with multiple files (#101, #102)
- fixed removing backslash escapes from raw strings (#100, #105)
## Version 18.4a0
- added `--diff` (#87)
- add line breaks before all delimiters, except in cases like commas, to better comply
with PEP 8 (#73)
- standardize string literals to use double quotes (almost) everywhere (#75)
- fixed handling of standalone comments within nested bracketed expressions; _Black_
will no longer produce super long lines or put all standalone comments at the end of
the expression (#22)
- fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
(#80)
- fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
_Black_ to not emit the rest of the file (#95)
- when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
a flurry of asyncio-related exceptions
- only allow up to two empty lines on module level and only single empty lines within
functions (#74)
## Version 18.3a4
- `# fmt: off` and `# fmt: on` are implemented (#5)
- automatic detection of deprecated Python 2 forms of print statements and exec
statements in the formatted file (#49)
- use proper spaces for complex expressions in default values of typed function
arguments (#60)
- only return exit code 1 when --check is used (#50)
- don't remove single trailing commas from square bracket indexing (#59)
- don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
- omit extra space in kwarg unpacking if it's the first argument (#46)
- omit extra space in
[Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
(#68)
## Version 18.3a3
- don't remove single empty lines outside of bracketed expressions (#19)
- added ability to pipe formatting from stdin to stdin (#25)
- restored ability to format code with legacy usage of `async` as a name (#20, #42)
- even better handling of numpy-style array indexing (#33, again)
## Version 18.3a2
- changed positioning of binary operators to occur at beginning of lines instead of at
the end, following
[a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
(#21)
- ignore empty bracket pairs while splitting. This avoids very weirdly looking
formattings (#34, #35)
- remove a trailing comma if there is a single argument to a call
- if top level functions were separated by a comment, don't put four empty lines after
the upper function
- fixed unstable formatting of newlines with imports
- fixed unintentional folding of post scriptum standalone comments into last statement
if it was a simple statement (#18, #28)
- fixed missing space in numpy-style array indexing (#33)
- fixed spurious space after star-based unary expressions (#31)
## Version 18.3a1
- added `--check`
- only put trailing commas in function signatures and calls if it's safe to do so. If
the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
or `**kwargs` used in the signature or call. (#8)
- fixed invalid spacing of dots in relative imports (#6, #13)
- fixed invalid splitting after comma on unpacked variables in for-loops (#23)
- fixed spurious space in parenthesized set expressions (#7)
- fixed spurious space after opening parentheses and in default arguments (#14, #17)
- fixed spurious space after unary operators when the operand was a complex expression
(#15)
## Version 18.3a0
- first published version, Happy � Day 2018!
- alpha quality
- date-versioned (see: )
psf-black-258e7db/CITATION.cff 0000664 0000000 0000000 00000001645 15262335054 0015703 0 ustar 00root root 0000000 0000000 cff-version: 1.2.0
title: "Black: The uncompromising Python code formatter"
message: >-
If you use this software, please cite it using the metadata from this file.
type: software
authors:
- family-names: Langa
given-names: �ukasz
- name: "contributors to Black"
repository-code: "https://github.com/psf/black"
url: "https://black.readthedocs.io/en/stable/"
abstract: >-
Black is the uncompromising Python code formatter. By using it, you agree to cede
control over minutiae of hand-formatting. In return, Black gives you speed,
determinism, and freedom from pycodestyle nagging about formatting. You will save time
and mental energy for more important matters.
Blackened code looks the same regardless of the project you're reading. Formatting
becomes transparent after a while and you can focus on the content instead.
Black makes code review faster by producing the smallest diffs possible.
license: MIT
psf-black-258e7db/CONTRIBUTING.md 0000664 0000000 0000000 00000001007 15262335054 0016232 0 ustar 00root root 0000000 0000000 # Contributing to _Black_
Welcome future contributor! We're happy to see you willing to make the project better.
If you aren't familiar with _Black_, or are looking for documentation on something
specific, the [user documentation](https://black.readthedocs.io/en/stable/) is the best
place to look.
For getting started on contributing, please read the
[contributing documentation](https://black.readthedocs.io/en/latest/contributing/) for
all you need to know.
Thank you, and we look forward to your contributions!
psf-black-258e7db/Dockerfile 0000664 0000000 0000000 00000001570 15262335054 0016000 0 ustar 00root root 0000000 0000000 FROM python:3.14-slim AS builder
RUN mkdir /src
COPY . /src/
ENV VIRTUAL_ENV=/opt/venv
ENV HATCH_BUILD_HOOKS_ENABLE=1
# Install build tools to compile black + dependencies
RUN apt update && apt install -y build-essential git python3-dev
ENV PATH="$VIRTUAL_ENV/bin:$PATH"
RUN python -m venv $VIRTUAL_ENV
RUN cd /src \
# virtualenv 20.39 uses pip 26.0 - use `ENV ...=P2D` once we bump virtualenv/hatch
&& export PIP_UPLOADED_PRIOR_TO=$(date -u -d "2 days ago" +%Y-%m-%dT%H:%M:%SZ) \
&& pip install --no-cache-dir --upgrade pip \
&& pip install --no-cache-dir --group hatch \
&& hatch build -t wheel \
&& pip install --no-cache-dir dist/*-cp* \
&& pip install black[colorama,d,uvloop]
FROM python:3.14-slim
# copy only Python packages to limit the image size
COPY --from=builder /opt/venv /opt/venv
ENV PATH="/opt/venv/bin:$PATH"
CMD ["/opt/venv/bin/black"]
psf-black-258e7db/LICENSE 0000664 0000000 0000000 00000002070 15262335054 0015007 0 ustar 00root root 0000000 0000000 The MIT License (MIT)
Copyright (c) 2018 �ukasz Langa
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
psf-black-258e7db/README.md 0000664 0000000 0000000 00000023227 15262335054 0015270 0 ustar 00root root 0000000 0000000 [](https://black.readthedocs.io/en/stable/)
The Uncompromising Code Formatter
> “Any color you like.�
_Black_ is the uncompromising Python code formatter. By using it, you agree to cede
control over minutiae of hand-formatting. In return, _Black_ gives you speed,
determinism, and freedom from `pycodestyle` nagging about formatting. You will save time
and mental energy for more important matters.
Blackened code looks the same regardless of the project you're reading. Formatting
becomes transparent after a while and you can focus on the content instead.
_Black_ makes code review faster by producing the smallest diffs possible.
Watch the [PyCon 2019 talk](https://youtu.be/esZLCuWs_2Y) to learn more.
---
**[Read the documentation on ReadTheDocs!](https://black.readthedocs.io/en/stable)**
---
## Installation and usage
### Installation
_Black_ can be installed by running `pip install black`. It requires Python 3.10+ to
run. If you want to format Jupyter Notebooks, install with
`pip install "black[jupyter]"`.
If you want to run _Black_ without installing Python, download one of the
PyInstaller-built standalone executables from the
[latest GitHub release](https://github.com/psf/black/releases/latest).
### Usage
To get started right away with sensible defaults:
```sh
black {source_file_or_directory}
```
You can run _Black_ as a package if running it as a script doesn't work:
```sh
python -m black {source_file_or_directory}
```
Further information can be found in our docs:
- [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html)
_Black_ is already [successfully used](https://github.com/psf/black#used-by) by many
projects, small and big. _Black_ has a comprehensive test suite, with efficient parallel
tests, and our own auto formatting and parallel Continuous Integration runner. Now that
we have become stable, you should not expect large formatting changes in the future.
Stylistic changes will mostly be responses to bug reports and support for new Python
syntax. For more information please refer to
[The Black Code Style](https://black.readthedocs.io/en/stable/the_black_code_style/index.html).
Also, as a safety measure which slows down processing, _Black_ will check that the
reformatted code still produces a valid AST that is effectively equivalent to the
original (see the
[Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#ast-before-and-after-formatting)
section for details). If you're feeling confident, use `--fast`.
## The _Black_ code style
_Black_ is a PEP 8 compliant opinionated formatter. _Black_ reformats entire files in
place. Style configuration options are deliberately limited and rarely added. It doesn't
take previous formatting into account (see
[Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#pragmatism)
for exceptions).
Our documentation covers the current _Black_ code style, but planned changes to it are
also documented. They're both worth taking a look at:
- [The _Black_ Code Style: Current style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
- [The _Black_ Code Style: Future style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html)
Changes to the _Black_ code style are bound by the Stability Policy:
- [The _Black_ Code Style: Stability Policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy)
Please refer to this document before submitting an issue. What seems like a bug might be
intended behaviour.
### Pragmatism
Early versions of _Black_ used to be absolutist in some respects. They took after its
initial author. This was fine at the time as it made the implementation simpler and
there were not many users anyway. Not many edge cases were reported. As a mature tool,
_Black_ does make some exceptions to rules it otherwise holds.
- [The _Black_ code style: Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#pragmatism)
Please refer to this document before submitting an issue just like with the document
above. What seems like a bug might be intended behaviour.
## Configuration
_Black_ is able to read project-specific default values for its command line options
from a `pyproject.toml` file. This is especially useful for specifying custom
`--include` and `--exclude`/`--force-exclude`/`--extend-exclude` patterns for your
project.
You can find more details in our documentation:
- [The basics: Configuration via a file](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file)
And if you're looking for more general configuration documentation:
- [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html)
**Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
"No". _Black_ is all about sensible defaults. Applying those defaults will have your
code in compliance with many other _Black_ formatted projects.
## Used by
The following notable open-source projects trust _Black_ with enforcing a consistent
code style: pytest, tox, Pyramid, Django, Django Channels, Hypothesis, attrs,
SQLAlchemy, Poetry, PyPA applications (Warehouse, Bandersnatch, Pipenv, virtualenv),
pandas, Pillow, Twisted, LocalStack, every Datadog Agent Integration, Home Assistant,
Zulip, Kedro, OpenOA, FLORIS, ORBIT, WOMBAT, and many more.
The following organizations use _Black_: Dropbox, KeepTruckin, Lyft, Mozilla, Quora,
Duolingo, QuantumBlack, Tesla, Archer Aviation.
Are we missing anyone? Let us know.
## Testimonials
**Mike Bayer**, creator of [`SQLAlchemy`](https://www.sqlalchemy.org/):
> I can't think of any single tool in my entire programming career that has given me a
> bigger productivity increase by its introduction. I can now do refactorings in about
> 1% of the keystrokes that it would have taken me previously when we had no way for
> code to format itself.
**Dusty Phillips**,
[writer](https://www.amazon.com/stores/Dusty-Phillips/author/B00HSYG5BO):
> _Black_ is opinionated so you don't have to be.
**Hynek Schlawack**, creator of [`attrs`](https://www.attrs.org/), core developer of
Twisted and CPython:
> An auto-formatter that doesn't suck is all I want for Xmas!
**Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
> At least the name is good.
**Kenneth Reitz**, creator of [`requests`](https://requests.readthedocs.io/en/stable/)
and [pipenv](https://pipenv.pypa.io/en/stable/):
> This vastly improves the formatting of our code. Thanks a ton!
## Show your style
Use the badge in your project's README.md:
```md
[](https://github.com/psf/black)
```
Using the badge in README.rst:
```rst
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
```
Looks like this:
[](https://github.com/psf/black)
## License
MIT
## Contributing
Welcome! Happy to see you willing to make the project better. You can get started by
reading this:
- [Contributing: The basics](https://black.readthedocs.io/en/latest/contributing/the_basics.html)
You can also take a look at the rest of the contributing docs or talk with the
developers:
- [Contributing documentation](https://black.readthedocs.io/en/latest/contributing/index.html)
- [Chat on Discord](https://discord.gg/RtVdv86PrH)
## Change log
The log has become rather long. It moved to its own file.
See [CHANGES](https://black.readthedocs.io/en/latest/change_log.html).
## Authors
The author list is quite long nowadays, so it lives in its own file.
See [AUTHORS.md](./AUTHORS.md)
## Code of Conduct
Everyone participating in the _Black_ project, and in particular in the issue tracker,
pull requests, and social media activity, is expected to treat other people with respect
and more generally to follow the guidelines articulated in the
[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
At the same time, humor is encouraged. In fact, basic familiarity with Monty Python's
Flying Circus is expected. We are not savages.
And if you _really_ need to slap somebody, do it with a fish while dancing.
psf-black-258e7db/SECURITY.md 0000664 0000000 0000000 00000000441 15262335054 0015573 0 ustar 00root root 0000000 0000000 # Security Policy
## Supported Versions
Only the latest non-prerelease version is supported.
## Security contact information
To report a security vulnerability, please use the
[Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the
fix and disclosure.
psf-black-258e7db/action.yml 0000664 0000000 0000000 00000006315 15262335054 0016010 0 ustar 00root root 0000000 0000000 name: "Black"
description: "The uncompromising Python code formatter."
author: "�ukasz Langa and contributors to Black"
inputs:
options:
description:
"Options passed to Black. Use `black --help` to see available options. Default:
'--check --diff'"
required: false
default: "--check --diff"
src:
description: "Source to run Black. Default: '.'"
required: false
default: "."
jupyter:
description:
"Set this option to true to include Jupyter Notebook files. Default: false"
required: false
default: false
black_args:
description: "[DEPRECATED] Black input arguments."
required: false
default: ""
deprecationMessage:
"Input `with.black_args` is deprecated. Use `with.options` and `with.src` instead."
version:
description: 'Python Version specifier (PEP440) - e.g. "21.5b1"'
required: false
default: ""
use_pyproject:
description: Read Black version specifier from pyproject.toml if `true`.
required: false
default: "false"
summary:
description: "Whether to add the output to the workflow summary"
required: false
default: true
output-file:
description: >
Optional path to write Black output to a file in addition to stdout. Useful for
keeping GitHub Actions logs clean when using --diff or --check.
required: false
default: ""
outputs:
is_formatted:
description: "Whether any files were reformatted or would be reformatted."
value: ${{ steps.black.outputs.is_formatted }}
change_count:
description: "Number of files that were reformatted or would be reformatted."
value: ${{ steps.black.outputs.change_count }}
same_count:
description: "Number of files that were left unchanged."
value: ${{ steps.black.outputs.same_count }}
failure_count:
description: "Number of files that failed to reformat."
value: ${{ steps.black.outputs.failure_count }}
branding:
color: "black"
icon: "check-circle"
runs:
using: composite
steps:
- name: black
id: black
run: |
# Even when black fails, do not close the shell
set +e
if [ "$RUNNER_OS" == "Windows" ]; then
runner="python"
else
runner="python3"
fi
out=$(${runner} $GITHUB_ACTION_PATH/action/main.py)
exit_code=$?
# Display the raw output in the step
echo "${out}"
if [ "${INPUT_SUMMARY}" == "true" ]; then
# Display the Markdown output in the job summary
echo "\`\`\`python" >> $GITHUB_STEP_SUMMARY
echo "${out}" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
fi
# Exit with the exit-code returned by Black
exit ${exit_code}
env:
# TODO: Remove once https://github.com/actions/runner/issues/665 is fixed.
INPUT_OPTIONS: ${{ inputs.options }}
INPUT_SRC: ${{ inputs.src }}
INPUT_JUPYTER: ${{ inputs.jupyter }}
INPUT_BLACK_ARGS: ${{ inputs.black_args }}
INPUT_VERSION: ${{ inputs.version }}
INPUT_USE_PYPROJECT: ${{ inputs.use_pyproject }}
INPUT_SUMMARY: ${{ inputs.summary }}
OUTPUT_FILE: ${{ inputs.output-file }}
pythonioencoding: utf-8
shell: bash
psf-black-258e7db/action/ 0000775 0000000 0000000 00000000000 15262335054 0015260 5 ustar 00root root 0000000 0000000 psf-black-258e7db/action/main.py 0000664 0000000 0000000 00000015553 15262335054 0016567 0 ustar 00root root 0000000 0000000 import os
import re
import shlex
import shutil
import sys
from pathlib import Path
from subprocess import PIPE, STDOUT, run
ACTION_PATH = Path(os.environ["GITHUB_ACTION_PATH"])
ENV_PATH = ACTION_PATH / ".black-env"
ENV_BIN = ENV_PATH / ("Scripts" if sys.platform == "win32" else "bin")
OPTIONS = os.getenv("INPUT_OPTIONS", default="")
SRC = os.getenv("INPUT_SRC", default="")
JUPYTER = os.getenv("INPUT_JUPYTER") == "true"
BLACK_ARGS = os.getenv("INPUT_BLACK_ARGS", default="")
VERSION = os.getenv("INPUT_VERSION", default="")
USE_PYPROJECT = os.getenv("INPUT_USE_PYPROJECT") == "true"
OUTPUT_FILE = os.getenv("OUTPUT_FILE", default="")
BLACK_VERSION_RE = re.compile(
r"^black((?:\s*(?:~=|==|!=|<=|>=|<|>|===)\s*[A-Za-z0-9*+._-]+)"
r"(?:\s*,\s*(?:~=|==|!=|<=|>=|<|>|===)\s*[A-Za-z0-9*+._-]+)*)\s*$",
re.IGNORECASE,
)
EXTRAS_RE = re.compile(r"\[.*\]")
EXPORT_SUBST_FAIL_RE = re.compile(r"\$Format:.*\$")
def determine_version_specifier() -> str:
"""Determine the version of Black to install.
The version can be specified either via the `with.version` input or via the
pyproject.toml file if `with.use_pyproject` is set to `true`.
"""
if USE_PYPROJECT and VERSION:
print(
"::error::'with.version' and 'with.use_pyproject' inputs are "
"mutually exclusive.",
file=sys.stderr,
flush=True,
)
sys.exit(1)
if USE_PYPROJECT:
return read_version_specifier_from_pyproject()
elif VERSION and VERSION[0] in "0123456789":
return f"=={VERSION}"
else:
return VERSION
def read_version_specifier_from_pyproject() -> str:
if sys.version_info < (3, 11):
print(
"::error::'with.use_pyproject' input requires Python 3.11 or later.",
file=sys.stderr,
flush=True,
)
sys.exit(1)
import tomllib # type: ignore[import-not-found,unreachable]
try:
with Path("pyproject.toml").open("rb") as fp:
pyproject = tomllib.load(fp)
except FileNotFoundError:
print(
"::error::'with.use_pyproject' input requires a pyproject.toml file.",
file=sys.stderr,
flush=True,
)
sys.exit(1)
version = pyproject.get("tool", {}).get("black", {}).get("required-version")
if version is not None:
version = str(version).strip()
if not version:
return ""
# If bare version number or major version is provided, format accordingly:
if version[0] in "0123456789":
if "." in version:
version = f"=={version}"
else:
version = f"~={version}.0"
# Accept only version specifiers, as for the dependency arrays below, so
# this can't turn into a direct reference that installs something else.
if m := BLACK_VERSION_RE.match(f"black{version}"):
return m.group(1).strip()
print(
"::error::Invalid 'required-version' in pyproject.toml: expected a"
" version or version specifier, for example '26.1.0' or '>=26,<27'.",
file=sys.stderr,
flush=True,
)
sys.exit(1)
arrays = [
*pyproject.get("dependency-groups", {}).values(),
pyproject.get("project", {}).get("dependencies"),
*pyproject.get("project", {}).get("optional-dependencies", {}).values(),
]
for array in arrays:
version = find_black_version_in_array(array)
if version is not None:
break
if version is None:
print(
"::error::'black' dependency missing from pyproject.toml.",
file=sys.stderr,
flush=True,
)
sys.exit(1)
return version
def find_black_version_in_array(array: object) -> str | None:
if not isinstance(array, list):
return None
try:
for item in array:
if not isinstance(item, str):
continue
# Rudimentary PEP 508 parsing.
item = item.split(";")[0]
item = EXTRAS_RE.sub("", item).strip()
if item == "black":
print(
"::error::Version specifier missing for 'black' dependency in "
"pyproject.toml.",
file=sys.stderr,
flush=True,
)
sys.exit(1)
elif m := BLACK_VERSION_RE.match(item):
return m.group(1).strip()
except TypeError:
pass
return None
run([sys.executable, "-m", "venv", str(ENV_PATH)], check=True)
version_specifier = determine_version_specifier()
if JUPYTER:
extra_deps = "[colorama,jupyter]"
else:
extra_deps = "[colorama]"
if version_specifier:
req = f"black{extra_deps}{version_specifier}"
else:
describe_name = ""
with open(ACTION_PATH / ".git_archival.txt", encoding="utf-8") as fp:
for line in fp:
if line.startswith("describe-name: "):
describe_name = line[len("describe-name: ") :].rstrip()
break
if not describe_name:
print("::error::Failed to detect action version.", file=sys.stderr, flush=True)
sys.exit(1)
# expected format is one of:
# - 23.1.0
# - 23.1.0-51-g448bba7
# - $Format:%(describe:tags=true,match=*[0-9]*)$ (if export-subst fails)
if (
describe_name.count("-") < 2
and EXPORT_SUBST_FAIL_RE.match(describe_name) is None
):
# the action's commit matches a tag exactly, install exact version from PyPI
req = f"black{extra_deps}=={describe_name}"
else:
# the action's commit does not match any tag, install from the local git repo
req = f".{extra_deps}"
print(f"Installing {req}...", flush=True)
pip_proc = run(
[str(ENV_BIN / "python"), "-m", "pip", "install", req],
stdout=PIPE,
stderr=STDOUT,
encoding="utf-8",
cwd=ACTION_PATH,
)
if pip_proc.returncode:
print(pip_proc.stdout)
print("::error::Failed to install Black.", file=sys.stderr, flush=True)
sys.exit(pip_proc.returncode)
base_cmd = [str(ENV_BIN / "black")]
if BLACK_ARGS:
# TODO: remove after a while since this is deprecated in favour of SRC + OPTIONS.
proc = run(
[*base_cmd, *shlex.split(BLACK_ARGS)],
stdout=PIPE,
stderr=STDOUT,
encoding="utf-8",
)
else:
proc = run(
[*base_cmd, *shlex.split(OPTIONS), *shlex.split(SRC)],
stdout=PIPE,
stderr=STDOUT,
encoding="utf-8",
)
shutil.rmtree(ENV_PATH, ignore_errors=True)
# Write output to file if specified
if OUTPUT_FILE:
try:
with open(OUTPUT_FILE, "w", encoding="utf-8") as f:
f.write(proc.stdout)
print(f"Black output written to {OUTPUT_FILE}")
except Exception as e:
print(f"::error::Failed to write output to {OUTPUT_FILE}: {e}", file=sys.stderr)
sys.exit(1)
print(proc.stdout)
sys.exit(proc.returncode)
psf-black-258e7db/autoload/ 0000775 0000000 0000000 00000000000 15262335054 0015613 5 ustar 00root root 0000000 0000000 psf-black-258e7db/autoload/black.vim 0000664 0000000 0000000 00000022315 15262335054 0017407 0 ustar 00root root 0000000 0000000 python3 << EndPython3
import collections
import os
import sys
import vim
def strtobool(text):
if text.lower() in ["y", "yes", "t", "true", "on", "1"]:
return True
if text.lower() in ["n", "no", "f", "false", "off", "0"]:
return False
raise ValueError(f"{text} is not convertible to boolean")
class Flag(collections.namedtuple("FlagBase", "name, cast")):
@property
def var_name(self):
return self.name.replace("-", "_")
@property
def vim_rc_name(self):
name = self.var_name
if name == "line_length":
name = name.replace("_", "")
return "g:black_" + name
FLAGS = [
Flag(name="line_length", cast=int),
Flag(name="fast", cast=strtobool),
Flag(name="skip_string_normalization", cast=strtobool),
Flag(name="quiet", cast=strtobool),
Flag(name="skip_magic_trailing_comma", cast=strtobool),
Flag(name="preview", cast=strtobool),
]
def _get_python_binary(exec_prefix, pyver):
try:
default = vim.eval("g:pymode_python").strip()
except vim.error:
default = ""
if default and os.path.exists(default):
return default
if sys.platform[:3] == "win":
return exec_prefix / "python.exe"
bin_path = exec_prefix / "bin"
exec_path = (bin_path / f"python{pyver[0]}.{pyver[1]}").resolve()
if exec_path.exists():
return exec_path
# It is possible that some environments may only have python3
exec_path = (bin_path / "python3").resolve()
if exec_path.exists():
return exec_path
raise ValueError("python executable not found")
def _get_pip(venv_path):
if sys.platform[:3] == "win":
return venv_path / "Scripts" / "pip.exe"
return venv_path / "bin" / "pip"
def _get_virtualenv_site_packages(venv_path, pyver):
if sys.platform[:3] == "win":
return venv_path / "Lib" / "site-packages"
if (
venv_path.exists()
and not (venv_path / "lib" / f"python{pyver[0]}.{pyver[1]}").exists()
):
# The virtualenv already exists but it doesn't seem to have the expected
# Python version, so we disregard the requested `pyver` and
# discover the real Python interpreter from this virtualenv
import subprocess
result = subprocess.run(
[_get_python_binary(venv_path, pyver), "--version"],
stdout=subprocess.PIPE,
text=True,
)
venv_version = result.stdout.split(" ")[1].strip().split(".")
return (
venv_path
/ "lib"
/ f"python{venv_version[0]}.{venv_version[1]}"
/ "site-packages"
)
else:
return venv_path / "lib" / f"python{pyver[0]}.{pyver[1]}" / "site-packages"
def _initialize_black_env(upgrade=False):
if vim.eval("g:black_use_virtualenv ? 'true' : 'false'") == "false":
if upgrade:
print("Upgrade disabled due to g:black_use_virtualenv being disabled.")
print(
"Either use your system package manager (or pip) to upgrade black"
" separately,"
)
print("or modify your vimrc to have 'let g:black_use_virtualenv = 1'.")
return False
else:
# Nothing needed to be done.
return True
pyver = sys.version_info[:3]
if pyver < (3, 10):
print("Sorry, Black requires Python 3.10+ to run.")
return False
from pathlib import Path
import subprocess
import venv
virtualenv_path = Path(vim.eval("g:black_virtualenv")).expanduser()
virtualenv_site_packages = str(
_get_virtualenv_site_packages(virtualenv_path, pyver)
)
first_install = False
if not virtualenv_path.is_dir():
print("Please wait, one time setup for Black.")
_executable = sys.executable
_base_executable = getattr(sys, "_base_executable", _executable)
try:
executable = str(_get_python_binary(Path(sys.exec_prefix), pyver))
sys.executable = executable
sys._base_executable = executable
print(f"Creating a virtualenv in {virtualenv_path}...")
print(
"(this path can be customized in .vimrc by setting g:black_virtualenv)"
)
venv.create(virtualenv_path, with_pip=True)
except Exception:
print(
"Encountered exception while creating virtualenv (see traceback below)."
)
print(f"Removing {virtualenv_path}...")
import shutil
shutil.rmtree(virtualenv_path)
raise
finally:
sys.executable = _executable
sys._base_executable = _base_executable
first_install = True
if first_install:
print("Installing Black with pip...")
if upgrade:
print("Upgrading Black with pip...")
if first_install or upgrade:
subprocess.run(
[str(_get_pip(virtualenv_path)), "install", "-U", "black"],
stdout=subprocess.PIPE,
)
print("DONE! You are all set, thanks for waiting ✨ � ✨")
if first_install:
print(
"Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and"
" restart Vim.\n"
)
if virtualenv_site_packages not in sys.path:
sys.path.insert(0, virtualenv_site_packages)
return True
if _initialize_black_env():
try:
import black
except ImportError:
print(f"Could not import black from any of: {', '.join(sys.path)}.")
import time
def get_target_version(tv):
if isinstance(tv, black.TargetVersion):
return tv
ret = None
try:
ret = black.TargetVersion[tv.upper()]
except KeyError:
print(
f"WARNING: Target version {tv!r} not recognized by Black, using default"
" target"
)
return ret
def Black(**kwargs):
"""
kwargs allows you to override ``target_versions`` argument of
``black.FileMode``.
``target_version`` needs to be cleaned because ``black.FileMode``
expects the ``target_versions`` argument to be a set of TargetVersion enums.
Allow kwargs["target_version"] to be a string to allow
to type it more quickly.
Using also target_version instead of target_versions to remain
consistent to Black's documentation of the structure of pyproject.toml.
"""
start = time.time()
configs = get_configs()
black_kwargs = {}
if "target_version" in kwargs:
target_version = kwargs["target_version"]
if not isinstance(target_version, (list, set)):
target_version = [target_version]
target_version = set(
filter(lambda x: x, map(lambda tv: get_target_version(tv), target_version))
)
black_kwargs["target_versions"] = target_version
mode = black.FileMode(
line_length=configs["line_length"],
string_normalization=not configs["skip_string_normalization"],
is_pyi=vim.current.buffer.name.endswith(".pyi"),
magic_trailing_comma=not configs["skip_magic_trailing_comma"],
preview=configs["preview"],
**black_kwargs,
)
quiet = configs["quiet"]
buffer_str = "\n".join(vim.current.buffer) + "\n"
try:
new_buffer_str = black.format_file_contents(
buffer_str,
fast=configs["fast"],
mode=mode,
)
except black.NothingChanged:
if not quiet:
print(
"Black: already well formatted, good job. (took"
f" {time.time() - start:.4f}s)"
)
except Exception as exc:
print(f"Black: {exc}")
else:
current_buffer = vim.current.window.buffer
cursors = []
for i, tabpage in enumerate(vim.tabpages):
if tabpage.valid:
for j, window in enumerate(tabpage.windows):
if window.valid and window.buffer == current_buffer:
cursors.append((i, j, window.cursor))
vim.current.buffer[:] = new_buffer_str.split("\n")[:-1]
for i, j, cursor in cursors:
window = vim.tabpages[i].windows[j]
try:
window.cursor = cursor
except vim.error:
window.cursor = (len(window.buffer), 0)
if not quiet:
print(f"Black: reformatted in {time.time() - start:.4f}s.")
def get_configs():
filename = vim.eval("@%")
path_pyproject_toml = black.find_pyproject_toml((filename,))
if path_pyproject_toml:
toml_config = black.parse_pyproject_toml(path_pyproject_toml)
else:
toml_config = {}
return {
flag.var_name: toml_config.get(flag.name, flag.cast(vim.eval(flag.vim_rc_name)))
for flag in FLAGS
}
def BlackUpgrade():
_initialize_black_env(upgrade=True)
def BlackVersion():
print(f"Black, version {black.__version__} on Python {sys.version}.")
EndPython3
function black#Black(...)
let kwargs = {}
for arg in a:000
let arg_list = split(arg, '=')
let kwargs[arg_list[0]] = arg_list[1]
endfor
python3 << EOF
import vim
kwargs = vim.eval("kwargs")
EOF
:py3 Black(**kwargs)
endfunction
function black#BlackUpgrade()
:py3 BlackUpgrade()
endfunction
function black#BlackVersion()
:py3 BlackVersion()
endfunction
psf-black-258e7db/docs/ 0000775 0000000 0000000 00000000000 15262335054 0014733 5 ustar 00root root 0000000 0000000 psf-black-258e7db/docs/Makefile 0000664 0000000 0000000 00000001132 15262335054 0016370 0 ustar 00root root 0000000 0000000 # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = black
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
psf-black-258e7db/docs/_static/ 0000775 0000000 0000000 00000000000 15262335054 0016361 5 ustar 00root root 0000000 0000000 psf-black-258e7db/docs/_static/license.svg 0000664 0000000 0000000 00000001666 15262335054 0020535 0 ustar 00root root 0000000 0000000
psf-black-258e7db/docs/_static/logo2-readme.png 0000664 0000000 0000000 00000302407 15262335054 0021352 0 ustar 00root root 0000000 0000000 ‰PNG
IHDR ° ¸ UJ sRGB ®Îé YiTXtXML:com.adobe.xmp
1
LÂ'Y ƒ\IDATxÚìÝmˆeg} ðšhÐVÛ¢bªRJ#HµýÒmýfµXZ(¥”"TZhÑÒRè‡`ðKÅ|)…"ÑÝÌûë½wîÌÜÙ™gçeßf“íìÝ�}ÉÎ&»;»›“˜˜Õxú<çÜórï��‰�5‰¿ü9ïç>çœçÜ?ÿçÌÏü ?¢$I^âöv»}ÇåË—ßôè£�¾åÛßþö[yä‘_úÖ·¾õž+W®¼÷ìÙ³¿uþüùž;wîcaþSg/œý³0ý«Ÿ
ñ÷aý?�;·ýoazOXþJˆÿûÿwˆ¡ísçFâ4¬8}úôÀ™3gö‡ýö‡å}!¾#,-î¦ÿ�çúb˜þë¹ísÿÐùŒ¿ÜÞÞþÓŸû}<ÄGú߽páÂûoܸñk¡ÍïzòÉ'ß®ã-!Þâ
ñšâµy ¯ yjggç�>øà/\ºté�azWˆßÞÚÚúøÆÆÆ_>|øaú•0X___Y[[{xqqéù………¤ŒVÒj…È—ÃüÜìlÒl†ˆÓÙf2¦Ùºl~v6Ÿf‘¯/¶7Ëm³sså|ØÞ¬lkö[ž¶Ü¯Ùs¾±½±NÛ‹ù…l~qq1Y]]½¯9\û×Ã=¸'ÄçŽ9òé'Nü~¸G8sæÌ¯îîî¾ý‘Gys¸�wŒŒŒH~ ü0�¤ÔëcRåâÅ‹w>ðÀï½ÿþû?¦²¹¹ù�«««ÿ±xp±µ°°põÀ�iò¦+q”'‚Ši³HåÛçææ^0æççËhu"Ì·æËù[G«˜oµ:ËVßqž}‹c÷8«ëœå|w»û—Ë„W%¹Ö•hëNºÍ…sÆ{âÆâââêÊÊÊW�?þ…'N|&ÄÃs¸ëäÉ“ïØÝÝýÙƒ¾^² x͉ÕR1ù±µµugˆ÷�:uê>ü×+++_Z^^žnµZ7›3ÉÌLˆF#iĘi¤Ë�™l}Z•4—Eš¨™/“Nùü�'æÿoÇÏ¿¸s×cöÿ§}ó³{ß»,¹Õy�ˆÏ$>›|}ØïÂÒòÒø¡C‡î‰ÏòNœøØ™3g>°½½ý®ëׯÿ\|æz> ðŠÐ©œº£Ýn¿5᝝¯tuuõo–——ï�ŸŸ_Ÿ››»+}f3I½^QKêµ�z%9•UÍ…é\^)5›%uÊÊ¡ÊpºælÏp¼f1/¯¾*—Ë*¬t¾º¾oßfwõV³ÿü³=ûvÜë;=ßìžçžíkSµ�ùÙlýl×u5‹áнíkvª²ºÚ>ÛeU[ed1_¶-K8fÉF£Þy¾ÙsíÜççæçZ¼gmmíÏ766~/ô‘÷œ?þçcµ�o ð²‰Õ4ÛÛÛo‰ïNÚÜÜüÈÑ£G?»´´ôÕùùù1‘Q«—É‹j4òjª´¢ªSÍyT*|šé¶|Ÿl9Vû4{öË÷iÎÌô¬oî}®žãºö)hýû6+ɵêöæLÙ¦¢}År³¿½·ˆêyŠöåËÍþkºÕµ¾`4_¸M]×]I^íuŸ²i3kwßñåqÍ™fºœVÐ5²
ºøükµz'jEÿÇÜœ››;¼¸¸xo¬â:~üø‡c‚+D|7×m¾y @—˜0ˆC¿b’ªÝnÿÑÆÆÆç———Gçææ‹I‡©éédjj*�é0Ÿ&õb¸_•„U>쬌Þå—3nýYõÎзþm3·>ÏÌKm÷ÞûÌüˆ×3óCŽ�yí™™iüï÷£þ"®ÑIl¥Uy�ÊZì_SÓSI-ô±f³yuqqñk¡/þíÉ“'?²µµõîøŸ#½ƒ ^û‰ªÛãp¿“'O¾mmí3ßüæ7¿ÜjµNÅäBLLMNN&S!&§&³dU-&«jYr"VUÕ³ižUÓtGw…Mº®38ÝÇÕÓ}Êùz±oû\qÚYî>v¯¶t¯«Ózy•Xåøl¹ÞÕö²š¬Ñ]]ÖÈ×5Š$^š¸)*Ïòu•j´=ÎÕØëÜ•{¼WÔ*m/†dm®¶»z͵l9ß·V9¾rŸóç�î·×sªÜß®6õõƒÊ³ÉÛÔužî¶Öêµ½¯5MœN¥}1öËÓa9ÞßÙÙÙãËËË_ZYYùãÍÍÍ÷ÅÿF©j ^eî¾ûîÛâ°¿ðÃþ®#GŽ|jiiéÞæÌÌ¥é©,I519‘LNL‰�¢²ªVË’V1ÂòtoÄíù~ér¹VÙ§Ö»®ˆÊñù9*çÍ�©uö©M׺Ž/[eR¤·�SñÃõLN–×—%æ¦Òkž1>>žEg¾X·WŽ)ŽKïÑd§Jh²¨šì$û&+ËåúÊ>ùrqÎÎ~S•édeßÉ©ò3:Ïi¢ÒÖ‰Þédv]]ÇWžm<÷Ôtö\§+÷´šxÜë^v=¿Î±µÞùÞ¾Ñ÷̦»Ï]It}86;¾wÿéÊ>ù}©>§xíq]½^ßžŸŸÿ÷ÕÕÕOž>}ú®øP± ¯ ñ…Ø×¯_G»ÝþðÆÆÆ¿,,,Ž@13::–Œ��É�<ÁS×zcº˜ŸîYΆ…¥15�VÑô_&>b#²Ø“̉ɛx-£££iÄùñãÙ4]ûÄs4:ÿ1¯xñxçeä+++ɱcÇ’ãÇ�'›››iϧaÝýœL|ðÁ䡇J®^½š\»v= ÷ö'»»»Éá-±M[[[]íî�ÕÕÕô¿2æ/ºÏ_Ìž½ƒª–ö�±±ìæ÷*½Ÿ�È×MN”‰¯¢¯’´,‡“Nw%”ºúÂt广`¿y1}1|NÜ/ï?}ýò™ÓY0¿®x=1AÖjµ–:ôùp?tñâÅ;Ã}|ƒ¿ ðcÒn·ï8{öì/;vìcñ¿»5�ñ{ü¡>:ÒIì¤U9ãY…ÊTV9”'°&:ÕWÝ‘&Š*•>e…V¹®¬hš(ÎSn›,*»&&&Ó˜œèÞ–U*•É‘ññ‰2‘Ú=<<œ
¥122’U)U*…8�&i>œFLD]¸p!¹zõJråòåäÊ•ËiÒé±ÇKž|òÉäé§ŸNž}æÙä™gžIãÙgŸM¾ÿýï'¯UÏ?ÿ|z�ùõ>æ¿ó�ï¤÷âñÇOvw¯…{t5¹ïU¸g;;;ɉ'Ò{yäÈ‘dmm- }*ÖûLZýžÓØØhö\†‡ÒgûXµ‚m²§b/ºúY¿ëÝVìÓSU–÷Éê±Õã‹~\ýìÉNâ.K|Æ~56:–ž+ô©«_^__ÿÄùóç%~·ü… €—(¾Ógww÷íñÖ+++_l6›—â�òÑð#<þÏ«�ò$P9¼,Z6>‘%²ÆÇóieè\_toKÏ‘·›èKçË¡véù;‰®üsòªž‘ѱ¢�#ÃÃiâ#osaŸ˜(YXXH#&Ob…ÑÙ³g“íííäâÎNòøO¤I¨§žz*�Þ¼ù\š€Š‰š<~Zýà?xÙΓßËxooÞ¼™&½žz*&