【python】ファイル検索を再帰的にする【→プログラム初心者向け】

プログラム女子

いっぱいのフォルダやファイルの中から自分が思うファイルを検索したいんだけど...

多くのフォルダの中から、ファイルを「再帰的」に調べるってことだね。pythonでは、フォルダを順番に調べていくしくみがあるから、今回はこれを紹介するね。

Tommy

pythonでファイル検索を再帰的にする概要

pythonプログラムを使って、あるフォルダの下にあるファイルを検索したい場合、pythonでは、「os」ライブラリというものを使って、フォルダの中身を再帰的に検索することができます。

「再帰的」というのは、１つのフォルダの中身を調べるだけでなく、フォルダの中にあるフォルダの中身も繰り返し調べるという意味です。この記事では、pythonで指定ディレクトリの下を、再帰的にファイル検索する方法を説明します。

pythonでファイル検索を再帰的にする前提の環境

pythonでフォルダの全ファイルを再帰的に検索する前提の環境は、下の記事で説明している私の環境と同じ環境で確認しています。

レンタルサーバなどのLinuxサーバを使っている場合は、下の記事でプログラミングする環境の作り方を説明しています。

もし、まだプログラムする環境ができていない方は、先にこちらの記事を読んで、プログラミングできる環境をつくることをおすすめします。

pythonでファイル検索を再帰的にするサンプルプログラム

ここでは、カレントディレクトリの配下のフォルダやファイルをすべて取得するサンプルプログラムを作成して、そのプログラムの実行結果を説明します。

ファイル検索を再帰的にするサンプルプログラムの作成

まず、カレントディレクトリの配下のフォルダやファイルをすべて取得するサンプルプログラムは次の順番で作成します。

1. ライブラリのインポート
2. 指定ディレクトリのファイルを再帰的に検索する関数の定義
3. 定義した関数の呼び出し

ライブラリのインポート

ファイル名とディレクトリパスを操作する関数を使う為に、「os」という名前のライブラリをインポートします。

import os

指定ディレクトリのファイルを再帰的に検索する関数の定義

下のプログラムでは、指定されたディレクトリ配下のファイルをファイルパスを含めてリストで返す関数「find_all_files」を定義しています。

osライブラリの「walk」という関数を使用して、現在のディレクトリにあるファイルを、現在のディレクトリ、そのディレクトリにあるサブディレクトリ、ファイル名に分解して、全てのファイルやサブディレクトリの個数分だけループします。

さらに１つ目のループで抽出されたファイル個数分だけ、ファイル名とディレクトリパスを連結し、「yield」で随時取り出すという処理を行っています。もし、「yield」について詳しく知りたい場合は下の記事を読んでください。

def find_all_files(directory):
	for cur_dir, dirs, files in os.walk(directory):
		for file in files:
			yield os.path.join(cur_dir, file)

定義した関数の呼び出し

関数「find_all_files」で得られたディレクトリのリストに対して、それぞれを表示しています。

if __name__ == '__main__':
	for file in find_all_files('./'):
		print(file)

実行結果

上で作成したサンプルプログラム「test.py」を実行した結果が下の表示です。カレントディレクトリ配下には、「test.py」というサンプルプログラムのソースコードファイルと、「file1」と「file2」というファイル、さらに「dir1」といフォルダがあり、フォルダ「dir1」の下には「file3」と「file4」というファイル、「dir2」というフォルダ、さらに、フォルダ「dir2」の中には「file5」と「file6」というファイルがあることが分かります。

$ python test.py
./test.py
./file2
./file1
./dir1/file3
./dir1/file4
./dir1/dir2/file6
./dir1/dir2/file5