Automatic code formatting
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 493
- PR merge metrics
- No merged PRs in 30d
Description
We want something like gofmt for python. We want to minimize changes to existing code while defining a style we agree to. Ideally it should automatically format files on save (PyCharm integration would be great) and/or as a precommit hook.
One option: https://github.com/google/yapf
From @eukreign on Slack:
but to elegantly switch to yapf would require:
- defining a new config that's as close to current code as reasonable
- running the converter and adding a comment to any datastructure that is uglified by yapf
whoever takes on this project should be willing to carefully skim through the changes yapf makes to make sure it's not uglier (at least not too much uglier) than before
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by evaluating YAPF against the repository's existing Python style and reviewing the proposed configuration options. Compare its converted output carefully, especially data structures that become less readable, and assess PyCharm-on-save and pre-commit integration. Done means an agreed configuration, reviewed formatting changes, and a documented integration path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100