https://github.com/peterjclaw/fix8

Automatic fix for Python linting issues found by Flake8
https://github.com/peterjclaw/fix8

fixer linting python

Last synced: about 1 month ago
JSON representation

Automatic fix for Python linting issues found by Flake8

• Host: GitHub
• URL: https://github.com/peterjclaw/fix8
• Owner: PeterJCLaw
• Created: 2020-04-26T18:25:58.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-17T18:47:44.000Z (about 1 year ago)
• Last Synced: 2024-04-28T15:21:01.900Z (7 months ago)
• Topics: fixer, linting, python
• Language: Python
• Homepage:
• Size: 108 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Fix8

[![CircleCI](https://circleci.com/gh/PeterJCLaw/fix8.svg?style=svg)](https://circleci.com/gh/PeterJCLaw/fix8)

Automatic fix for Python linting issues found by [Flake8](https://flake8.pycqa.org/).

## Fixes

* `F401`: Unused imports are removed. (If doing so would create a blank line at

  the start of the file then the next line is also removed).

* `C812`, `C813`, `C814`, `C815`, `C816`: Trailing commas are added

* `FA100`: Future annotation imports are added.

* `LBL001`: Leading blank lines are removed.

## Install

``` bash

pip install fix8

```

## Configuration

Fix8 will only fix issues that flake8 finds, so your existing flake8 configuration

(including which plugins you have installed) will determine what gets fixed.

## Usage

`fix8` wraps `flake8`, so takes the same arguments. The easist way to use it is

to pass the files or directories you want fixed directly to it:

``` bash

fix8 project/ that.py this.py

```

### Wrappers

If you have a large project you may want to wrap it, something like this:

``` bash

fix8-local() {

    git diff --name-only --diff-filter=d | grep '\.py$' | sort --unique | xargs --no-run-if-empty fix8

}

```

This can be paired with `isort` to do both fixes with a single command:

``` bash

# Put these functions in your `.bashrc` or similar

run-py-local() {

    git diff --name-only --diff-filter=d | grep '\.py$' | sort --unique | xargs --no-run-if-empty "$@"

}

fix8-local() {

    run-py-local fix8 && run-py-local isort

}

# Usage is then just this, but will detect and fix any changes that might need fixing

$ fix8-local

```