Pythonで特定の条件を満たすファイルを検索する方法

背景

プロジェクトの中に散在する特定の条件を満たすファイルを見つけたいことがあります。Pythonの標準ライブラリを使用して、これを効果的に行う方法を説明します。

問題

あるディレクトリ内のファイルから、特定の拡張子を持ち、特定のキーワードを含むファイルを見つけたいとします。

解決策

Pythonのosおよびfnmatchモジュールを使用してディレクトリ内のファイルを検索し、open関数を使用してファイルを読み込んで条件を確認します。

import os
import fnmatch

def find_files(directory, pattern, keyword):
    """
    指定されたディレクトリ内のファイルから、
    指定された拡張子を持ち、かつ指定されたキーワードを含むファイルを検索する関数。
    """
    matching_files = []

    # ディレクトリ内のすべてのファイルとサブディレクトリに対してループ
    for root, dirnames, filenames in os.walk(directory):
        for filename in fnmatch.filter(filenames, pattern):
            file_path = os.path.join(root, filename)

            # ファイルを開いてキーワードを確認
            with open(file_path, 'r', encoding='utf-8') as file:
                if keyword in file.read():
                    matching_files.append(file_path)

    return matching_files

# 使用例
directory_to_search = '/path/to/search'
file_pattern = '*.txt'
search_keyword = 'important'

result = find_files(directory_to_search, file_pattern, search_keyword)
print("検索結果:")
for file_path in result:
    print(file_path)

この例では、find_files関数が指定されたディレクトリ内で特定の拡張子とキーワードを持つファイルを見つけます。os.walkを使用することで、ディレクトリ内のすべてのファイルとサブディレクトリに対して再帰的に検索できます。

注意: ファイルが大きい場合や、検索するディレクトリが非常に大きい場合は、パフォーマンスの向上のために適切な最適化が必要です。