😘 今一度副作用についてまとめよう

I. 💨 はじめに

副作用を最小限に抑えることによって、プログラムの予測可能性が向上し、再利用性が高まります。副作用が少ない関数は、他のコードで使いやすく、修正や拡張もしやすいため、保守性が向上します。従って、副作用を最小限に抑えることは、高品質なプログラムを作成する上で重要な要素です。
本記事では具体例と共に、副作用について今一度まとめることを意図してます。

A. この記事における論の進め方概要

この記事では、まず副作用の定義と語源を説明し、その問題点を特定します。
問題点が明らかになった上で、副作用を最小限に保つことの重要性を説明し、具体的な方法を提示します。
その後、従業員勤怠管理システムの実践例を用いて、提案された方法が実際にどのように機能し、副作用を最小限に抑える効果があることを実感します。
最後に、得られた知見をもとに記事全体をまとめます。

B. この記事の前提となる知識

この記事を理解するためには、基本的なプログラミングの知識（変数、関数、制御構造など）が必要です。

C. この記事に期待できること・期待できないこと

この記事では、プログラミングにおける副作用の基本的な概念と、それを最小限に抑える方法をわかりやすく説明します。しかし、期待できないこととして、以下の点が挙げられます。

1. 学術的な議論や深い理論的背景には触れません。この記事は、初心者向けに副作用に関する基本的な理解を促すことを目的としているため、高度な数学や論理学に基づく議論は行いません。
2. 深い理解や高度なスキルの習得を保証するものではありません。この記事を読むことで、副作用に関する基本的な知識を得られることを目指していますが、深い理解や実践的なスキルの習得には、より専門的な資料や実践経験が必要です。

この記事を読むことで、プログラミングにおける副作用に関する基本的な理解を深め、その問題点と対策について学ぶことができます。しかし、より高度な理解や実践的なスキルを身につけるためには、専門的な資料や実践経験を積むことが重要です。

本記事ではプログラミングにおける副作用についてまとめ、理解しようと思います。副作用とはいったい何でしょうか？次章で、まずは定義と語源から見ていきましょう。

---

II. 🫠 プログラミングにおける副作用とは何か

A. 副作用の定義・語源

1. 副作用とは何か

副作用とは、プログラムが実行された際に、その動作によって、期待しない副次的な変化が起きることを指します。
例えば、ある関数が引数として受け取った変数の値を変更した場合、それは副作用となります。プログラムが副作用を持つと、そのプログラムは外部の状態を変化させる可能性があるため、プログラムの振る舞いが予測できなくなります。

プログラミングにおける副作用には、次のような種類があります。

• 変数の値を変更する副作用
• ファイルに書き込む副作用
• ネットワークに接続する副作用
• メモリを解放する副作用

2. "副作用"の語源

「副作用」という言葉は、医薬品や医療的処置の副作用から由来しています。医療分野では、治療目的以外の意図しない効果を指す言葉として使われています。プログラミングにおいても、同じように、期待しない結果が発生することを指す言葉として用いられています。

副作用の定義や語源についてわかったところで、プログラムに副作用があるといったい何が問題になるのでしょうか？

---

III. 🤨 副作用がもたらす問題点

A. 予測可能性の低下

副作用がもたらす問題点として、関数が同じ入力に対して異なる出力を返す場合や、同じ関数を複数回呼び出した場合に異なる結果が得られる場合が挙げられます。これらはプログラムの正しさや安定性に影響を与え、予測可能性の低下につながります。

B. 再利用性の低下

副作用がもたらすもう一つの問題点として、再利用が難しくなる場合が挙げられます。
関数が、他のコードと競合するようなグローバル変数を使用したり、外部状態を変更してしまうからです。

では、具体的になぜ副作用の少ないプログラムを作ることがプログラマーにとって重要なのでしょうか？

---

IV. 🖋️ 副作用を最小限に保つことの重要性

A. どのように予測可能性が向上するのか？

副作用を最小限に保つことによって、プログラムの予測可能性が向上します。副作用のない関数が呼び出されたとき、動作は常に同じです。これによって、プログラムが予期しない動作をしないため、プログラムの品質が向上します。
一方、副作用の多い関数では、呼び出されたときの動作が常に同じとは限りません。外部の状態が変わるためです。これは、予測可能性が低いため、信頼性が低下することを意味します。

具体的な予測可能性が向上する場面を見てみましょう。例えば、副作用のない関数である add_numbers 関数を考えます。

