[Python] 型ヒント付きの引数にデフォルト引数を指定する方法

Pythonでは、関数の引数に型ヒントを付けることで、コードの可読性と保守性を向上させることができます。

型ヒントは、引数の型を明示するために使用され、引数名の後にコロンと型を指定します。

さらに、デフォルト引数を指定する場合は、型ヒントの後に等号とデフォルト値を記述します。

例えば、def example_function(param: int = 10):のように記述することで、paramは整数型でデフォルト値が10であることを示します。

この方法により、関数の使用方法が明確になり、型チェックツールを利用する際にも役立ちます。

型ヒント付きの引数にデフォルト引数を指定する方法

基本的な書き方

Pythonでは、関数の引数に型ヒントを指定することで、引数の期待される型を明示することができます。

また、デフォルト引数を設定することで、引数が指定されなかった場合に使用される値を定義できます。

基本的な書き方は以下の通りです。

def function_name(param: Type = default_value):
    pass

ここで、paramは引数名、Typeは型ヒント、default_valueはデフォルト値です。

型ヒントとデフォルト引数の組み合わせ

型ヒントとデフォルト引数を組み合わせることで、より明確な関数定義が可能になります。

これにより、関数を使用する際に、引数の型やデフォルト値が一目でわかるようになります。

以下はその例です。

def greet(name: str = "ゲスト") -> None:
    print(f"こんにちは、{name}さん！")

この関数では、name引数に文字列型の型ヒントが指定され、デフォルト値として「ゲスト」が設定されています。

型ヒント付きデフォルト引数の例

文字列型のデフォルト引数

文字列型のデフォルト引数を持つ関数の例を示します。

def introduce(name: str = "無名"): 
    print(f"私の名前は{name}です。")

この関数を実行すると、引数が指定されなかった場合は「無名」と表示されます。

introduce()  # 私の名前は無名です。
introduce("太郎")  # 私の名前は太郎です。

数値型のデフォルト引数

数値型のデフォルト引数を持つ関数の例です。

def calculate_area(radius: float = 1.0) -> float:
    return 3.14 * radius ** 2

この関数では、半径が指定されなかった場合、デフォルトで1.0が使用されます。

print(calculate_area())  # 3.14
print(calculate_area(2))  # 12.56

リスト型のデフォルト引数

リスト型のデフォルト引数を持つ関数の例を示します。

def add_item(item: str, items: list = []) -> list:
    items.append(item)
    return items

この関数では、items引数が指定されなかった場合、空のリストがデフォルトで使用されます。

print(add_item("りんご"))  # ['りんご']
print(add_item("バナナ"))  # ['バナナ']

このように、型ヒント付きの引数にデフォルト引数を指定することで、関数の使い方が明確になり、コードの可読性が向上します。

応用例

複数の型ヒント付きデフォルト引数

複数の引数に型ヒントとデフォルト値を指定することも可能です。

これにより、関数の柔軟性が増し、さまざまな状況に対応できます。

以下はその例です。

def create_user(name: str = "ゲスト", age: int = 18) -> dict:
    return {"名前": name, "年齢": age}

この関数では、nameとageの2つの引数に型ヒントとデフォルト値が設定されています。

print(create_user())  # {'名前': 'ゲスト', '年齢': 18}
print(create_user("太郎", 25))  # {'名前': '太郎', '年齢': 25}

デフォルト引数に関数を使用する

デフォルト引数に他の関数を指定することもできます。

これにより、動的に値を生成することが可能になります。

def default_greeting() -> str:
    return "こんにちは！"
def greet(name: str = default_greeting()) -> None:
    print(f"{name}さん、ようこそ！")

この例では、default_greeting関数がデフォルト引数として使用されています。

greet()  # こんにちは！さん、ようこそ！
greet("太郎")  # 太郎さん、ようこそ！

デフォルト引数にクラスインスタンスを使用する

デフォルト引数にクラスのインスタンスを指定することも可能です。

これにより、オブジェクト指向プログラミングの利点を活かすことができます。

class User:
    def __init__(self, name: str = "ゲスト"):
        self.name = name
def welcome(user: User = User()) -> None:
    print(f"{user.name}さん、ようこそ！")

この関数では、Userクラスのインスタンスがデフォルト引数として使用されています。

welcome()  # ゲストさん、ようこそ！
welcome(User("太郎"))  # 太郎さん、ようこそ！

これらの応用例を通じて、型ヒント付きのデフォルト引数を活用することで、より柔軟で使いやすい関数を作成することができます。

まとめ

この記事では、Pythonにおける型ヒント付きの引数にデフォルト引数を指定する方法について詳しく解説しました。

型ヒントとデフォルト引数を組み合わせることで、関数の可読性や柔軟性が向上し、より使いやすいコードを書くことができます。

ぜひ、実際のプロジェクトでこれらのテクニックを活用してみてください。