PEP 8はPython Enhancement Proposal（Python改善提案）の略で、Pythonコードを書く際のスタイルガイドです。（日本語版公式ドキュメント）この文書はPythonのコア開発チームによって作成され、Pythonコミュニティ全体で広く受け入れられています。PEP 8の主な目的は、Pythonコードの読みやすさと一貫性を向上させることです。PEP 8スタイルガイドに従うことで、開発者間の理解を深まりコードの可読性が高くなります。ここでは、PEP 8の主要な規則をサンプルコードと共に紹介し、それぞれの重要性について詳しく解説します。
インデント：スペース4つ
PEP 8では、スペース4つを使ってインデントすることが推奨されます。これにより、コードの階層構造が明確になり、読みやすくなります。
誤った例：
def some_function():
print("Hello, World!")
正しい例：
def some_function():
print("Hello, World!")
行の長さ：79文字
行の長さを79文字以内に保つことで、コードは読みやすくなり、横スクロールの必要性が減ります。
誤った例：
def some_function(): print("This is a very long line of code that is definitely going to exceed the recommended limit of 79 characters")
正しい例：
def some_function():
print("This is a very long line of code that is definitely going to "
"exceed the recommended limit of 79 characters")
インポート：分離して書く
インポートはファイルの先頭に記述し、標準ライブラリ、サードパーティライブラリ、ローカルライブラリごとにグループを分けて、それぞれのグループを空行で区切ります。
誤った例：
import sys, os
正しい例：
import os
import sys
空白の使用
不要な空白は避け、コードを簡潔に保ちます。括弧の内側、カンマの後、演算子の前後に適切な空白を使用することが重要です。
誤った例：
spam( ham[ 1 ], { eggs: 2 } )
正しい例：
spam(ham[1], {eggs: 2})
コメント：有益であること
コメントはコードが何をするのかではなく、なぜそうするのかを説明すべきです。また、完全な文で記述し、読み手が理解しやすいようにすることが重要です。
誤った例：
# This function prints a message.
def print_message():
print("Hello, World!")
正しい例：
def print_message():
# This function demonstrates printing a simple message
print("Hello, World!")
命名規則
クラス名はCapWords規則に従い、関数名や変数名はlowercase_with_underscoresを使用します。これにより、コード内での要素の種類を容易に区別できます。
クラス名：
class MyClass:
pass
関数名と変数名：
def my_function():
my_variable = 0
return my_variable
式と文のスペース
演算子の前後に適切なスペースを使用し、コードをより読みやすくします。
誤った例：
x=1+2
正しい例：
x = 1 + 2
まとめ
ここまで、PEP8の基本的なルールをまとめました。ただし、特定のプロジェクトのルールやチームの合意がある場合は、それらを優先することが重要です。PEP 8はガイドラインであり、絶対的なルールではありません。主な目的は、コードの品質とコラボレーションの容易さを高めることにあります。
PEP8のような規約は、一人で書いているうちは効果が実感しにくく、コードを見てもらって初めて意味がわかる部分があります。書いたものにレビューをもらいながら書き方を固めていく、という進め方もあります。
AIプログラミングスクール「SiiD」について
AIプログラミングスクール「SiiD」は、未経験からITエンジニア転職を目指す方向けのオンラインスクールです。
SiiDの特徴
- 現役エンジニアでYouTube登録者約13万人の「セイト先生」が代表兼主任講師
- 採用側の実務知見（2,000人以上の選考・150名以上のエンジニア採用）にもとづく指導
- 生成AIを取り入れた学習設計と、実務レベルのフルスタックWeb開発スキル
- Workship CAREER（株式会社GIG）と連携した無料の転職伴走支援
- 経済産業省認定のReスキル講座で、給付金の条件を満たせば実質105,600円〜
- 学割あり（35%オフ）
こんな方におすすめ
- 未経験・文系・社会人からITエンジニア転職を本気で目指したい方
- 独学に限界を感じている方
- 費用を抑えながら実務スキルと転職サポートを両立したい方
「未経験だから」とあきらめる必要はありません。採用する側を知り尽くしたプロが、給付金で負担を抑えながら内定まで伴走します。
