lbryio/lbry-sdk

Automatic code formatting

Open

#3,199 创建于 2021年2月16日

在 GitHub 查看
 (6 评论) (0 反应) (0 负责人)Python (7,220 star) (500 fork)batch import
area: othergood first issuehelp wantedlevel: 1type: improvement

描述

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:

  1. defining a new config that's as close to current code as reasonable
  2. 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

贡献者指南

技术栈
python
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Pythonyapf
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
The issue suggests using yapf for Python code formatting. The contributor should first define a yapf configuration that closely matches the current code style, then run the formatter on existing code and review changes for ugliness. Additionally, explore PyCharm integration and precommit hooks. Engage with maintainers for configuration approval.