コンテンツにスキップ
CodeMDD.io | Coding Tutorials

pep8の使い方や修正方法：簡単に解説【Pythonチュートリアル】

[

PEP 8により美しいPythonコードを書く方法

PEP 8は、Pythonコードの読みやすさと一貫性を向上させるためにガイドラインとベストプラクティスを提供するドキュメントです。このチュートリアルでは、PEP 8で提示されている主要なガイドラインについて説明します。PEP 8のガイドラインに準拠したPythonコードの書き方を学びましょう。

PEP 8が必要な理由

”Code is read much more often than it’s written.”とGuido van Rossumは言っています。コードを書く時間はわずか数分または一日ですが、そのコードを読む時間はずっと長くなります。一度書いたコードは何度も読まれることになるからです。

可読性の高いコードは、他の開発者や自分自身がコードを理解しやすくし、メンテナンスや修正が容易になります。PEP 8のガイドラインに従うことで、全体的なコードの品質を向上させることができます。

名前付け規則

名前付けは、PEP 8の重要なガイドラインの一つです。Pythonの名前については以下のルールを守ることが推奨されています。

名前のスタイル

  • ローワーキャメルケース: myVariable
  • スネークケース: my_variable
  • アッパーケース: MY_CONSTANT

名前の選び方

  • 変数や関数の名前は意味が分かりやすく、短くすることが推奨されています。
  • 単語の略語や省略形は避け、わかりやすい名前を使うようにしましょう。
# Example


message = "Hello, World!"  # Good example
msg = "Hello, World!"  # Bad example


def calculate_area(length, width):
    return length * width  # Good example


def calc_area(l, w):
    return l * w  # Bad example

コードのレイアウト

PEP 8では、コードのレイアウトに関するガイドラインも提供されています。以下に示す重要なポイントについて説明します。

空行

  • 関数やクラスの定義の前後には1行の空行を入れることが推奨されています。
# Example


def greet():
    print("Hello, World!")




class Person:
    def __init__(self, name):
        self.name = name


    def say_hello(self):
        print(f"Hello, {self.name}!")

最大行長と行の折り返し

  • 1行の文字数は80文字以下にすることが推奨されています。
  • 長い行を折り返す場合は、演算子の後ろで折り返すことが推奨されています。
# Example


sum = 1 + 2 + 3 + 4 + 5 \
    + 6 + 7 + 8 + 9 + 10  # Good example


sum = 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10  # Bad example

インデント

PEP 8では、インデントに関するガイドラインも提供されています。以下に示すポイントに従ってインデントを行いましょう。

タブ vs スペース

  • インデントにはスペースを使用することが推奨されています。
  • タブとスペースを混在させないようにしましょう。

行の折り返しに続くインデント

  • 行の折り返し後はインデントを揃えることが推奨されています。

閉じカッコの位置

  • 閉じカッコは、直前の行のインデントレベルと揃えることが望ましいです。

コメント

コードにコメントを追加することも、PEP 8のガイドラインの一部です。以下にコメントに関するガイドラインを示します。

ブロックコメント

  • ブロックコメントは、#を使用してコメントブロックを作成します。

インラインコメント

  • インラインコメントは、行の終わりに#を使用してコメントを追加します。

ドキュメンテーション文字列

  • 関数やクラスのドキュメンテーション文字列は、"""で囲んで作成します。
# Example


# This is a block comment
# It spans multiple lines
# It provides additional information


def calculate_area(length, width):
    # This is an inline comment
    # It provides information about the calculation
    return length * width


class Rectangle:
    """This is a documentation string.
    It provides information about the Rectangle class.
    """
    pass

式と文での空白

PEP 8には、式と文における空白の使用に関するガイドラインも提供されています。以下に重要なポイントを示します。

二項演算子の周りの空白

  • 二項演算子の周りには、スペースを追加することが推奨されています。

空白を追加する場合と追加しない場合

  • 式や文が読みやすくなる場合にのみ、空白を追加することが推奨されています。

プログラミングの推奨事項

PEP 8には、プログラミングの推奨事項も含まれています。以下にいくつかのポイントを示します。

  • 定数は全て大文字で記述することが推奨されています。
  • 長い行のコメントは避け、短いコメントを追加することが推奨されています。
  • マジックナンバーやハードコードされた値は避け、定数を使用することが推奨されています。

PEP 8を無視する場合

  • PEP 8のガイドラインを無視する場合、それには理由があるはずです。状況に応じて、ガイドラインを無視することもありますが、適切な理由があることを認識しておく必要があります。

PEP 8に従うためのヒントとトリック

PEP 8のガイドラインに従うためのヒントとトリックを紹介します。

リンター

  • リンターツールを使用することで、コードがPEP 8に準拠しているかどうかを自動的にチェックすることができます。

オートフォーマッター

  • オートフォーマッターツールを使用することで、コードのフォーマットを自動的に修正することができます。

組み合わせたツール

  • リンターとオートフォーマッターの両方を組み合わせて使用することで、コードの品質を向上させることができます。

結論

PEP 8のガイドラインに従うことは、Pythonコードの読みやすさと品質を向上させるために重要です。このチュートリアルでは、PEP 8の主要なガイドラインについて詳しく説明しました。これらのガイドラインに従ってPythonコードを書くことで、他の開発者や自分自身がコードを理解しやすくし、メンテナンスや修正が容易になることでしょう。