列挙型を使用する際の将来の変更への対応: ベストプラクティス

列挙型は、関連する定数をグループ化するために使用される便利な機能です。
しかし、列挙型を使用する際は、将来的に新しい値が追加される可能性を考慮することが重要です。

本記事では、将来の変更に対応するための列挙型の使用方法について、サンプルコードを交えて解説します。

列挙型の値を暗黙的に処理する問題点

以下のコードは、ユーザーの役割を表す列挙型 UserRoleに関して取り扱っています。
与えられた役割に基づいてユーザーの権限を判定する関数 get_user_permissions の例です。

from enum import Enum
from typing import List

class UserRole(Enum):
    ADMIN = "admin"
    EDITOR = "editor"
    VIEWER = "viewer"

def get_user_permissions(role: UserRole) -> List[str]:
    if role == UserRole.ADMIN:
        return ["read", "write", "delete"]
    elif role == UserRole.EDITOR:
        return ["read", "write"]
    else:
        return ["read"]

この関数は、ADMIN と EDITOR の場合は明示的に権限を返しています。
しかし、それ以外の場合は暗黙的に “read” 権限のみを返しています。

現在は VIEWER しかありません。
将来的に新しい役割が追加された場合、この関数は新しい役割に対して “read” 権限を返してしまいます。

これは、意図しない動作につながる可能性があります。

解決策: 全ての列挙型の値を明示的に処理する

列挙型の値を暗黙的に処理することは、やめましょう。
全ての値を明示的に処理することで、将来の変更に対応可能となります。

Pythonでは、列挙型の全ての値を処理しているかどうかを確認するために、members 属性を使用できます。

def get_user_permissions(role: UserRole) -> List[str]:
    if role == UserRole.ADMIN:
        return ["read", "write", "delete"]
    elif role == UserRole.EDITOR:
        return ["read", "write"]
    elif role == UserRole.VIEWER:
        return ["read"]
    else:
        raise ValueError(f"Unsupported role: {role}")

def test_get_user_permissions():
    for role in UserRole.__members__.values():
        permissions = get_user_permissions(role)
        assert isinstance(permissions, list)

get_user_permissions 関数では、全ての UserRole の値に対して明示的に権限を返しています。
サポートされていない役割の場合は、ValueError を発生させています。

test_get_user_permissions 関数では、UserRole の全ての値を反復処理し、get_user_permissions 関数をテストしています。
これにより、新しい役割が追加された場合、get_user_permissions 関数が更新されていないとテストが失敗します。

以下のコードは、UserRoleに新しい値 CONTRIBUTOR を追加した例です。

from enum import Enum
from typing import List

class UserRole(Enum):
    ADMIN = "admin" 
    EDITOR = "editor"
    VIEWER = "viewer"
    CONTRIBUTOR = "contributor"  # 新しい値を追加

def get_user_permissions(role: UserRole) -> List[str]:
    if role == UserRole.ADMIN:
        return ["read", "write", "delete"]
    elif role == UserRole.EDITOR:
        return ["read", "write"]
    elif role == UserRole.VIEWER:
        return ["read"]
    else:
        raise ValueError(f"Unsupported role: {role}")

def test_get_user_permissions():
    for role in UserRole.__members__.values():
        permissions = get_user_permissions(role)
        assert isinstance(permissions, list)

このコードでは、UserRole に新しい値 CONTRIBUTOR を追加しています。
しかし、get_user_permissions 関数では CONTRIBUTOR に対する処理が実装されていません。

その状態でtest_get_user_permissions 関数を実行すると、以下のようなValueErrorが発生します。

ValueError: Unsupported role: UserRole.CONTRIBUTOR

この例外は、get_user_permissions 関数内の else ブロックで発生しています。
UserRole に新しい値を追加したときに、get_user_permissions 関数がその値を適切に処理できない場合、このようなエラーが発生します。

このエラーは、get_user_permissions 関数が更新されていないことを示しており、開発者に修正を促すことができます。
test_get_user_permissions 関数は、UserRole のすべての値に対して get_user_permissions 関数をテストします。

そのことにより、将来の変更に対する安全性が確保されます。
新しい値が追加されたときにテストが失敗することで、コードを更新する必要性に気づくことができます。

デフォルトケースに注意する

列挙型を処理する際に、デフォルトケースを使用すると、将来の変更に対応できなくなる可能性があります。
以下のコードは、デフォルトケースを使用した例です。

def get_user_permissions(role: UserRole) -> List[str]:
    if role == UserRole.ADMIN:
        return ["read", "write", "delete"]
    elif role == UserRole.EDITOR:
        return ["read", "write"]
    else:
        return ["read"]  # デフォルトケース

このコードでは、ADMIN と EDITOR 以外の役割に対して、デフォルトで “read” 権限を返しています。
将来的に新しい役割が追加された場合、その役割に対しても “read” 権限が返されてしまいます。

これは、意図しない動作につながる可能性があります。
デフォルトケースを使用する代わりに、サポートされていない役割に対してはエラーを発生させるようにしましょう。

def get_user_permissions(role: UserRole) -> List[str]:
    if role == UserRole.ADMIN:
        return ["read", "write", "delete"]
    elif role == UserRole.EDITOR:
        return ["read", "write"]
    elif role == UserRole.VIEWER:
        return ["read"]
    else:
        raise ValueError(f"Unsupported role: {role}")

この方法では、将来の変更に対応できるようになります。