Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asottile/add-trailing-comma
A tool (and pre-commit hook) to automatically add trailing commas to calls and literals.
https://github.com/asottile/add-trailing-comma
linter pre-commit python
Last synced: about 16 hours ago
JSON representation
A tool (and pre-commit hook) to automatically add trailing commas to calls and literals.
- Host: GitHub
- URL: https://github.com/asottile/add-trailing-comma
- Owner: asottile
- License: mit
- Created: 2017-07-10T00:55:50.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T01:22:49.000Z (about 2 months ago)
- Last Synced: 2024-12-05T22:01:16.974Z (7 days ago)
- Topics: linter, pre-commit, python
- Language: Python
- Size: 365 KB
- Stars: 344
- Watchers: 5
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-code-formatters - add-trailing-comma
- awesome-python-ast - add-trailing-comma - A tool (and pre-commit hook) to automatically add trailing commas to calls and literals. (Other)
- best-of-python-dev - GitHub
README
[](https://github.com/asottile/add-trailing-comma/actions/workflows/main.yml)
[](https://results.pre-commit.ci/latest/github/asottile/add-trailing-comma/main)
add-trailing-comma
==================
A tool (and pre-commit hook) to automatically add trailing commas to calls and
literals.
## Installation
```bash
pip install add-trailing-comma
```
## As a pre-commit hook
See [pre-commit](https://github.com/pre-commit/pre-commit) for instructions
Sample `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/asottile/add-trailing-comma
rev: v3.1.0
hooks:
- id: add-trailing-comma
```
## multi-line method invocation style -- why?
```python
# Sample of *ideal* syntax
function_call(
argument,
5 ** 5,
kwarg=foo,
)
```
- the initial paren is at the end of the line
- each argument is indented one level further than the function name
- the last parameter (unless the call contains an unpacking
(`*args` / `**kwargs`)) has a trailing comma
This has the following benefits:
- arbitrary indentation is avoided:
```python
# I hear you like 15 space indents
# oh your function name changed? guess you get to reindent :)
very_long_call(arg,
arg,
arg)
```
- adding / removing a parameter preserves `git blame` and is a minimal diff:
```diff
# with no trailing commas
x(
- arg
+ arg,
+ arg2
)
```
```diff
# with trailing commas
x(
arg,
+ arg2,
)
```
## Implemented features
### trailing commas for function calls
```diff
x(
arg,
- arg
+ arg,
)
```
### trailing commas for tuple / list / dict / set literals
```diff
x = [
- 1, 2, 3
+ 1, 2, 3,
]
```
### trailing commas for function definitions
```diff
def func(
arg1,
- arg2
+ arg2,
):
```
```diff
async def func(
arg1,
- arg2
+ arg2,
):
```
### trailing commas for `from` imports
```diff
from os import (
path,
- makedirs
+ makedirs,
)
```
### trailing comma for class definitions
```diff
class C(
Base1,
- Base2
+ Base2,
):
pass
```
### trailing comma for with statement
```diff
with (
open('f1', 'r') as f1,
- open('f2', 'w') as f2
+ open('f2', 'w') as f2,
):
pass
```
### trailing comma for match statement
```diff
match x:
case A(
1,
- 2
+ 2,
):
pass
case (
1,
- 2
+ 2,
):
pass
case [
1,
- 2
+ 2,
]:
pass
case {
'x': 1,
- 'y': 2
+ 'y': 2,
}:
pass
```
### trailling comma for PEP-695 type aliases
```diff
def f[
- T
+ T,
](x: T) -> T:
return x
```
```diff
class A[
- K
+ K,
]:
def __init__(self, x: T) -> None:
self.x = x
```
```diff
type ListOrSet[
- T
+ T,
] = list[T] | set[T]
```
### unhug trailing paren
```diff
x(
arg1,
- arg2)
+ arg2,
+)
```
### unhug leading paren
```diff
-function_name(arg1,
- arg2)
+function_name(
+ arg1,
+ arg2,
+)
```
### match closing brace indentation
```diff
x = [
1,
2,
3,
- ]
+]
```
### remove unnecessary commas
yes yes, I realize the tool is called `add-trailing-comma` :laughing:
```diff
-[1, 2, 3,]
-[1, 2, 3, ]
+[1, 2, 3]
+[1, 2, 3]
```