Safe, atomic formatting with black and µsort
Project description
µfmt
Safe, atomic formatting with black and µsort
µfmt is a safe, atomic code formatter for Python built on top of black and µsort:
Black makes code review faster by producing the smallest diffs possible. Blackened code looks the same regardless of the project you’re reading.
μsort is a safe, minimal import sorter. Its primary goal is to make no “dangerous” changes to code, and to make no changes on code style.
µfmt formats files in-memory, first with µsort and then with black, before writing any changes back to disk. This enables a combined, atomic step in CI/CD workflows for checking or formatting files, without any chance of conflict or intermediate changes between the import sorter and the code formatter.
Install
µfmt requires Python 3.8 or newer. You can install it from PyPI:
$ pip install ufmt
If you want to prevent unexpected formatting changes that can break your CI workflow, make sure to pin your transitive dependencies–including black, µsort, and µfmt–to your preferred versions.
If you use requirements.txt, this might look like:
black==22.6.0
ufmt==2.0.0
usort==1.0.4
Usage
To format one or more files or directories in place:
$ ufmt format <path> [<path> ...]
To validate files are formatted correctly, like for CI workflows:
$ ufmt check <path> [<path> ...]
To validate formatting and generate a diff of necessary changes:
$ ufmt diff <path> [<path> ...]
Integrations
See the user guide for details on each integration.
GitHub Actions
µfmt provides a GitHub Action that can be added to an existing workflow, or as a separate workflow or job, to enforce proper formatting in pull requests:
jobs:
ufmt:
runs-on: ubuntu-latest
steps:
- uses: omnilib/ufmt@action-v1
with:
path: <PATH TO CHECK>
requirements: requirements-fmt.txt
python-version: "3.x"
pre-commit hook
µfmt provides a pre-commit hook. To format your diff before
every commit, add the following to your .pre-commit-config.yaml file:
- repo: https://github.com/omnilib/ufmt
rev: v2.0.0
hooks:
- id: ufmt
additional_dependencies:
- black == 22.6.0
- usort == 1.0.4
Visual Studio Code
µfmt has an official VS Code extension to use µfmt as a formatter for Python files. Once installed, µfmt can be set as the default formatter with the following settings:
"[python]": {
"editor.defaultFormatter": "omnilib.ufmt"
}
µfmt can automatically format when saving with the following settings:
"[python]": {
"editor.defaultFormatter": "omnilib.ufmt",
"editor.formatOnSave": true
}
For more details, or to install the extension, see the Visual Studio Marketplace page:
License
ufmt is copyright Amethyst Reese, and licensed under
the MIT license. I am providing code in this repository to you under an open
source license. This is my personal repository; the license you receive to
my code is from me and not from my employer. See the LICENSE file for details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ufmt-2.6.0.tar.gz.
File metadata
- Download URL: ufmt-2.6.0.tar.gz
- Upload date:
- Size: 75.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8d6e520699455cd2ff2714640c16af2ae8f305a747e17524b44625038ca41226 |
|
| MD5 | 152d1dff9f49b21088072f34c95f82f7 |
|
| BLAKE2b-256 | a99afe5fa93f371afa73659b3e52efda788d8d64fe6d0b811fb858b8b0fa26de |
File details
Details for the file ufmt-2.6.0-py3-none-any.whl.
File metadata
- Download URL: ufmt-2.6.0-py3-none-any.whl
- Upload date:
- Size: 26.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d9be63ab9d7e4d7cbce7394f3ec7859148b655b4c75f4dd694a141c4cb953491 |
|
| MD5 | ca224b85369c35b593cf89858f362a7a |
|
| BLAKE2b-256 | a3722f54653dac5050cff27b5ae5b2d4eb1b14624c344961d8aabf6d36ec430b |