def add_numbers(a, b):
	return a + b

このような関数を、純粋関数と呼びます。

純粋関数とは何か

純粋関数とは、同じ引数に対して常に同じ結果を返す関数のことを言います。つまり、外部の変数や状態を変更せず、引数の値だけを使って計算を行います。

この関数を呼び出すと、常に同じ結果が得られます。副作用を最小限に保つことで、このような予測可能な動作を実現することができます。
予測可能ということは、他のコードと組み合わせやすく、テストケースも作りやすいということを意味します。

一方、副作用のある関数である random_add_numbers 関数を考えます。

import random

def random_add_numbers(a, b):
	if random.random() < 0.5:
		return a

この関数を呼び出すと、ランダムな値によって、関数の結果が異なる可能性があります。結果が常に同じではないため、予測可能性が低下してしまいます。
予測可能性が低いということは、他のコードと組み合わせたときに予期せぬ結果を招きやすく、テストケースも作りづらいということを意味します。

副作用を最小限に保つことによって、プログラムの予測可能性が高まるので、テストしやすく安全に動作する関数を定義できます！

B. どのように再利用性が向上するのか？

副作用を最小限に保つことによって、コードの再利用性も高めることができます。
同じ機能を持つコードが複数箇所に散在している場合、修正や再利用が困難になるため、開発時間を増加させる原因になります。

具体的な再利用性向上の場面について見てみましょう。

def add_numbers(a, b):
	return a + b

この例は純粋関数で副作用がなく、再利用性が高いです。なぜなら、純粋関数は外部の状態を変更しないため、他のコードや機能と依存関係が最小限になるからです。

これに対して、具体的な再利用性低下の場面について見てみましょう。

counter = 0

def increment():
    global counter
    counter += 1 # 外部の状態を変更している
    return counter

この例は外部の状態を変更する副作用があり、再利用性が低いです。なぜなら、外部の状態counterに依存しているため、他のモジュールで再利用するためには再度counterを定義しなければいけなくなるからです。
外部の状態との依存性によって、再利用するために移さなければいけない荷物が多くなってしまいます。

以上のように、副作用を最小限に保つことで、同じコードを簡潔に再利用できるため、プログラムの再利用性が向上するということがわかります。

C. IV章のまとめ

副作用を最小限に保つことは、このようにプログラムの予測可能性と再利用性を高めることができます。
予測可能性の向上によって、テスタビリティや安全性の向上を得ることが出来ます。
再利用性の向上によって、開発時間を短縮できたり、バグを減らすことができたりするため、プログラマーにとっても嬉しい状況が生まれます。

それでは、「副作用を最小限に保つ重要性」について理解できたところで、副作用を減らすためには、どのような手法があるかについて考えてみましょう。

---

V. 🙋‍♀️ プログラム内の副作用を減らす方法

より信頼性の高いコードを書けるように、プログラム内で副作用を減らす方法を説明します。

A. 純粋関数を使う

純粋関数とは何か

純粋関数とは、同じ引数に対して常に同じ結果を返す関数のことを言います。つまり、外部の変数や状態を変更せず、引数の値だけを使って計算を行います。

純粋関数を使うことで得られるメリット

純粋関数を使うことで、プログラム内での副作用を減らすことができます。このため、関数のテストが容易になり、再利用性が高まります。

純粋関数はどのように動作するか？

以下は、純粋関数の例です。この例では、引数の数値を2乗して返す関数を定義しています。

def square(x):
    return x * x

この関数は、引数xを変更することなく、その値の2乗を返します。このような純粋関数を使うことで、プログラムの副作用を減らすことができます。

B. 状態変数を避ける

状態変数とは何か

次に、状態変数とは、関数外で定義された変数やオブジェクトを指します。このような状態変数を関数内で変更することで、副作用が発生します。

状態変数を避けることで得られるメリット

状態変数を避けることで、関数の副作用を減らすことができます。このため、プログラムのテストや保守性が向上し、バグを防ぐことができます。

状態変数に関する具体例は？

1. 状態変数を利用している悪い例

状態変数を利用した悪い例を再掲します。。この例では、グローバル変数counterを使用して、関数を呼び出すたびにcounterをインクリメントします。

counter = 0

def increment():
    global counter
    counter += 1
    return counter

この関数は、counterの値を変更するため、副作用を持ちます。また、この関数は他の関数やオブジェクトからも呼び出されるため、グローバルスコープでのcounterの変更は、プログラム全体に影響を与える可能性があります。

