Pythonのコーディング規約を現役エンジニアが解説【初心者向け】

初心者向けにPythonのコーディング規約について解説しています。コーディング規約とは、色々な書き方が出来るプログラミング言語において、統一の書き方を決めることです。コードの規模が大きくなったり複数人開発が必要になった場合に必要になります。今回はPython公式のPEP8について確認してみます。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。

Pythonのコーディング規約について解説します。

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

コーディング規約について詳しく説明していくね!

大石ゆかり

お願いします!

 

コーディング規約とは

コーディング規約とは、プログラムのコーディングにおける指針、ガイドラインのことです。一般に、企業、コミュニティ、製品といった単位でコーディング規約を定めます。

コーディング規約では変数名や関数名などの命名規則や、ファイル中でのレイアウトなど、様々な規則を定めます。

コーディング規約を定める目的は、コードの可読性や保守性を向上し、バグを抑止することです。

コーディング規約への準拠を目視で確かめるのは大変です。統合開発環境(IDE)やエディタがコーディング規約に従うように補佐したり、コーディング規約に従っているか点検するチェッカー(lint)を用いるのが一般的です。

 

公式コーディング規約のPEP8、その他のコーディング規約

PEP8はPythonの公式コーディング規約で、ここで公開されています。

PEP8では、「コードは書かれる頻度よりも、読まれる頻度が高い」という考え方が根底にあります。PEP8は、Pythonコード全般の可読性を向上させ、一貫したスタイルを提供することを目的としています。

PEP8以外では、Google Python Style Guideが有名です。ソフトウェアの特性にあわせてPEP8を拡張したもので、PylonsやDjangoの規約があります。

[PR] Pythonで挫折しない学習方法を動画で公開中

PEP8の主なルール

はじめにpep8モジュールをインストールしました。

pip install pep8

サンプルとして、以下sample.pyを用いました。このファイルには「インデントにタブを用いている」というPEP8違反があります。

def func():
	a = b + c

pep8を実行しました。–show-sourceオプションで違反のある箇所のソースコードも表示するようにしました。

 

$ pep8 --show-source sample.py
sample.py:2:1: W191 indentation contains tabs
        a = b + c
^

ソースコードを以下のように修正しました。(インデントに半角スペース4個を使うようにしました)

def func():
    a = b + c

再度pep8を実行しました。今度は何も表示されず、違反の解消されたことがわかりました。

$ pep8 --show-source sample.py

 

監修してくれたメンター

橋本紘希

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間でPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。