検索
ホームページバックエンド開発Python チュートリアルPython でクリーンなコードを記述する方法 - ベスト プラクティス ガイド

How to Write Clean Code in Python - Best Practices Guide

Python コードを記述するときは、コードをきれいで読みやすいものにすることが不可欠です。クリーンなコードとは、コードがよく整理されており、理解しやすく、保守が容易であることを意味します。このガイドでは、初心者でも経験豊富な開発者でも、Python できれいなコードを書くのに役立つ最良のヒントを共有します。

クリーンなコードが重要な理由

きれいなコードを書くことは、多くの理由から不可欠です:

  • 可読性: クリーンなコードは読みやすく、他の開発者がコードをすぐに理解するのに役立ちます。
  • 保守性: コードがクリーンであれば、更新、デバッグ、改善が簡単になります。
  • コラボレーション: クリーンなコードは、特に他のユーザーとコードを共有したり、大規模なプロジェクトに取り組んだりする場合、チームワークに不可欠です。
  • エラー防止: コードがクリーンで整理されていれば、バグが発生する可能性は低くなります。 ここで、Python でよりクリーンなコードを作成するのに役立ついくつかのベスト プラクティスを見てみましょう。

1. 意味のある変数名と関数名を使用する

コードの可読性を向上させる最も簡単な方法の 1 つは、変数と関数に明確で意味のある名前を使用することです。 x、y、foo などの 1 文字の名前や難解な名前は避けてください。

:

# Bad example
def calc(x, y):
    return x + y

# Good example
def calculate_total_price(item_price, tax):
    return item_price + tax

2 番目の例では、関数名と変数名を見るだけで関数の動作を簡単に理解できます。

2. PEP 8 スタイルガイドに従う

PEP 8 は Python の公式スタイル ガイドであり、クリーンで読みやすいコードを記述するための規則を提供します。 PEP 8 の主要な推奨事項には次のものがあります。

  • インデント: インデント レベルごとに 4 つのスペースを使用します。
  • 行の長さ: 行は 79 文字未満にしてください。
  • 間隔: 演算子の周囲とカンマの後にスペースを使用します。
  • コメント: コードの複雑な部分を説明するコメントを追加します。 PEP 8 に従うことで、コードが Python のコミュニティ標準に準拠していることが保証されます。

:

# PEP 8 Example
def calculate_discounted_price(price, discount):
    """Calculate the final price after applying the discount."""
    discounted_amount = price * (discount / 100)
    final_price = price - discounted_amount
    return final_price

3. モジュラーコードを書く

コードをより小さく管理しやすい関数に分割します。各関数は 1 つの特定のタスクを実行する必要があるため、読み取り、テスト、デバッグが容易になります。

:

# Bad example
def process_order(customer, items):
    total_price = 0
    for item in items:
        total_price += item['price']
    if total_price > 100:
        discount = total_price * 0.1
        total_price -= discount
    # Send email
    print(f"Order confirmed for {customer['name']}")
    return total_price

# Good example
def calculate_total_price(items):
    return sum(item['price'] for item in items)

def apply_discount(total_price):
    if total_price > 100:
        return total_price * 0.9
    return total_price

def send_confirmation_email(customer):
    print(f"Order confirmed for {customer['name']}")

def process_order(customer, items):
    total_price = calculate_total_price(items)
    total_price = apply_discount(total_price)
    send_confirmation_email(customer)
    return total_price

改良された例では、コードがより小さな関数に分割され、理解しやすく、保守しやすくなっています。

4. わかりやすくするためにリスト内包表記を使用する

Python のリスト内包表記は、リストを作成する簡潔な方法を提供します。これらを使用すると、コードがよりクリーンになり、読みやすくなります。

:

# Without list comprehension
squares = []
for x in range(10):
    squares.append(x ** 2)

# With list comprehension
squares = [x ** 2 for x in range(10)]

2 番目の例は短くて読みやすいです。

5. 値のハードコーディングを避ける

コード内で値を直接ハードコーディングすることは避けてください。代わりに、定数または構成ファイルを使用してください。これにより、コードがより柔軟になり、更新が容易になります。

:

# Bad example
def calculate_discount(price):
    return price * 0.1  # Discount is hardcoded

# Good example
DISCOUNT_RATE = 0.1

def calculate_discount(price):
    return price * DISCOUNT_RATE

