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.