ユーティリティ関数とは

2024年6月8日2024年6月25日

ユーティリティ関数（Utility Function）は、通常、共通の処理や再利用可能なコードをまとめて、簡潔に記述するための関数です。これにより、コードの重複を避け、可読性を向上させることができます。

例えば、Djangoのビューでデータの加工や計算を行う共通の処理がある場合、それらの処理をユーティリティ関数にまとめることができます。以下は簡単な例です。

python
# utils.py

def calculate_discounted_price(original_price, discount_percentage):
    """
    ディスカウントされた価格を計算するユーティリティ関数
    """
    discount_amount = (original_price * discount_percentage) / 100
    discounted_price = original_price - discount_amount
    return discounted_price

このユーティリティ関数は、与えられた元の価格とディスカウント率に基づいて、ディスカウント後の価格を計算します。これをビューで使用することで、同じ計算を複数の場所で簡単に行うことができます。

python
# views.py

from django.shortcuts import render
from .utils import calculate_discounted_price

def my_view(request):
    original_price = 1000
    discount_percentage = 10

    discounted_price = calculate_discounted_price(original_price, discount_percentage)

    context = {'discounted_price': discounted_price}
    return render(request, 'template.html', context)

こういったユーティリティ関数の使用は、コードの再利用性を高め、保守性を向上させるのに役立ちます。