Pythonの環境構築について

Transcript

1. Python の環境構築が 自分には難しすぎた のでどうすればいいか 考えた 原口　昌也
2. なんかよくわかんないな〜 難しいな〜って思ってたこと
3. ズバリ...! リンターとフォーマッターの設定 方法についてです！！
4. 初心者には難しすぎる！！！
5. わかりづらポイント 1 管理するものが多い！ 覚えることが多い！
6. とあるrepoで使用していた リンターとフォーマッターがこちら
7. 名前 種別 用途 flake8 リンター PEP8というコーディングガイドに基づいて注意をしてくれる mypy リンター メソッドとかに型ヒントを書いてないと注意してくれる。 静的型チェックてやつができる black フォーマッター PEP8に基づいてフォーマットしてくれる isort フォーマッター import 文を標準、外部、ローカルライブラリの３段階に自動で 分けてabc順に並べてくれるやつ これらは全部 pipとかpoetry addでインストールできます そこは簡単、便利！だけど。。
8. これらの４つのツールには 全部わかりづらポイント があ ります！！
9. 名前 わかりづらポイント ファイル名 設定の書き方 flake8 - 1行の文字数がデフォルト79文字 - これだけpyproject.tomlに対応していな い .flake8 [flake8] exclude = .git, .gitignore, __pycache__, .venv, .env max-line-length = 119 extend-ignore = mypy 設定ファイルでstrict=trueにしないと 型ヒントを書かなくても警告してくれない のであんまり意味がない pyproject.toml [tool.mypy] strict = true black デフォルトの1行の文字数が88文字 なのでflake8と競合する pyproject.toml [tool.black] line-length = 119 isort デフォルトの1行の文字数はflake8と同じ く79文字 blackと競合する。そしてプロパティの書き 方がblackと合わせます〜みたいな感じ でさらに混乱 pyproject.toml [tool.isort] profile = "black"
10. わかりづらポイント 2 flake8はpyproject.tomlで管理できな いんだ〜(φ(._.*)ﾒﾓﾒﾓ とか思ってたら pyproject-flake8というライブラリ 入れて一緒に管理するパターンもあるこ と
11. わかりづらポイント 3 人は皆リンターフォーマッターを VSCodeでファイル保存時に自動適用 さ せるようにしたいと思うはず。 なのでsettings.jsonの書き方も知る必 要があること
12. わかりづらポイント 4 一生懸命設定した VSCodeの設定が 2023年9月のアップデートで いつの間にか使えなくなってたこと
13. python環境 flake8 black isort mypy VSCode Pythonファイル いままで
14. VSCode拡張 flake8 black isort mypy VSCode flake8 black isort mypy があらかじめ入ってる 拡張をインストールするこ とで有効になる Pythonファイル python環境 flake8 black isort mypy このことを知らないと VSCodeでflake8拡張をvscodeにレコメン ドされた時に「 pipで入れたやつ使ってくれ ないの？」と悩むことになる いま python環境に インストール不要になった！
15. わかりづらポイント 5 pyproject.tomlに書いた方が絶対にい いのに settings.jsonに リンターフォーマッター の詳細な設定を書けてしまうこと！
16. わかりづらポイント 6 VSCodeの 「ユーザー settings.json」と 「ワークスペース settings.json」の 親子関係を理解してないとつまづくこと
17. わかりづらポイント 7 setting.json とファイル名を間違えた時 誰も教えてくれないこと（４時間無駄にし たこと）
18. これらのことを把握するのが 初心者には大変すぎる！
19. リンターフォーマッターの設定を もう少し簡単にする方法を教えます！
20. 新ツール Ruffを使いましょう！
21. Ruffの導入 導入前 導入後 flake8 Ruff isort black mypy mypy
22. メリット1 3つのツールを１つに統合できる
23. メリット2 Rustで書かれており 10倍くらい高速になってる
24. VSCodeでの インストール方法
25. Ruff拡張をインストール
26. settings.json { "[python]": { // 保存したときにフォーマットする "editor.formatOnSave": true, // デフォルトフォーマッターの設定 "editor.defaultFormatter": "charliermarsh.ruff", "editor.codeActionsOnSave": { //always->保存されたときにアクションを実行 "source.organizeImports.ruff": "always", // explicit->保存、ウインドウ変更、フォーカス変更時にアクションを実行。 "source.fixAll.ruff": "explicit", } }, "ruff.format.args": [ "--config=${workspaceFolder}/pyproject.toml" ], "mypy-type-checker.args" :["--config-file=${workspaceFolder}/pyproject.toml"] }
27. pyproject.toml[tool.ruff] target-version = "py312" # pythonのバージョン line-length = 119 # 1行の文字数 indent-width = 4 # インデントサイズ # blackformatの設定 [tool.ruff.format] quote-style = "double" docstring-code-format = true [tool.ruff.lint] # 実は.venvはデフォルトで有効になってるから設定不要 ignore = [".venv/", ] select = [ "F", # Flake8 "I", # isort "E", # error "W" # warning ] [tool.mypy] strict = true
28. これで ３つのツールが ひとつにまとまりました！ 多分ちょっとわかりやすくなったと思 います！
29. 今回紹介した ruffの設定方法はこちらの repoにも まとめましたので 気になったらみてください！ https:/ /github.com/curicle/dev-toolbox
30. まとめ リンターフォーマッターの設定が難しすぎる！ Ruffを使おう！！
31. おしまい