St_Hakky’s blog

Data Science / Human Resources / Web Applicationについて書きます

Pythonにおけるコーディングスタイルまとめ

Python Atom

こんにちは。

pythonのコーディングスタイルについて調べてみたのでまとめました。

○コーディングスタイルでやりたいこと

コーディングスタイル(なんていうめんどくさいのもの)を考えてやりたいことは幾つかありますが、以下のところかと思います。

  • 複数人でコードを書くときに書き方が統一されて可読性が増す
  • 一度きめてさえしまえば宗教戦争も起こらない
  • コーディング規約によっては自動化できる部分もあり、わりと楽に我流よりは綺麗なコードがかける

〇pep 8 => pycodestyle

コーディング規約としては有名なPEP8ですが、なんかわかりませんがpycodestyleにかわっています。ので、一応書いておきます。

Please rename this tool · Issue #466 · PyCQA/pycodestyle · GitHub

○スタイルガイドまとめ

代表的なスタイルガイドをまとめてみました。

■PEP 8 | pycodestyle

PEP 8 -- Style Guide for Python Code | Python.org

■Google Python Style Guide

Google Python Style Guide

■OpenStack Style Guidelines

OpenStack Docs: hacking: OpenStack Hacking Guideline Enforcement

■Example NumPy Style Python Docstrings

Example NumPy Style Python Docstrings — napoleon 0.6.0 documentation

○自動整形

こういうスタイルガイドを全部覚えてそれ通りにコーディングするというのもなくはないが、正直学習コストが高いしどうせ間違えるので無駄かなと(笑)

コマンドラインから変換するには以下のサイトで紹介されているツールがよさそう。

wonderwall.hatenablog.com

別にコマンドラインでも良いかもだけど上のサイトでも紹介されている通り各種エディターと連携させて、コーディング規約に準拠していない場合はWarningを出すみたいなこともできるので、これが一番おすすめ。

私は、Atomを使っているので、pep8に自動で変換することもできるようにしている。導入方法は以下の記事が参考になる。

qiita.com

それでは。

〇参考