読みやすいPythonコードを書こうトップページに戻る読みやすいPythonコードを書こうはじめに¶Pythonは可読性の高い言語だとよく言われます。インデントが強制されることで、分岐や繰り返し、関数のスコープなどが一目見ただけでわかるようになっています。言語の特性上、非常に柔軟な書き方ができるため、目的の動作を実現することが簡単にコードに表現することができます。これらの言語特性が裏目に出て、次のようなコードを量産する可能性もあります。書けたけど、後日振り返ってみると読めない他の人が書いたPythonコードが全然読めないこのページでは、読みやすいPythonコードを書くためにはどうしたら良いか?ということを、私なりにまとめてみようと思います。公式のスタイルガイドが書かれています。重要な洞察のひとつに、コードは書くよりも読まれることの方が多い、というものがあります。この文書で示すガイドラインの目的は、コードを読みやすくするとともに、Pythonで書かれた幅広いコードのスタイルを一貫させることです。さんは、Pythonの生みの親です。導入してしまう人がいます(昔の自分)。後日読み直してみると、何をやっていたか理解できない・・・。(あるある一週間後の自分ですら他人だと思ったほうが良いです。スタイルガイドに沿った可読性を意識した優れたPythonコードを書くようにしてください。このスタイルガイドを一つずつ例を挙げて読んでいくことにします。カッコの中身が長いときの改行の位置にも気をつけましょう。some_energy)インポート¶ファイルの先頭にずらっと並びがちなライブラリのインポートの文も見やすくしましょう。空白文字(スペース)を入れる場所によって、可読性が大きく変わってきます。統一するようにしましょう。)リストのスライスの指定も空白文字を入れる位置に気をつけましょう。読まれないと確信していなければ、コメントを英語で書くようにお願いします。コメントを書くようにしましょう。pycodestyle¶このようなスタイルを自動的にチェックしてくれるライブラリが作られています。pycodestyle慣れてくると、わざわざ調べなくても通るコードが書けてきますが、最初のうちはなるべくチェックして感覚を身につけましょう。your-file.pyフォルダに対しても実行できます。folder/実装の複雑度も測ってくれます。複雑な関数は直しましょう。CodeといったエディタにPEP8のスタイルチェックをしてくれる拡張機能を追加しておくと大変便利です。Spyderといったエディタにはデフォルトでチェックする機能がついているので、ぜひ有効にして見てください。お気軽にご連絡ください。