📂プログラミング

Python shutilモジュールの総まとめ

概要 ¹

shutilは、ファイルやディレクトリに関する高レベル命令を集めた標準モジュールだ。Pythonを使う理由の一つは、プログラムを素早く簡単に書けることにあるが、理論的に存在すべき機能がosモジュールと混在しており、非常に不便だ。ファイルシステムを扱う場合は、両モジュールを賢く使う必要がある。

完全なまとめだが、ただ公式ドキュメントを引っ掻いたわけではなく、可能な限り実際に使われる機能を中心に説明したので、全情報は含まれていない。この投稿で目的の機能が見つからない場合は、公式ドキュメントを確認しよう。

以下の目次は、ドキュメントの順序ではなく、経験に基づく実用性の順に記載されている。上にあるほど頻繁に使われる。目次自体をチートシートとして考え、目的の関数を素早く見つけるようにしよう。

shutilの直接メソッド

削除 rmtree()

rmtree(path, ignore_errors=False, onerror=None)

• path：指定されたディレクトリ全体を削除する。shutilモジュールを使う最大の理由だ。

コピー copyfile(), copytree()

copyfile(src, dst, *, follow_symlinks=True)

• src：コピーするファイルのパスだ。sourceから来た略語だろう。
• dst：コピーされたファイルが保存されるパスだ。destinationから来た略語だろう。

copytree(src, dst, ...)

• srcをルートとする全ディレクトリツリーをdstディレクトリに再帰的にコピーする。

移動 move()

move(src, dst)

• srcをルートとする全ディレクトリツリーをdstディレクトリに再帰的に移動させる。

環境

• OS: Windows
• Python: 3.9.4