コンテンツにスキップ
CodeMDD.io | Coding Tutorials

Pythonチュートリアル：pathlibの使い方

[

Pythonのpathlibパスモジュール：ファイルシステムの制御

Python Tricks

Pythonのチュートリアル記事では、詳細な説明と実行可能なステップバイステップのサンプルコードが含まれており、情報提供を重視しています。この記事では、Pythonのpathlibパスに関するチュートリアルを提供します。pathlibパスとは、Pythonのfile操作やファイルシステムとの対話によく使用されるものです。以下では、パスを文字列で表現する際の問題、pathlibの使い方、ファイルシステム操作、そして具体的な例を示します。

パスを文字列で表現する際の問題

Pythonのpathlibを使用することで、煩雑な作業を簡素化することができます。柔軟なPathクラスが直感的なセマンティクスを提供します。しかし、pathlibが登場する前、Pythonの開発者はパスを表現するために文字列を使用するという問題に直面していました。

伝統的に、Pythonではファイルパスを通常のテキスト文字列として表現してきました。しかしながら、パスは単なる文字列以上のものであり、重要な機能は標準ライブラリ全体に分散しており、osやglob、shutilなどのライブラリに含まれていました。

以下のコードブロックは、ファイルをサブフォルダに移動する例です。

import glob
import os
import shutil


for file_name in glob.glob("*.txt"):
    new_path = os.path.join("archive", file_name)
    shutil.move(file_name, new_path)

この例では、ファイルをアーカイブフォルダに移動するために3つのimport文を使用しています。

Pythonのpathlibパスのインスタンス化

Pythonのpathlibを使用すると、独自のパスオブジェクトをインスタンス化することができます。以下では、パスオブジェクトのインスタンス化方法を詳しく説明します。

Pathメソッドの使用

pathlibのPathクラスでは、パスに関連するさまざまなメソッドを使用することができます。以下のコード例では、Pathオブジェクトを作成し、そのメソッドを使用してファイルパスを操作します。

from pathlib import Path


# ファイルの存在チェック
path = Path("example.txt")
exists = path.exists()


# ディレクトリ名を取得
directory = path.parent


# ファイル名を取得
filename = path.name


# 拡張子を取得
extension = path.suffix


# ファイルパスを連結
new_path = path / "subfolder" / "example.txt"


# ファイルパスを文字列に変換
string_path = str(path)

上記の例では、Pathオブジェクトを使って様々な操作を行っています。exists()メソッドを使用してファイルの存在を確認し、parent属性やname属性を使用してディレクトリ名やファイル名を取得します。さらに、suffix属性を使用して拡張子を取得し、/演算子を使ってパスを連結することもできます。最後に、str()関数を使ってパスを文字列に変換することも可能です。

文字列を指定してインスタンス化

パスオブジェクトは、文字列を指定して直接インスタンス化することもできます。以下のコード例では、文字列を使ってPathオブジェクトを作成します。

from pathlib import Path


path = Path("example.txt")

この例では、文字列"example.txt"を使ってPathオブジェクトを作成しています。

パスの連結

pathlibでは、パスを連結するための便利なメソッドが用意されています。以下のコード例では、pathlibのjoinpath()メソッドを使ってパスを連結しています。

from pathlib import Path


path1 = Path("folder1")
path2 = Path("folder2")
path3 = path1.joinpath(path2, "file.txt")

この例では、path1とpath2をjoinpath()メソッドで連結し、path3に結果を格納しています。結果のパスは"folder1/folder2/file.txt"となります。

パスを使ったファイルシステム操作

パスオブジェクトを使うことで、Pythonのpathlibを使って簡単にファイルシステム操作を行うことができます。以下では、パスを使ったファイルシステム操作の具体的な例を示します。

パスの構成要素の取得

パスオブジェクトを扱う上でよく使用する操作は、パスの構成要素を取得することです。以下のコード例では、Pathオブジェクトを使ってパスの構成要素を取得します。

from pathlib import Path


path = Path("path/to/filename.txt")


# ルートディレクトリ名を取得
root = path.anchor


# ドライブ名を取得（Windowsのみ）
drive = path.drive


# ディレクトリ名を取得
directory = path.parent


# ファイル名を取得
filename = path.name


# 拡張子を取得
extension = path.suffix


# パスのコンポーネントをリストとして取得
path_list = list(path.parts)

上記の例では、Pathオブジェクトを使ってパスの構成要素を取得しています。anchor属性を使うことでルートディレクトリ名を取得し、drive属性を使うことでドライブ名を取得することができます。また、parent属性を使ってディレクトリ名、name属性を使ってファイル名、suffix属性を使って拡張子を取得することもできます。さらに、parts属性はパスのコンポーネントをリストとして取得します。

ファイルの読み書き

pathlibは、ファイルの読み書きを簡単に行うためのメソッドも提供しています。以下のコード例では、pathlibを使ってファイルの読み書きを行っています。

from pathlib import Path


# ファイルを作成する
path = Path("example.txt")
path.touch()


# ファイルを読み込む
content = path.read_text()


# ファイルに書き込む
path.write_text("Hello, World!")


# バイトデータを読み込む
content_bytes = path.read_bytes()


# バイトデータを書き込む
path.write_bytes(content_bytes)

上記の例では、Pathオブジェクトを使ってファイルの作成や読み書きを行っています。touch()メソッドを使用してファイルを作成し、read_text()メソッドやwrite_text()メソッドを使用してテキストデータの読み書きを行います。また、read_bytes()メソッドやwrite_bytes()メソッドを使うことでバイトデータの読み書きも可能です。

ファイルのリネーム

ファイルのリネームも、pathlibを使えば簡単に行うことができます。以下のコード例では、pathlibを使ってファイルのリネームを行っています。

from pathlib import Path


path = Path("example.txt")
new_path = path.with_name("new_example.txt")


# ファイルをリネームする
path.rename(new_path)

上記の例では、with_name()メソッドを使って新しいファイル名を指定し、rename()メソッドを使用してファイルをリネームしています。

ファイルのコピー

ファイルのコピーも、pathlibを使えば簡単に行うことができます。以下のコード例では、pathlibを使ってファイルのコピーを行っています。

from pathlib import Path


path = Path("example.txt")
new_path = Path("copy.txt")


# ファイルをコピーする
path.copy2(new_path)

上記の例では、copy2()メソッドを使用してファイルをコピーしています。

ファイルの移動と削除

ファイルの移動や削除も、pathlibを使えば簡単に行うことができます。以下のコード例では、pathlibを使ってファイルの移動と削除を行っています。

from pathlib import Path


# ファイルを移動する
path = Path("example.txt")
new_path = Path("new_folder/example.txt")
path.rename(new_path)


# ファイルを削除する
new_path.unlink()

上記の例では、rename()メソッドを使用してファイルを移動し、unlink()メソッドを使用してファイルを削除しています。

空のファイルを作成する

pathlibを使えば、簡単に空のファイルを作成することができます。以下のコード例では、pathlibを使って空のファイルを作成しています。

from pathlib import Path


path = Path("empty.txt")


# 空のファイルを作成する
path.touch()

上記の例では、touch()メソッドを使用して空のファイルを作成しています。

Python pathlibの具体的な例

pathlibを使ってさまざまなファイル操作を行うことができます。以下では、具体的な例をいくつか紹介します。

ファイルの数をカウントする

特定のディレクトリ内のファイルの数をカウントする場合、pathlibを使うと簡単に行うことができます。以下のコード例では、pathlibを使ってファイルの数をカウントしています。

from pathlib import Path


directory = Path("dir")


# ディレクトリ内のファイルの数をカウントする
file_count = len(list(directory.iterdir()))

上記の例では、iterdir()メソッドを使用してディレクトリ内のすべてのファイルをリスト化し、len()関数を使ってファイルの数をカウントしています。

ディレクトリツリーを表示する

ファイルシステムのディレクトリツリーを表示する場合も、pathlibを使えば簡単に行うことができます。以下のコード例では、pathlibを使ってディレクトリツリーを表示しています。

from pathlib import Path


def display_directory_tree(directory, level=0):
    indent = "  " * level
    print(f"{indent}- {directory.name}/")
    for path in directory.iterdir():
        if path.is_dir():
            display_directory_tree(path, level + 1)
        else:
            print(f"{indent}  - {path.name}")


directory = Path("dir")


# ディレクトリツリーを表示する
display_directory_tree(directory)

上記の例では、再帰的にディレクトリを表示するためにdisplay_directory_tree()関数を定義しています。is_dir()メソッドを使ってディレクトリかファイルかを判定し、print()関数を使ってディレクトリとファイルを表示しています。

最も最近更新されたファイルを検索する

特定のディレクトリ内で最も最近更新されたファイルを検索する場合も、pathlibを使えば簡単に行うことができます。以下のコード例では、pathlibを使って最も最近更新されたファイルを検索しています。

from pathlib import Path


directory = Path("dir")


# 最も最近更新されたファイルを検索する
recent_file = max(directory.iterdir(), key=lambda f: f.stat().st_mtime)

上記の例では、iterdir()メソッドを使用してディレクトリ内のすべてのファイルをリスト化し、max()関数を使って最も最近更新されたファイルを検索しています。stat()メソッドを使ってファイルの状態を取得し、st_mtime属性を使って更新日時を比較しています。

一意のファイル名を作成する

重複しない一意のファイル名を作成する場合も、pathlibを使って簡単に行うことができます。以下のコード例では、pathlibを使って一意のファイル名を作成しています。

from pathlib import Path


directory = Path("dir")
base_name = "file.txt"
index = 0


# 一意のファイル名を作成する
while (new_path := directory / f"{base_name}-{index}") in directory.iterdir():
    index += 1

上記の例では、ディレクトリ内で重複しない一意のファイル名を作成するためにループを使用しています。iterdir()メソッドを使ってディレクトリ内のファイルをリスト化し、ファイル名の末尾にインデックスを付けています。同名のファイルが存在する場合、インデックスを増やして重複しない名前を作成します。

まとめ

Pythonのpathlibモジュールを使うことで、ファイルシステムとの操作が簡単になります。このチュートリアルでは、pathlibを使ったパスの操作方法やファイルシステムの操作方法について詳しく説明しました。さらに、具体的なコード例をいくつか紹介しました。これらのコード例は、日常的なファイル操作に役立つものです。

pathlibは標準ライブラリの一部であり、Pythonのバージョン3.4以降で使用することができます。パスを文字列で表現する際の問題を解決し、直感的な操作が可能になるため、Pythonのファイルシステム操作では広く採用されています。

ぜひこのチュートリアルのコード例を自分のプロジェクトに活用して、よりスマートなファイル操作を実現しましょう。