2 番目の例では、割引率が定数に保存されているため、必要に応じて簡単に変更できます。

6. コメントとドキュメントストリングを追加する

クリーンなコードは一目瞭然ですが、コメントやドキュメント文字列を追加すると、複雑な関数やアルゴリズムの目的を説明するのに役立ちます。

  • コメント: 特定のアプローチが使用される理由を説明します。
  • Docstrings: 関数の動作とそのパラメーターを説明します。 :
def find_largest_number(numbers):
    """
    Find the largest number in a list.

    Args:
    numbers (list): A list of numbers.

    Returns:
    int: The largest number.
    """
    return max(numbers)

docstring は、他の開発者がコード全体を読まなくても関数の使用方法を理解するのに役立ちます。

7. コードをドライに保つ (同じことを繰り返さない)

コードの重複を避けてください。パターンの繰り返しに気付いた場合は、コードをリファクタリングして関数またはクラスを再利用してみてください。これにより、コードの保守性が向上し、エラーの可能性が減ります。

:

# Bad example
def get_full_name1(first_name, last_name):
    return first_name + " " + last_name

def get_full_name2(first_name, last_name):
    return first_name + " " + last_name

# Good example
def get_full_name(first_name, last_name):
    return first_name + " " + last_name

8. エラーを適切に処理する

プログラムのクラッシュを防ぐために、常に try ブロックと else ブロックを使用して例外を処理してください。デバッグを容易にするために、有益なエラー メッセージも提供する必要があります。

:

# Bad example
def divide_numbers(a, b):
    return a / b

# Good example
def divide_numbers(a, b):
    try:
        return a / b
    except ZeroDivisionError:
        return "Error: Cannot divide by zero"

2 番目の例はクラッシュを防止し、役立つエラー メッセージを提供します。

9. フォーマットに F 文字列を使用する

Python 3.6 では、文字列をフォーマットするシンプルで読みやすい方法である f-strings が導入されました。これらは、古い文字列書式設定メソッドよりもはるかにクリーンです。

:

# Old way
name = "Alice"
greeting = "Hello, %s!" % name

# With f-strings
greeting = f"Hello, {name}!"

F 文字列を使用すると、コードが読みやすく、保守しやすくなります。

10. Use Meaningful Imports

Only import the necessary modules and functions. Avoid wildcard imports like from module import * as they can clutter the namespace and make it harder to track dependencies.

Example:

# Bad example
from math import *

# Good example
from math import sqrt, pi

Conclusion

Writing clean code in Python is a valuable skill that helps you create readable, maintainable, and bug-free software. By following the best practices outlined in this guide—using meaningful names, following PEP 8, keeping your code modular, and handling errors gracefully—you can significantly improve your coding style.

Focus on readability, simplicity, and consistency, and you'll be well on your way to writing clean, professional Python code.

以上がPython でクリーンなコードを記述する方法 - ベスト プラクティス ガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
Pythonを使用してテキストファイルのZIPF配布を見つける方法Pythonを使用してテキストファイルのZIPF配布を見つける方法Mar 05, 2025 am 09:58 AM

このチュートリアルでは、Pythonを使用してZIPFの法則の統計的概念を処理する方法を示し、法律の処理時にPythonの読み取りおよび並べ替えの効率性を示します。 ZIPF分布という用語が何を意味するのか疑問に思うかもしれません。この用語を理解するには、まずZIPFの法律を定義する必要があります。心配しないでください、私は指示を簡素化しようとします。 ZIPFの法則 ZIPFの法則は単に意味します。大きな自然言語のコーパスでは、最も頻繁に発生する単語は、2番目の頻繁な単語のほぼ2倍の頻度で表示されます。 例を見てみましょう。アメリカ英語の茶色のコーパスを見ると、最も頻繁な言葉は「thであることに気付くでしょう。

HTMLを解析するために美しいスープを使用するにはどうすればよいですか?HTMLを解析するために美しいスープを使用するにはどうすればよいですか?Mar 10, 2025 pm 06:54 PM