2. 改善例

改善例として、counterを引数として受け取り、その値をインクリメントして返す関数を定義することができます。

def increment(counter):
    return counter + 1

このようにすることで、グローバルスコープでのcounterの変更を避けることができます。また、この関数は引数のみを使用するため、純粋関数です。

C. イミュータブルなデータ構造を使う

イミュータブルとは何か

イミュータブルとは、変更できない性質のことを意味します。

Pythonでは、tupleやfrozensetなどのイミュータブルなデータ構造が利用できます。これにより、関数がデータを変更する副作用を持てなくなります。

イミュータブルなデータ構造の具体例は？

以下は、tupleを利用してデータを変更する副作用を排除した例です。

def add_employee(employees, new_employee):
    return employees + (new_employee,)

def main():
    employees = ("Alice", "Bob", "Charlie")
    new_employee = "David"
    updated_employees = add_employee(employees, new_employee)
    print(updated_employees)

if __name__ == "__main__":
    main()

D. 副作用を明示的に管理する

なぜ副作用を明示的に管理するのか？

副作用のないプログラムに価値はない

外部の状態を変更しないということは、外部ソースへの情報の書き込みや、ユーザーインターフェイスへの表示すらも行わないからです。副作用との付き合い方、管理の仕方が大切になります。

副作用を明示的に管理することで、プログラム内での副作用を把握しやすくなります。また、大多数の関数の振る舞いが予測しやすくなり、プログラムの保守性が向上します。

副作用を管理する方法

プログラミングにおいて、副作用を最小限に保つことで信頼性と再利用性を高めることができます。以下に、副作用を管理する方法の例を2つ紹介します。

1. 型システムを使用して副作用を明示する

Pythonでは、typingモジュールを使用して型ヒントを追加し、副作用を明示的に示すことができます。これにより、関数が副作用を持つことを明示的に示し、他の開発者がその副作用を理解しやすくなります。

以下は、Pythonで副作用を明示する例です。

from typing import Callable

def side_effect_function() -> None:
    # 副作用がある処理
    pass

def effectful_function(side_effect: Callable[[], None]) -> int:
    # 副作用を持つ関数
    side_effect()
    return 42

2. 関数のドキュメントやコメントに副作用を記述する

関数のドキュメントやコメントに副作用を明示的に記述することで、他の開発者が関数の挙動を理解しやすくなります。Pythonでは、docstringを使用して関数の説明を記述します。

以下は、Pythonでコメントに副作用を記述する例です。

def save_to_file(data: str) -> bool:
    """
    ファイルシステムにアクセスしてデータを保存します。
    副作用: ファイルシステムに新しいファイルが作成されます。
    
    :param data: 保存するデータ
    :return: 保存が成功した場合はTrue、失敗した場合はFalse
    """
    # ファイルシステムへの書き込み処理

E. まとめ

状態変数を制御することは、予測可能性と再利用性を向上させるために重要です。
副作用を明示的にし、純粋関数やイミュータブルなデータ構造を使用することで、副作用を適切にすることができます。これにより、コードの信頼性と再利用性が向上し、安全性を担保しやすくなります。

では、最後にもっと実践的な例を見てみましょう。例えば従業員勤怠管理システムにおいて、どのように副作用を減らせるでしょうか？

---

VI. 📃 従業員勤怠管理システムの例

本章では、実践的な例を使ってプログラミングにおける副作用を最小限に保つ方法を解説します。具体的には、皆さんも馴染み深いであろう従業員勤怠管理システムにおける、「従業員が出勤する」という機能の実装を例に取ります。以下が想定する仕様です。

A. 想定する仕様

1. 従業員が出勤するためには、まず出勤時間を記録します。
2. 出勤時間を記録したら、その従業員が出勤したことを記録します。
3. 出勤した従業員に対して、出勤した旨の通知を表示します。
4. 出勤した従業員が、出勤記録を確認できるようにします。

B. 悪い例

まず、悪い例から見ていきましょう。
以下のコードは、上記の仕様を満たすものの、副作用が多く信頼性や再利用性が低い実装です。

import time
import requests

employee_code = "12345"

def record_attendance():
    # グローバル変数を関数内で変更
    global employee_code
    
    # 現在の日時を取得
    current_time = time.localtime()
    
    # ファイルを開いて出勤記録を追記
    attendance_db = open("attendance_database.txt", "a")
    attendance_db.write(employee_code + "," + time.strftime("%Y-%m-%d %H:%M:%S", current_time) + ",attendance\n")
    attendance_db.close()
    
    # 出勤時間を表示
    print("出勤時間：", time.strftime("%Y-%m-%d %H:%M:%S", current_time))
    
    # 従業員コードを通知するリクエストを送信
    requests.post('https://example.com/notify_attendance', data={'employee_code': employee_code})

