プログラミングにおいて、命名規則はコードの可読性やメンテナンス性を大きく左右します。
可読性の高いコードは、他の開発者が理解しやすくなり、エラーの発見や修正が容易になります。それにより、メンテナンス性も向上します。
この記事では、Pythonの命名規則について解説し、コードの品質を向上させるためのヒントを提供します。
Pythonを勉強する時、何から勉強するか分からず、挫折します。初心者でも、中級者でも、レベルに合わせた勉強方法を分かりやすくまとめています。
命名規則の基本：PEP 8とは
Pythonには、コーディング規約としてPEP 8があります。PEP 8は、Pythonのコードを書く際に従うべきガイドラインを提供し、命名規則も含まれています。
PEP 8の特徴
PEP 8の特徴は以下の通りです。
- 可読性: PEP 8は、コードの可読性を向上させるためのガイドラインを提供しています。
- 一貫性: PEP 8に従うことで、Pythonコミュニティ全体で一貫したコーディングスタイルが維持されます。
- インデント: PEP 8では、インデントに4つのスペースを推奨しています。
- 改行: PEP 8では、1行の最大文字数は79文字以内とすることが推奨されています。
- 空白: PEP 8では、不要な空白の使用を避けることが推奨されています。
- 命名規則: PEP 8では、変数名、関数名、クラス名などの命名規則が定められています。
- インポート: PEP 8では、インポートの順序やグループ化が指定されています。
PEP 8の導入メリット
PEP 8の導入メリットは以下の通りです。
- 一貫性のあるコード: PEP 8に従うことで、コードベース全体で一貫性のあるスタイルが維持され、新しい開発者が迅速にコードを理解できます。
- 可読性の向上: PEP 8が提供する規則に従うことで、コードの可読性が向上し、バグの発見や修正が容易になります。
- コラボレーションの効率向上: PEP 8に従うことで、チームメンバー間のコードの理解が容易になり、効率的なコラボレーションが可能になります。
- コードの品質向上: PEP 8のガイドラインに従うことで、コードの品質が向上し、メンテナンスや拡張が容易になります。
Pythonコミュニティでの採用状況
PEP 8は、Pythonコミュニティに広く受け入れられているコーディング規約です。
多くのPythonプロジェクトでは、PEP 8を基本とした命名規則が適用されています。また、オープンソースプロジェクトや企業の内部プロジェクトでも、PEP 8に準拠したコーディングが推奨されることが多いです。
さらに、Python関連の書籍やチュートリアルでも、PEP 8の命名規則が紹介されており、初学者にも習得しやすいです。
型ヒント：コードの型安全性を向上させる
型ヒントは、Python 3.5以降で導入された機能で、変数や関数の引数・戻り値に対して型を示唆するアノテーションです。
型ヒントを使うことで、コードの可読性を向上させるだけでなく、型チェッカーを利用して型安全性を確認できます。
Pythonは動的型付け言語であるため、型ヒントは必須ではありませんが、コードの品質向上や他の開発者とのコミュニケーションを円滑にするために積極的に利用されることが推奨されます。
関数と変数の型アノテーション
型ヒントを使用するには、関数の引数や戻り値、変数に対してアノテーションを追加します。
以下は型ヒントを用いたサンプルコードです。
from typing import List, Tuple, Optional
def greet(name: str) -> str:
# 文字列型の引数 "name" を受け取り、文字列型の値を返す関数 "greet" を定義
return f"Hello, {name}!"
def add_numbers(a: int, b: int) -> int:
# 整数型の引数 "a" と "b" を受け取り、整数型の値を返す関数 "add_numbers" を定義
return a + b
def find_even_numbers(numbers: List[int]) -> List[int]:
# 整数型のリスト "numbers" を受け取り、整数型のリストを返す関数 "find_even_numbers" を定義
return [num for num in numbers if num % 2 == 0]
def divide(a: float, b: float) -> Optional[float]:
# 浮動小数点型の引数 "a" と "b" を受け取り、浮動小数点型かNone型の値を返す関数 "divide" を定義
if b == 0: # ゼロ除算を回避
return None
return a / b
def get_name_and_age() -> Tuple[str, int]:
# 文字列型と整数型のタプルを返す関数 "get_name_and_age" を定義
return "Alice", 30
# サンプルの実行
print(greet("John")) # 出力: Hello, John!
print(add_numbers(3, 4)) # 出力: 7
print(find_even_numbers([1, 2, 3, 4, 5, 6])) # 出力: [2, 4, 6]
print(divide(9, 3)) # 出力: 3.0
print(divide(9, 0)) # 出力: None
print(get_name_and_age()) # 出力: ('Alice', 30)このサンプルコードでは、関数の引数と戻り値に型ヒントを追加しています。これにより、関数がどのようなデータ型を受け取り、どのようなデータ型を返すかが明確になり、コードの可読性が向上します。
型チェッカーの利用
型チェッカーは、型ヒントを使ってコードの型安全性を検証するツールです。
代表的な型チェッカーには、mypyやPyrightがあります。型チェッカーを利用することで、実行前に型エラーを検出でき、バグの発生を防ぐことができます。
例えば、mypyをインストールして型チェックを行う場合、以下のコマンドを実行します。
pip install mypy
mypy your_script.py型チェッカーが型エラーを検出すると、エラーメッセージが表示されます。これにより、コードの品質を向上させることができます。
自動フォーマッター：コードスタイルを統一する
自動フォーマッターは、Pythonコードのスタイルを自動的に整形し、統一感のあるコードを作成するツールです。
autopep8とblackの紹介
主な自動フォーマッターには、autopep8とblackがあります。
- autopep8：PEP 8に準拠したコードスタイルに整形するツールです。設定でカスタマイズが可能で、コードをPEP 8に適合させたい場合に便利です。
- black：独自のコーディングスタイルを適用し、コードを整形するツールです。Blackはコードの一貫性を重視しており、カスタマイズはあまりできませんが、コードが統一感のあるものになります。
autopep8とblackの違いをまとめると、以下の通りです。
| 機能 | autopep8 | black |
|---|---|---|
| 目的 | PEP 8準拠のコード整形 | 一貫したスタイルのコード整形 |
| 設定の柔軟性 | 多くの設定オプションが利用可能 | 設定オプションが限定されている |
| インデント | PEP 8準拠の4スペースインデント | PEP 8準拠の4スペースインデント |
| 最大行長 | デフォルトで79文字（PEP 8準拠） | デフォルトで88文字 |
| コード変更 | コードの変更範囲を最小限に抑える | 大胆なコード変更が行われることがある |
| 適用範囲 | 個別のPEP 8ルールを選択的に適用可能 | 一貫したスタイルが全体に適用される |
どちらのツールを使用するかは、プロジェクトやチームのニーズに応じて選択してください。
自動フォーマッターの利点
自動フォーマッターを使用する利点は以下の通りです。
- コードの可読性が向上し、チーム開発が容易になります。
- 手動でコードスタイルを修正する手間が省けます。
- コードレビューでスタイルに関する指摘が減り、本質的な問題に集中できます。
開発フローへの組み込み
自動フォーマッターを開発フローに組み込むことで、開発効率が向上します。
例えば、Gitのpre-commitフックに自動フォーマッターを追加すると、コミット前にコードを自動的に整形できます。
autopep8とBlackのインストールと基本的な使い方は以下の通りです。
autopep8のインストールと使用方法
pip install autopep8
autopep8 --in-place --aggressive --aggressive your_script.pyBlackのインストールと使用方法
pip install black
black your_script.py自動フォーマッターを使用することで、Pythonコードの可読性と効率性が向上し、可読性の高いコーディングが実現できます。
静的解析ツール：コード品質を向上させる
静的解析ツールは、コードを実行せずに解析して、品質や潜在的な問題を検出するツールです。
pylintやflake8の紹介
主なPythonの静的解析ツールには、pylintとFlake8があります。
- pylint：Pythonコードの様々な品質を評価し、エラーやリファクタリングの提案を行います。設定で検査内容をカスタマイズできます。
- flake8：PEP 8に準拠しているかをチェックし、構文エラーや未使用変数などの問題を指摘します。複数のプラグインを利用して柔軟に設定できます。
pylintとflake8の違いをまとめると、以下の通りです。
| 機能 | pylint | flake8 |
|---|---|---|
| 目的 | コード解析、リファクタリング提案、バグ検出 | コード解析、スタイルチェック |
| 柔軟性 | 設定が非常に柔軟でカスタマイズ可能 | 設定が柔軟であるが、pylintより限定的 |
| 速度 | やや遅い | より高速 |
| エラーメッセージ | 詳細でわかりやすいエラーメッセージ | シンプルで簡潔なエラーメッセージ |
| プラグイン | 少ない | 多くのプラグインが利用可能 |
どちらのツールがおすすめかは、プロジェクトやチームのニーズに応じて選択してください。
静的解析ツールの利用方法
pylintとflake8のインストールと基本的な使い方は以下の通りです。
pylintのインストールと使用方法
pip install pylint
pylint your_script.pyflake8のインストールと使用方法
pip install flake8
flake8 your_script.pyコードレビューでの活用
静的解析ツールをコードレビューに活用することで、以下の利点が得られます。
- コード品質が向上し、バグの発見が容易になります。
- コードレビューでの指摘が減り、開発者が本質的な問題に集中できます。
- チーム全体でコーディングスタイルが統一され、可読性が向上します。
静的解析ツールを利用することで、Pythonコードの品質を向上させ、効率的な開発が可能になります。コードレビューで活用することで、より可読性の高いコーディングが実現できます。
PEP 8に準拠したPythonの命名規則
以下に、Pythonの命名規則に関するまとめを表形式で示します。
| 項目 | 命名規則 | 例 |
|---|---|---|
| 変数名 | 小文字とアンダースコアの利用 | user_age, item_list |
| 関数名 | 動詞＋名詞の組み合わせ、アンダースコアで区切る | get_name, save_file |
| クラス名 | キャメルケース | MyClass, UserAccount |
| 定数名 | 大文字とアンダースコアの利用 | MAX_SIZE |
| モジュール名 | 小文字とアンダースコアの使用 | my_module, utils |
| パッケージ名 | 短くて独自性のある名前、アルファベットのみ | numpy, requests |
| 例外名 | “Error”を含める、クラス名の命名規則に従う | FileNotFoundError |
| プライベート変数・メソッド | 単一アンダースコアで始める | _private_var, _private_method |
| プロテクテッド変数・メソッド | 単一アンダースコアで始める | _protected_var, _protected_method |
これらの命名規則を実践することで、コードの可読性と効率性が向上し、他の開発者が理解しやすいコードを書くことができます。
以下に詳しい解説と、サンプルコードを提示します。
変数名の命名規則
Pythonの変数名では、小文字とアンダースコアを使って単語を区切るスネークケースを使用します。
また、変数名は長くなっても、意味のある名前を選ぶことが重要です。
# 悪い例
a = 10 # 何の数字かわからない
# 良い例
user_age = 10 # 年齢であることが明確関数名の命名規則
関数名では、小文字とアンダースコアを使って単語を区切るスネークケースを使用します。
関数名は、動詞と名詞の組み合わせで表現すると、その関数が何を行うのかが明確になります。
def calculate_area(width, height):
return width * height
def print_hello_world():
print("Hello, world!")クラス名の命名規則
クラス名では、単語の頭文字を大文字にして連結するキャメルケース（CamelCase）を使用します。この命名規則に従うことで、クラスと変数・関数を区別しやすくなります。
また、クラス名は名詞や形容詞の組み合わせで表現することが一般的です。これにより、クラスが表すオブジェクトの概念が明確になります。
class UserProfile:
pass
class DatabaseConnection:
pass定数名の命名規則
定数名は全て大文字で記述し、単語の区切りにアンダースコアを使用します。これにより、定数と変数を区別しやすくなります。
また、定数名は、その値の意味や役割を明確に示す名前を選ぶことが重要です。
# 悪い例
M = 1000 # 何を意味するかわからない
# 良い例
MAXIMUM_SIZE = 1000 # 最大サイズであることが明確モジュール名の命名規則
モジュール名は、小文字とアンダースコアを使って単語を区切るスネークケースを使用します。
また、モジュール名は、そのモジュールが提供する機能を表す名前を選ぶことが重要です。
# my_module.py
# another_example_module.pyパッケージ名の命名規則
パッケージ名は、短くて独自性のある名前を選ぶことが重要です。これにより、他のパッケージとの衝突を避けることができます。
# my_package
# another_pkgまた、パッケージ名には、英字の小文字を使用し、数字やアンダースコアは使わないようにしましょう。
# image_tools (良い)
# image_tools2 (悪い)
# image_tools_v2 (悪い)例外名の命名規則
例外名は、クラス名の命名規則(キャメルケース)に従い、エラーの種類を示すために “Error” を含めることが一般的です。
class CustomError(Exception):
pass
class ConnectionError(Exception):
passアクセス制御に関する命名規則
プライベート変数とメソッド
プライベート変数とメソッドは、名前の先頭にアンダースコア（_）を付けることで示します。
ただし、これはPythonにおいて慣習的なルールであり、強制的なアクセス制御ではありません。
class MyClass:
def __init__(self):
self._private_variable = "secret"
def _private_method(self):
passプロテクテッド変数とメソッド
プロテクテッド変数とメソッドは、サブクラスでのみアクセスを許可するものです。これも、名前の先頭にアンダースコアを付けることで示します。
class MyBaseClass:
def __init__(self):
self._protected_variable = "protected"
def _protected_method(self):
pass良い命名をするために、意識すべきコツ
命名規則に従うことは基本として、他にも良い命名をするためのコツがあります。
以下のコツを意識して命名すると、コードの可読性やメンテナビリティを向上させることができます。
命名規則を始めとする、プログラミングのベストプラクティスを学ぶなら、以下がおすすめ
ポチップ
「ITエンジニア本大賞2023」の技術書部門大賞を受賞の大ベストセラー
ポチップ
分かりやすく、意味のある名前を選ぶ
変数名や関数名、クラス名などは、その名前だけを見て、意味が分かるように命名する必要があります。そのため、名前が長くなっても、省略せず、役割を明確に表す命名をすることが大切です。
以下に良い例と悪い例を提示します。
悪い例
# 短い名前を使った変数
a = 5
b = 10
# 短い名前を使った関数
def calc(x, y):
return x + y
# 短い名前を使ったクラス
class A:
def __init__(self, x):
self.x = xしっかりと読まないと、何をやっているコードなのか分かりません。
良い例
# 名前の意味を明確にした変数
total_sales = 1000
num_of_customers = 50
# 名前の意味を明確にした関数
def calculate_total_price(price, tax):
total_price = price + (price * tax)
return total_price
# 名前の意味を明確にしたクラス
class Person:
def __init__(self, name):
self.name = name上記の良い例では、変数名、関数名、クラス名が意味を明確に表しており、分かりやすいです。長い名前でも、役割を正確に表すことができるため、可読性が高くなります。
単数形と複数形を使い分ける
変数名や関数名では、単数形と複数形を使い分けることで、コードの可読性を向上させることができます。
例えば、リストの変数名は複数形にし、単一の要素を扱う変数名は単数形にすることで、明確に伝えることができます。
# 複数のアイテムを含むリストの変数名は、複数形にします。
fruits = ['apple', 'banana', 'cherry']
# リストから単一の要素を取り出す変数名は、単数形にします。
for fruit in fruits:
print(fruit)
def add_fruit(fruits, new_fruit):
# 単一の要素を扱う変数名も単数形にします。
fruits.append(new_fruit)
add_fruit(fruits, 'orange')
print(fruits)この例では、fruitsというリストの変数名は複数形にしています。これにより、この変数が複数のアイテムを含むことが明確に伝わります。
一方で、forループの中でリストから取り出した要素を扱う変数名fruitは単数形にしています。これにより、この変数が単一の要素を表すことがわかりやすくなります。
また、add_fruit関数では、引数fruits（複数形）とnew_fruit（単数形）を使い分けています。これにより、fruitsが複数のアイテムを含むリストであることと、new_fruitが単一の要素であることが明確に伝わります。
このように、単数形と複数形を適切に使い分けることで、コードの可読性が向上し、他の開発者がコードを理解しやすくなります。
命名規則をドキュメントに記載する
プロジェクトで採用する命名規則をドキュメントに記載しておくことで、開発者が命名規則に沿った名前を付けることができます。また、新規メンバーの参加やプロジェクトの引き継ぎなどで、命名規則を確認することができます。
Python学習におすすめのコンテンツ
現役シリコンバレーエンジニアが教えるPython 3 入門 + 応用 +アメリカのシリコンバレー流コードスタイル
Udemyの講座でPythonなら、文句なしにおすすめ
- 分かりやすい言葉や具体的なコードで工夫して説明しているので、初心者でも理解できる。
- 初心者でも挫折しないように、丁寧に詳しく手順を説明している。
- 講座内で取り扱う課題は実践的なものが多く、書籍では身につかない応用力を身につけられる。
- 情報量が多いのに、講座の進み方が速いので、一回では理解が追いつかない。
- 課題の難易度が高すぎる場合がある。
- 講師のアクセントが特殊で、聞き取りにくいと感じたことがある。
テスト駆動Python 第2版
日本語で唯一、pytestだけに焦点を当てて、詳細に書かれた書籍です。
- 日本語でpytestの全てについて、解説されている唯一の書籍
- 段々とステップアップして、深くなるので、初心者でも、中級者でも、上級者でも、学びがある
- サンプルコードには、サンプルアプリが含まれているため、実践的に学べる工夫あり
- 章末にまとめがあり、復習の役に立つ
- 第7章に「どのようなテストを書くのか」についての解説があり、テストに対する考え方が深まる
- 後半になると、かなり高度な内容になるため、初心者には難しい
- タイトルに「テスト駆動開発」と書かれているが、該当部分の記述が少なく、テスト駆動開発を知りたい人は期待外れになるかも
エソラ間違えて、第1版を買わないように注意して下さい。
ポチップ
まとめ：命名規則の実践でプロフェッショナルなコーディング
Pythonの命名規則を理解し、実践することで、コードの可読性と効率性が向上します。
一貫性のある命名規則を適用することで、他の開発者がコードを理解しやすくなり、プロジェクト全体の開発速度が向上します。
これらの規則を実践し、プロフェッショナルなコーディングを目指しましょう。
コメント