🗃️

適切な抽象化でプログラムの保守性と可読性を向上させる方法

2023/03/16に公開

初心者

プログラミング基礎

chatgptで書いた

tech

はじめに

プログラムの開発において、同じコードが複数箇所に現れることはよくあります。しかし、このような重複コードは以下のような問題点があります。

バグの発生リスクが高まる
重複したコードが存在すると、同じ処理が異なる場所で行われていることになります。これにより、バグが見つかった際にすべての場所で修正する必要が生じます。修正漏れがあると、新たなバグが発生するリスクが高まります。
コードの修正や機能追加が困難になる
重複したコードがある場合、コードの一部を変更する際に、同様の変更を複数箇所で実施する必要があります。これにより、変更や機能追加が煩雑になり、効率的な開発が困難になります。
可読性が低下し、理解に時間がかかる
コードの重複は、その構造が複雑になることを意味します。これにより、コードの可読性が低下し、他の開発者がコードを理解するのにより多くの時間がかかります。結果として、開発速度が遅くなり、プロジェクトの進捗に悪影響を与える可能性があります。
保守性が悪化する
重複コードが存在すると、将来的にコードの変更が必要になった際に、変更箇所が増えるため保守性が低下します。さらに、重複したコードに依存している他のコードも影響を受ける可能性があり、保守性の悪化が連鎖的に発生することがあります。
テストの困難さが増す
重複したコードがある場合、テストも重複することが多く、テストの効率が低下します。また、重複コードの変更やバグ修正が行われた際、関連するテストも更新する必要があり、テストのメンテナンスが困難になることがあります。

この記事では、プログラムの重複を減らすための手法について解説します。

抽象化による重複排除

プログラムの抽象化とは、プログラムの具体的な実装や詳細を隠蔽し、一般的な概念や共通の処理を表現することです。抽象化を行うことで、コードの再利用性が向上し、保守性や可読性も向上します。主な抽象化の手法には、関数・メソッドの定義、モジュールの作成、クラスやインターフェースの使用などがあります。

関数・メソッドの利用

同じコードが複数箇所で使われる場合、関数やメソッドを利用して一度定義し、その後再利用することで重複を減らすことができます。
関数やメソッドは、特定のタスクを実行する一連の手順をまとめるために使用されます。関数は独立して存在し、メソッドはクラスの中に定義されます。関数・メソッドは入力を受け取り、それに基づいて処理を行い、結果を返す一連の手順が必要な場面でので活用が適切です。

例えば、次のような2つのリストの要素をそれぞれ2倍にするコードがある場合、

list1 = [1, 2, 3]
list2 = [4, 5, 6]

list1_double = [x * 2 for x in list1]
list2_double = [x * 2 for x in list2]

以下のように関数を定義して利用することで、コードの重複を削減できます。

def double_list_elements(input_list):
    return [x * 2 for x in input_list]

list1 = [1, 2, 3]
list2 = [4, 5, 6]

list1_double = double_list_elements(list1)
list2_double = double_list_elements(list2)

モジュール・パッケージの活用

他のファイルやパッケージで定義された関数やクラスをインポートして利用することで、コードの重複を減らすことができます。
モジュールは、関連する関数、クラス、変数、定数などをまとめるために使用されるPythonのコードファイルです。モジュールは関連する機能やコンポーネントを一つにまとめて整理・管理する場面での活用が適切です。

例えば、math_utils.py というファイルに以下のような関数を定義しておきます。

math_utils.py

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

def multiply(a, b):
    return a * b

そして、別のファイルで math_utils.py をインポートし、その関数を利用します。

main.py

import math_utils

result1 = math_utils.add(2, 3)
result2 = math_utils.multiply(4, 5)

print(result1)  # 5
print(result2)  # 20

オブジェクト指向プログラミングの活用

オブジェクト指向プログラミングを活用することで、データとそれに関連する操作を一つにまとめることができ、コードの重複を削減できます。
オブジェクト指向プログラミングは、データ（属性）とそれに関連する操作（メソッド）を一つのまとまり（オブジェクト）として表現します。オブジェクト指向プログラミングは複雑なデータ構造や親子関係をまとめて整理・管理する場面での活用が適切です。

例えば、以下のような犬の情報を扱うプログラムがある場合、

dog1_name = "Buddy"
dog1_age = 3

dog2_name = "Max"
dog2_age = 5

def dog_bark(name):
    print(f"{name} says woof!")

dog_bark(dog1_name)
dog_bark(dog2_name)

以下のようにクラスを利用してコードを整理することができます。

class Dog:
    def __init__(self, name):
        self.name = name

    def bark(self):
        print(f"{self.name} says: Woof!")

dog1 = Dog("Buddy")
dog2 = Dog("Max")

dog1.bark()
dog2.bark()

抽象化の落とし穴

過度な抽象化は、コードの重複排除において落とし穴となります。コードを抽象化することで重複を減らそうとする場合、適切なバランスが重要です。過度な抽象化は、コードの可読性や保守性を低下させる可能性があります。

具体例として以下に、異なる動物の鳴き声を出力する関数が3つあるとします。

def dog_bark():
    print("Dog: わんわん")

def cat_meow():
    print("Cat: にゃー")

def cow_moo():
    print("Cow: もー")

これらの関数は、動物の名前と鳴き声を出力するという共通の処理を行っています。この場合、関数化により重複を排除できます。

def print_animal_sound(animal, sound):
    print(f"{animal}: {sound}")

def dog_bark():
    print_animal_sound("Dog", "わんわん")

def cat_meow():
    print_animal_sound("Cat", "にゃー")

def cow_moo():
    print_animal_sound("Cow", "もー")

この例では、抽象化が適切に行われており、問題はありません。しかし、過度な抽象化が行われると、次のようなコードになることがあります。

def print_message(message_type, arg1, arg2=None):
    if message_type == "animal_sound":
        print(f"{arg1}: {arg2}")
    elif message_type == "greeting":
        print(f"{arg1}、{arg2}！")
    else:
        raise ValueError("Invalid message type")

def dog_bark():
    print_message("animal_sound", "Dog", "わんわん")

def cat_meow():
    print_message("animal_sound", "Cat", "にゃー")

def cow_moo():
    print_message("animal_sound", "Cow", "もー")

def hello_japan():
    print_message("greeting", "こんにちは", "日本")

この例では、print_message関数が過度に抽象化されており、動物の鳴き声の出力と挨拶の出力という異なる操作が1つの関数にまとめられています。さらに、message_typeという引数が導入され、それによって関数の挙動が決定されます。
このような過度な抽象化は、コードの可読性を低下させ、保守性が悪くなります。なぜなら、この関数を見ただけでは、どのようなメッセージが出力されるのかが明確ではなく、引数を確認しなければならないからです。また、新たなメッセージタイプを追加する際にも、print_message関数を修正する必要があります。
過度な抽象化によるコードの可読性や保守性の低下を避けるためには、異なる操作や目的を持つ処理は別々の関数に分けることが重要です。

まとめ

重複を減らすことは、コード品質の向上や開発効率の向上につながります。しかし、過度な抽象化やコストを考慮し、適切な手法とバランスを選択することが重要です。コード品質を継続的に改善することで、効果的なプログラム開発が実現できます。