コードの読みやすさを高めるテクニック: 深くネストしたコードを避ける

コードの読みやすさを向上させるために、深くネストしたコードを避けることが重要です。
本記事では、深いネストが読みやすさに与える影響と、それを避けるためのテクニックについて解説します。

深いネストの問題点の事例1

以下のコードは、ユーザーのロールと状態に基づいて適切な権限を付与するための関数の例です。

def grant_permissions(user):
    if user:
        if user.role == "admin":
            if user.is_active:
                # 管理者権限を付与
                permissions = ["read", "write", "delete"]
            else:
                # アカウントが無効化されている場合、権限を付与しない
                permissions = []
        elif user.role == "editor":
            if user.is_active:
                # 編集者権限を付与
                permissions = ["read", "write"]
            else:
                # アカウントが無効化されている場合、権限を付与しない
                permissions = []
        else:
            # その他のロールには読み取り権限のみを付与
            permissions = ["read"]
    else:
        # ユーザーが存在しない場合、権限を付与しない
        permissions = []
    
    return permissions

このコードでは、ユーザーのロールと状態に応じて権限を付与するためのif-elif-else文が深くネストしています。
深いネストは、コードの読みやすさを低下させ、ロジックの理解を困難にします。

解決策1: 早期リターンを使用する

def grant_permissions(user):
    if not user:
        return []
    
    if not user.is_active:
        return []
    
    if user.role == "admin":
        return ["read", "write", "delete"]
    
    if user.role == "editor":
        return ["read", "write"]
    
    return ["read"]

早期リターンを使用することで、ネストが浅くなり、コードの読みやすさが向上します。

解決策2: ディクショナリを使用する

ROLE_PERMISSIONS = {
    "admin": ["read", "write", "delete"],
    "editor": ["read", "write"],
    "default": ["read"]
}

def grant_permissions(user):
    if not user or not user.is_active:
        return []
    
    return ROLE_PERMISSIONS.get(user.role, ROLE_PERMISSIONS["default"])

ディクショナリを使用することで、if-elif文が不要になり、コードがシンプルになります。
また、ロールと権限のマッピングが一箇所にまとめられるため、保守性も向上します。

深いネストの問題点の事例2

次は、価格を計算する関数の例です。
計算のための仕様は、以下となります。

商品のカテゴリと価格に基づいて割引を適用
輸入品の場合は輸入税を加算

def calculate_price(item):
    if item:
        if item.category == "electronics":
            if item.price > 1000:
                discount = 0.1
            else:
                discount = 0.05
        elif item.category == "clothing":
            if item.price > 500:
                discount = 0.15
            else:
                discount = 0.1
        else:
            discount = 0
        
        price = item.price * (1 - discount)
        
        if item.is_imported:
            if item.imported_tax_rate:
                import_tax = item.price * item.imported_tax_rate
            else:
                import_tax = item.price * 0.05
            
            price += import_tax
        
        return price
    else:
        return 0

このコードでは、if文が深くネストしており、コードの読みやすさが低下しています。

解決策: 関数を分割する

def calculate_discount(item):
    if item.category == "electronics":
        return 0.1 if item.price > 1000 else 0.05
    elif item.category == "clothing":
        return 0.15 if item.price > 500 else 0.1
    else:
        return 0

def calculate_import_tax(item):
    if item.is_imported:
        return item.price * (item.imported_tax_rate or 0.05)
    return 0

def calculate_price(item):
    if not item:
        return 0
    
    discount = calculate_discount(item)
    price = item.price * (1 - discount)
    
    import_tax = calculate_import_tax(item)
    price += import_tax
    
    return price

割引と輸入税の計算をそれぞれ別の関数に分割しています。
そのことにより、calculate_price関数のネストが浅くなり、読みやすくなります。

また、それぞれの関数が単一の責務を持つようになるため、コードの保守性も向上します。