Pythonでディレクトリツリーを取得してファイル一覧を表示する方法【os.walkの使い方】

2020年11月16日
2022年6月19日
Python
for, generatorオブジェクト, os.walk関数, osモジュール, print関数, ディレクトリ, ディレクトリツリー, ファイル, フォルダ, ループ処理

Python

Pythonでディレクトリ内に含まれているすべてのディレクトリやファイルを取得したいときに使えるのがos.walk関数です。

この関数を使うとすべてのファイルやディレクトリをforループを使って取り出すことができます。

フォルダとディレクトリは同じ意味です。主観ですがディレクトリは「作業スペース」で、フォルダは「ただの入れ物」というイメージが強いです。

1 os.walk関数とは
2 print関数では取り出せない
3 for文での使い方
4 まとめ

os.walk関数とは

osモジュールの関数でディレクトリ内のディレクトリやファイルを取得することができます。

os.walk関数は基本的にfor文でループ処理をしてディレクトリやファイルの名前を取り出します。

Python-os.walk公式ページ

os.walk関数はgeneratorオブジェクトを返します。オブジェクトとはデータの種類・性質とそのデータに対してできる処理をまとめて指す言葉です。オブジェクトによってできることとできないことがあるので注意が必要です。

print関数では取り出せない

print(os.walk(path))

#出力結果
<generator object walk at 0x00000227C93B4A50>

print(os.walk(path)[1])

#出力結果
TypeError: 'generator' object is not subscriptable

print(os.walk(path))

#出力結果

print(os.walk(path)[1])

#出力結果

TypeError: 'generator' object is not subscriptable

print関数をつかってもこのようにメモリの番号が出てくるだけなので注意が必要です。また、リストのようにインデックスを指定すると「TypeError」になります。generatorオブジェクトにはインデックはありません。

for文での使い方

変数が1つ

階層ごとにタプルに格納される

以下の「blogディレクトリ」をos.walk関数を使って表示します。

C:
│  sample.txt
│  スケジュール.xlsx
│
│─ folder1
│    ├─ step1.txt
│    ├─ step2.txt
│    └─ step3.txt
│
└─ folder2
　    ├─ time.txt
  　  └─ folder3.txt
　　　　　　└─ test.txt

│ sample.txt

│ スケジュール.xlsx

│

│─ folder1

│ ├─ step1.txt

│ ├─ step2.txt

│ └─ step3.txt

│

└─ folder2

　 ├─ time.txt

　 └─ folder3.txt

　　　　　　└─ test.txt

for i in os.walk(r"C:\blog"):
    print(i)

#出力結果
('C:\\blog', ['folder1', 'folder2'], ['sample.txt', 'スケジュール.xlsx'])
('C:\\blog\\folder1', [], ['step1.txt', 'step2.txt', 'step3.txt'])
('C:\\blog\\folder2', ['folder3'], ['time.txt'])
('C:\\blog\\folder2\\folder3', [], ['test.txt'])

for i in os.walk(r"C:\blog"):

print(i)

#出力結果

('C:\\blog', ['folder1', 'folder2'], ['sample.txt', 'スケジュール.xlsx'])

('C:\\blog\\folder1', [], ['step1.txt', 'step2.txt', 'step3.txt'])

('C:\\blog\\folder2', ['folder3'], ['time.txt'])

('C:\\blog\\folder2\\folder3', [], ['test.txt'])

タプルには以下の順番で格納されています。

ディレクトリパス
含まれるディレクトリ名のリスト
含まれるファイル名のリスト

変数が2つ

2変数では「ValueError」になる

for i,j  in os.walk(path):
    print(i, j)

#出力結果
ValueError: too many values to unpack (expected 2)

for i,j in os.walk(path):

print(i, j)

#出力結果

ValueError: too many values to unpack (expected 2)

変数が3つ

dirs変数：各ディレクトリのパスを格納
subdirs変数：各ディレクトリ名を格納
files変数：各ファイル名を格納

for dirs, subdirs, files in os.walk(path):
    print("ディレクトリ：", dirs)
    for subdir in subdirs:
        print("内部のディレクトリ名：", subdir)
    for file in files:
        print("ファイル名：", file)
    print("===============")

#出力結果
ディレクトリ： C:\blog
内部のディレクトリ名： folder1
内部のディレクトリ名： folder2
ファイル名： sample.txt
ファイル名： スケジュール.xlsx
===============
ディレクトリ： C:\blog\folder1
ファイル名： step1.txt
ファイル名： step2.txt
ファイル名： step3.txt
===============
ディレクトリ： C:\blog\folder2
内部のディレクトリ名： folder3
ファイル名： time.txt
===============
ディレクトリ： C:\blog\folder2\folder3
ファイル名： test.txt
===============

for dirs, subdirs, files in os.walk(path):

print("ディレクトリ：", dirs)

for subdir in subdirs:

print("内部のディレクトリ名：", subdir)

for file in files:

print("ファイル名：", file)

print("===============")

#出力結果

ディレクトリ： C:\blog

内部のディレクトリ名： folder1

内部のディレクトリ名： folder2

ファイル名： sample.txt

ファイル名：スケジュール.xlsx

===============

ディレクトリ： C:\blog\folder1

ファイル名： step1.txt

ファイル名： step2.txt

ファイル名： step3.txt

===============

ディレクトリ： C:\blog\folder2

内部のディレクトリ名： folder3

ファイル名： time.txt

===============

ディレクトリ： C:\blog\folder2\folder3

ファイル名： test.txt

===============

このように各階層のディレクトリ名とファイル名を表示することができます。もちろん、階層にディレクトリが存在しない場合は「内部のディレクトリ名」は省略されています。

まとめ

os.walk関数：ディレクトリツリーを取得
- generatorオブジェクト
for文でループさせて表示する
- 変数は1個か3個に限る

【独学】Pythonを学習できる無料＆有料教材7選

プログラミング言語のなかでも人気の高いPythonを学習する教材を紹介します。最近ではプログラミングスククールがたくさんあるので迷うと思います。ですが、まずは無料教材から始めてみましょう。苦労した分だけ力がつきます。 […]