os.path から Pathlib に乗り換えよう

2018/7/13

はじめに

Python3.3 までは、 「あるディレクトリ以下に存在するテキストファイルの一覧を取得して、それぞれを開く」 という処理に、以下の 3 つのライブラリを使う必要がありました。

ファイルパス操作
os.path
ファイルの一覧取得
glob.glob
ファイルを開く
open

しかし、Python3.4 以降であれば、これらを すべて標準ライブラリpathlibに一任 することができます。
これによって、ファイル操作処理における 書きやすさ・読みやすさが向上 し、それぞれのライブラリの使い方をわざわざ調べる時間や、ライブラリ間の微妙な仕様の違いに苛まれる心配から解放されます。

今回は、 「../datasets/foo/bar以下に存在するテキストファイルをすべて取得して、内容を表示したい」 という目標に対して、pathlib を利用しない場合、pathlib を利用する場合のコードを比較しましょう。

pathlib を利用しない場合

まずは、os.path、glob.glob、open を使った場合のコードを見てみましょう。

import glob
from os.path import join, dirname, abspath

current_dir = dirname(abspath(__file__))
datasets_dir = join(dirname(current_dir), 'datasets', 'foo', 'bar')
file_names = glob.glob(join(datasets_dir, '**/*.txt'), recursive=True)

for file_name in file_names:
    with open(file_name, 'r') as f:
        print(f.read())

問題: パッと見て、どこを指しているのか分からない

あなたは、以下のコードを見て、これがどこを指しているのかすぐに分かりますか？

current_dir = dirname(abspath(__file__))
datasets_dir = join(dirname(current_dir), 'datasets', 'foo', 'bar')

普段、私達はディレクトリパスを左から右に読みますし、英語や日本語も左から右に読みます。しかし、join や dirname や abspath を使うと、そのコードがどこのパスを示しているのか、左から右にスラスラ読むことはできません。

pathlib を利用した場合

from pathlib import Path

current_dir = Path.cwd()
datasets_dir = current_dir.parent / 'datasets' / 'foo' / 'bar'
file_names = datasets_dir.glob('**/*.txt')

for file_name in file_names:
    print(file_name.read_text())

良いところ 1: 読みやすい

pathlib を用いた場合、普段我々がディレクトリパスを読む時にそうしているように、左から右にディレクトリパスを追うことができます。

current_dir = Path.cwd()
datasets_dir = current_dir.parent / 'datasets' / 'foo' / 'bar'

は、「現在のディレクトリの、親の、'datasets'の中の...」と、まさにそのまま左から右にスラスラと読むことができます。また、pathlib では/演算子でパスを結合することができます。慣れないと少し気持ちが悪いかもしれませんが、読みやすいことは間違いありません。

追記

## 方法1
current_dir = Path.cwd()
## 方法2
current_dir = Path(__file__).resolve().parent

上記は、場合によってはそれぞれ異なる結果を返します。「方法 1」はスクリプトを実行した時に位置していたディレクトリ、「方法 2」は実行されたスクリプトの存在するディレクトリを指します。

良いところ 2: ちょっとしたことで色々なライブラリをインポートしなくていい

file_names = datasets_dir.glob('**/*.txt')

for file_name in file_names:
    print(file_name.read_text())

pathlib を使用する場合、上記のような処理のためには glob と os.path の両方をインポートする必要があります。 pathlib を使用すれば、ファイルの一覧の取得も datasets_dir.glob('**/*.txt')で一発です。
また、ファイルの書き込み・読み込みも、openで得たファイルオブジェクトの終了処理を気にせずに、気軽にread_text()、write_text()、read_bytes()、write_bytes()で行えます。

おわりに

他にも、詳しいことはすべて https://docs.python.jp/3/library/pathlib.html に記されています。本当に便利です。こちらもぜひ一度ご覧になってください。

ご意見・ご指摘お待ちしております！

追記

色々な反応を頂きましたので、せっかくですからいくつかピックアップして紹介します。

/が連結演算子ってキモい

僕も最初はそう思ったクチなので気持ちは良くわかるんです。ただ、演算子のオーバーロードは Python のみならず、Ruby、C++、Swift、Kotlin、D などでもサポートされていることから、よくよく考えるとそこまで変な話ではないと思います。個人的には、set の和演算子 | や部分集合判定演算子 <= も初めはビビりました。

可読性、あんまり変わってなくない？

これはかなり意外な意見でした。私はディレクトリを指定する時は「このディレクトリの、親ディレクトリの、…」と考えるのですが、pathlib ではその直感に沿って右から左に書けるから、書きやすさや読みやすさは向上していると感じましたが、ここは人それぞれといったことでしょうか。

@kosui_me

19 年に DeNA 入社。23 年にカケハシ入社。現在は、薬局向け SaaS の認証認可基盤を良くしていくお仕事をしています。

kosui / ebiebievidence