1. どこが悪いのか

このコードの問題点は以下の通りです。

• 日時関数が関数内で直接行われています。
• 出勤記録のデータベースへのアクセスが関数内で直接行われています。
• ログを関数内で直接記録しています。
• 通知の送信が関数内で直接行われています。
• グローバル変数（employee_code）を関数内で直接使用・変更しています。
  コードの信頼性や再利用性が低くなります。例えば、グローバル変数を直接使用・変更することで、他の部分で影響が生じる可能性があります。また、データベースへのアクセスや通知の送信が直接行われているため、他の場所で再利用する際に変更が困難です。

C. 順を追ってリファクタリング

リファクタリングを行い、副作用を分離することで信頼性と再利用性が向上し、テスタビリティも向上します。以下に、順を追って副作用を分離し、リファクタリングしたコード例を示します。

1. 日時取得

まず、日時取得の処理を分離します。これにより、日時取得部分をテストや再利用が容易になります。

def get_current_time():
    return time.localtime()

2. ファイル操作クラス

次に、出勤記録のデータベースへのアクセスを行うクラスを作成し、ファイル操作を分離します。

class AttendanceDatabase:
    def __init__(self, file_path):
        self.file_path = file_path

    def record_attendance(self, employee_code, current_time):
        with open(self.file_path, "a") as attendance_db:
            attendance_db.write(f"{employee_code},{time.strftime('%Y-%m-%d %H:%M:%S', current_time)},attendance\n")

3. ロガークラス
   出勤時間を表示する処理をロガークラスに分離し、出力先を柔軟に変更できるようにします。

class Logger:
    def log(self, message):
        print(message)

4. 通知送信クラス
   通知の送信を行うクラスを作成し、リクエスト操作を分離します。

class Notifier:
    def __init__(self, url):
        self.url = url

    def notify_attendance(self, employee_code):
        requests.post(self.url, data={'employee_code': employee_code})

5. グローバル変数の削除
   これらのクラスと関数を利用して、record_attendance関数を再定義し、グローバル変数を引数として取るように変更します。

def record_attendance(employee_code, attendance_database, logger, notifier):
    current_time = get_current_time()
    attendance_database.record_attendance(employee_code, current_time)
    logger.log(f"出勤時間：{time.strftime('%Y-%m-%d %H:%M:%S', current_time)}")
    notifier.notify_attendance(employee_code)

これにより、副作用が分離され、信頼性と再利用性が向上しました。また、依存性注入を利用することで、テスタビリティも向上しました。

本章では、従業員勤怠管理システムの例を通じて、副作用を最小限に保つ方法を実践的に解説しました。リファクタリングにより、信頼性と再利用性が向上し、テスタビリティも向上しました。

この章までで、副作用を最小限に保つことで得られる利点や方法を詳しく学びました。しかし、これらの知識を実践的に活用するためには、最後にしっかりとまとめておく必要があります。次の章では、本記事で学んだ内容を総合的にまとめ、改めて副作用を最小限に保つことの重要性を再確認します。また、用語一覧を通じて、新たな知識を整理し、より理解を深めることができます。最後のまとめを見ていきましょう。

---

VII. 📓 まとめ

A. 副作用を最小限に保つことで得られる利点の再確認

この記事を通して、副作用を最小限に保つことでプログラムの予測可能性が向上し、再利用性が高まることが分かりました。それにより、プログラム全体が安定し、信頼性が向上します。

B. 副作用を最小限に保つための方法のまとめ

1. 純粋関数を使う
2. 状態変数を避ける
3. イミュータブルなデータ構造を使う
4. 副作用を明示的に示す

これらの方法を実践することで、副作用を最小限に抑えることができます。

C. この記事で登場した用語一覧

1. 副作用
2. 予測可能性
3. 再利用性
4. 純粋関数
5. 状態変数
6. イミュータブル

D. 最後に

副作用を意識することで、あなたのプログラムはより信頼性が高く、再利用性が向上し、予測可能性が高まります。ところで、これは元記事はGPT-3.5に書いてもらったと記憶しているのですが、編集がとても大変でした。編集の学びがあり、とても意外です。