この記事では、Pythonライブラリである美しいスープを使用してHTMLを解析する方法について説明します。 find()、find_all()、select()、およびget_text()などの一般的な方法は、データ抽出、多様なHTML構造とエラーの処理、および代替案(SEL

Pythonでの画像フィルタリングPythonでの画像フィルタリングMar 03, 2025 am 09:44 AM

ノイズの多い画像を扱うことは、特に携帯電話や低解像度のカメラの写真でよくある問題です。 このチュートリアルでは、OpenCVを使用してPythonの画像フィルタリング手法を調査して、この問題に取り組みます。 画像フィルタリング:強力なツール 画像フィルター

Pythonを使用してPDFドキュメントの操作方法Pythonを使用してPDFドキュメントの操作方法Mar 02, 2025 am 09:54 AM

PDFファイルは、クロスプラットフォームの互換性に人気があり、オペレーティングシステム、読み取りデバイス、ソフトウェア間でコンテンツとレイアウトが一貫しています。ただし、Python Plansing Plain Text Filesとは異なり、PDFファイルは、より複雑な構造を持つバイナリファイルであり、フォント、色、画像などの要素を含んでいます。 幸いなことに、Pythonの外部モジュールでPDFファイルを処理することは難しくありません。この記事では、PYPDF2モジュールを使用して、PDFファイルを開き、ページを印刷し、テキストを抽出する方法を示します。 PDFファイルの作成と編集については、私からの別のチュートリアルを参照してください。 準備 コアは、外部モジュールPYPDF2を使用することにあります。まず、PIPを使用してインストールします。 ピップはpです

DjangoアプリケーションでRedisを使用してキャッシュする方法DjangoアプリケーションでRedisを使用してキャッシュする方法Mar 02, 2025 am 10:10 AM

このチュートリアルでは、Redisキャッシングを活用して、特にDjangoフレームワーク内でPythonアプリケーションのパフォーマンスを向上させる方法を示しています。 Redisのインストール、Django構成、およびパフォーマンスの比較をカバーして、Beneを強調します

TensorflowまたはPytorchで深い学習を実行する方法は?TensorflowまたはPytorchで深い学習を実行する方法は?Mar 10, 2025 pm 06:52 PM

この記事では、深い学習のためにTensorflowとPytorchを比較しています。 関連する手順、データの準備、モデルの構築、トレーニング、評価、展開について詳しく説明しています。 特に計算グラップに関して、フレームワーク間の重要な違い

Pythonで独自のデータ構造を実装する方法Pythonで独自のデータ構造を実装する方法Mar 03, 2025 am 09:28 AM

このチュートリアルでは、Python 3にカスタムパイプラインデータ構造を作成し、機能を強化するためにクラスとオペレーターのオーバーロードを活用していることを示しています。 パイプラインの柔軟性は、一連の機能をデータセットに適用する能力にあります。

Pythonの並列および同時プログラミングの紹介Pythonの並列および同時プログラミングの紹介Mar 03, 2025 am 10:32 AM

データサイエンスと処理のお気に入りであるPythonは、高性能コンピューティングのための豊富なエコシステムを提供します。ただし、Pythonの並列プログラミングは、独自の課題を提示します。このチュートリアルでは、これらの課題を調査し、グローバルな承認に焦点を当てています

See all articles

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

DVWA

DVWA

Damn Vulnerable Web App (DVWA) は、非常に脆弱な PHP/MySQL Web アプリケーションです。その主な目的は、セキュリティ専門家が法的環境でスキルとツールをテストするのに役立ち、Web 開発者が Web アプリケーションを保護するプロセスをより深く理解できるようにし、教師/生徒が教室環境で Web アプリケーションを教え/学習できるようにすることです。安全。 DVWA の目標は、シンプルでわかりやすいインターフェイスを通じて、さまざまな難易度で最も一般的な Web 脆弱性のいくつかを実践することです。このソフトウェアは、

SecLists

SecLists

SecLists は、セキュリティ テスターの究極の相棒です。これは、セキュリティ評価中に頻繁に使用されるさまざまな種類のリストを 1 か所にまとめたものです。 SecLists は、セキュリティ テスターが必要とする可能性のあるすべてのリストを便利に提供することで、セキュリティ テストをより効率的かつ生産的にするのに役立ちます。リストの種類には、ユーザー名、パスワード、URL、ファジング ペイロード、機密データ パターン、Web シェルなどが含まれます。テスターはこのリポジトリを新しいテスト マシンにプルするだけで、必要なあらゆる種類のリストにアクセスできるようになります。

AtomエディタMac版ダウンロード

AtomエディタMac版ダウンロード

最も人気のあるオープンソースエディター

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

強力な PHP 統合開発環境