Skip to main content

`shed` canonicalises Python code.

Project description

shed

shed canonicalises Python code. Shed your legacy, stop bikeshedding, and move on. Black++

What does it do?

shed is the maximally opinionated autoformatting tool. It's all about convention over configuration, and designed to be a single opinionated tool that fully canonicalises my code - formatting, imports, updates, and every other fix I can possibly automate.

There are no configuration options at all, but if the defaults aren't for you that's OK - you can still use the underlying tools directly and get most of the same effect... though you'll have to configure them yourself.

shed must either be run in a git repo to auto-detect the files to format, or explicitly passed a list of files to format on the command-line.

Features

shed...

  • Runs autoflake, to remove unused imports and variables
  • Runs pyupgrade, with autodetected minimum version >= py36
  • Runs isort, with autodetected first-party imports and --ca --profile=black args
  • Runs black, with autodetected minimum version >= py36
  • Runs custom refactoring logic using libcst
  • Formats code blocks in docstrings, markdown, and restructured text docs (like blacken-docs).
  • If shed --refactor, also runs pybetter to fix some style issues, teyit to update deprecated unittest methods, and com2ann to convert type comments to annotations.

The version detection logic is provided by black. Because shed supports the same versions of Python as upstream, it assumes that the minimum version is Python 3.6.

If you run shed in a Git repository, the name of the root directory is assumed to be a first-party import. src layout packages are also automatically detected, i.e. the foo in any paths like .../src/foo/__init__.py.

Jupyter Notebook support

We recommend using jupytext to save your notebooks in .py or .md files, in which case shed supports them natively. For a quick-and-dirty workflow, you can use nbqa shed notebook.ipynb - nbqa works for any linter or formatter.

Using with pre-commit

If you use pre-commit, you can use it with Shed by adding the following to your .pre-commit-config.yaml:

minimum_pre_commit_version: '2.9.0'
repos:
- repo: https://github.com/Zac-HD/shed
  rev: 0.5.3
  hooks:
    - id: shed
      # args: [--refactor, --py39-plus]
      types_or: [python, markdown, rst]

This is often considerably faster for large projects, because pre-commit can avoid running shed on unchanged files.

See also

shed inherits pyupgrade's careful approach to converting string formatting code. If you want a more aggressive refactoring tool and don't mind checking for breaking changes, check out flynt.

Changelog

Patch notes can be found in CHANGELOG.md.

Project details


Download files

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

Source Distribution

shed-0.5.3.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

shed-0.5.3-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file shed-0.5.3.tar.gz.

File metadata

  • Download URL: shed-0.5.3.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for shed-0.5.3.tar.gz
Algorithm Hash digest
SHA256 b544c74c7c3241392b8640820a46da4ae78328ed4da45a4134ac1cb838320ec9
MD5 d9ae3e8d6538909c7a619a4c07946d88
BLAKE2b-256 f989513557cd058bb29913b5cee67aa1e4a20b9e9ab31d9dfd58227ea010aa0e

See more details on using hashes here.

Provenance

File details

Details for the file shed-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: shed-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for shed-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a42312d8aac4b45202c10eb2f5ca7f93b600013009fdb9bff286bb090cc28fd4
MD5 3a3b53aae9845cb71a009a9485db9249
BLAKE2b-256 17751aadd51372b54e02d9785289269898041db23a4cecf6682ad029d3578ea8

See more details on using hashes here.

Provenance

Supported by

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