Python

Python入門ガイド: 効率的なファイルとディレクトリ操作を学ぶ

 

ファイルとディレクトリの操作は、Python開発者にとって重要なスキルです。この記事では、Pythonの標準ライブラリを活用して、ファイルの読み書き、ディレクトリの作成や削除、パスの操作など、さまざまなファイルとディレクトリ関連の操作方法を解説します。

外部ファイルを利用する事で、設定を管理するファイルを置いたり、データを永続化したりすることが可能になります。これらの機能を利用する事でアプリケーションの幅が大きく広がります。

ファイル入出力

ファイルへのデータの書き込みや読み出しは、Pythonの基本的な機能の一つです。以下のコード例を通じて、open()関数を使用してファイルを作成し、テキストやバイナリデータを書き込む方法や読み出すには下記のサンプルのようにします。

# ファイルへの書き込み
with open("sample.txt", "w") as file:
    file.write("Hello, World!")

# ファイルからの読み出し
with open("sample.txt", "r") as file:
    content = file.read()
    print(content)

open()関数の構文は次のとおりです。

open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

主なオプション引数について説明します。

  1. file (必須): 開くファイルのパスを指定します。
  2. mode (省略可能): ファイルを開くモードを指定します。主なモードは以下の通りです。
    • 'r': 読み取りモードでファイルを開きます。既定値です。
    • 'w': 書き込みモードでファイルを開きます。既存の内容は削除され、新しい内容が書き込まれます。
    • 'x': 排他的な作成モードでファイルを開きます。ファイルが存在しない場合にのみ作成されます。
    • 'a': 追記モードでファイルを開きます。ファイルの末尾に新しい内容が追加されます。
    • 'b': バイナリモードでファイルを開きます。
    • 't': テキストモードでファイルを開きます。既定値です。
    • '+': 読み取り/書き込みモードでファイルを開きます。
  3. buffering (省略可能): バッファリングの方法を指定します。0または1を指定することでバッファリングを有効にすることができます。デフォルト値は-1で、システムのデフォルト設定を使用します。
  4. encoding (省略可能): ファイルのエンコーディングを指定します。テキストファイルを読み取る場合に使用されます。
  5. errors (省略可能): エンコーディングエラーの処理方法を指定します。'strict'（既定値）、'ignore'、'replace'などが指定できます。
  6. newline (省略可能): 改行文字の処理方法を指定します。None（既定値）、''、'\n'、'\r'、'\r\n'などが指定できます。
  7. closefd (省略可能): fileパラメーターにファイル記述子が与えられた場合に、ファイルクローズ時にそのファイル記述子（が参照するファイル）もクローズするかどうかを指定します。Trueを指定すると元のファイル記述子もクローズされ、Falseを指定すると元のファイル記述子はオープンされたままとなります。
  8. opener (省略可能): カスタムのファイルオープナー関数を指定します。通常は使用されません。

open()関数の簡単なサンプルを下記に示します。

# ファイルを読み取りモードで開く
file = open('example.txt', 'r')

# ファイルを書き込みモードで開く（既存の内容は削除される）
file = open('example.txt', 'w')

# ファイルを追記モードで開く（既存の内容の末尾に追加する）
file = open('example.txt', 'a')

# バイナリモードでファイルを開く
file = open('example.bin', 'rb')

# ファイルを読み取り/書き込みモードで開く
file = open('example.txt', 'r+')

# エンコーディングを指定してファイルを開く
file = open('example.txt', 'r', encoding='utf-8')

# バッファリングを有効にしてファイルを開く
file = open('example.txt', 'r', buffering=1)

open()関数でファイルを開いた後は、ファイルオブジェクトを使用して読み取りや書き込みなどの操作を行うことができます。操作が完了したら、close()メソッドを使用してファイルを閉じることを忘れないようにしてください。

file = open('example.txt', 'r')
content = file.read()
print(content)
file.close()

ただし、ファイルを操作する際には、コンテキストマネージャ(with文)を使用することを推奨します。これにより、ファイルを自動的に閉じることができます。通常はこちらを使用します。

with open('example.txt', 'r') as file:
    content = file.read()
    print(content)
# ファイルは自動的に閉じられる

メモリマッピング

Pythonのmmapモジュールは、メモリマップドファイルへのアクセスを提供するためのモジュールです。メモリマップドファイルは、ファイルの内容を直接メモリにマップすることで、高速な読み書きが可能になります。mmapモジュールを使用することで、ファイルを一部または全部メモリにマップし、通常のファイル操作のように扱うことができます。

メモリマッピングを使用すると、大きなファイルの内容をメモリにマッピングして効率的に読み書きすることができます。以下のコード例では、mmapモジュールを使用してメモリマッピングを実現する方法を示します。

import mmap

# ファイルをメモリにマッピング
with open("large_file.bin", "r+b") as file:
    mmapped_file = mmap.mmap(file.fileno(), 0)

# メモリ上のデータを操作
data = mmapped_file[:100]
print(data)

# マッピング解除
mmapped_file.close()

使用方法は次のようになります。

mmap.mmap(fileno, length, flags=MAP_SHARED, prot=PROT_READ|PROT_WRITE, access=ACCESS_DEFAULT, offset=0)

メモリマップドファイルを作成します。filenoはファイルディスクリプタを指定し、lengthはマップする範囲のバイト数を指定します。オプションの引数flags、prot、access、offsetはそれぞれマップの動作やアクセス権限を指定するためのものです。
以下はアクセス権限の定数です。

  1. mmap.ACCESS_READ: 読み取り専用アクセスを指定します。
  2. mmap.ACCESS_WRITE: 書き込み可能なアクセスを指定します。
  3. mmap.ACCESS_COPY: メモリのコピーを作成してアクセスします。
  4. mmap.ACCESS_DEFAULT: デフォルトのアクセス権限を使用します。

メモリマップドファイルは、通常のファイルと同様にインデックスやスライスを使用してアクセスすることができます。

import mmap

# ファイルをメモリにマップする
with open('example.txt', 'r') as file:
    with mmap.mmap(file.fileno(), 0, access=mmap.ACCESS_READ) as mm:
        # メモリマップドファイルの内容を読み取る
        content = mm.read()
        print(content)

メモリマップドファイルを使用すると、大容量のファイルの高速な読み書きが可能になります。

メモリマップドファイルを使用する際には、いくつかの注意事項があります。

  1. メモリマップドファイルは、ファイルの内容を直接メモリにマップするため、大きなファイルをマップしようとするとメモリの消費量が増える可能性があります。メモリの制限に注意して使用してください。
  2. メモリマップドファイルを変更すると、元のファイルも変更されます。データの書き込みを行う際は注意してください。
  3. mmapオブジェクトはコンテキストマネージャ(with文)とともに使用することを推奨します。これにより、自動的にメモリマップドファイルが解放されます。
  4. mmapオブジェクトはバイトシーケンスとして扱われるため、必要に応じて適切なエンコーディングを使用してデータを操作してください。
  5. メモリマップドファイルを使用する際には、適切なアクセス権限やマップのフラグを指定してセキュリティを確保してください。

以上が、Pythonのmmapモジュールを使用してメモリマップドファイルを操作するための基本的な情報です。メモリマップドファイルは、大容量のファイルを効率的に処理する場合や、複数のプロセスが同じファイルにアクセスする場合などに役立ちます。適切に使用することで、高速で効率的なファイルアクセスが可能となります。

osモジュールの解説

Pythonのosモジュールは、オペレーティングシステムと対話するための機能を提供します。osモジュールを使用することで、ファイルやディレクトリの操作、プロセスの管理、環境変数の取得など、さまざまなオペレーティングシステム関連の機能を利用できます。以下では、osモジュールの一部の機能を解説します。

ファイルおよびディレクトリ操作:

  1. os.getcwd(): 現在の作業ディレクトリを取得します。
  2. os.chdir(path): 作業ディレクトリを指定したパスに変更します。
  3. os.listdir(path): 指定したディレクトリ内のファイルとディレクトリのリストを取得します。
  4. os.mkdir(path): 指定したパスに新しいディレクトリを作成します。
  5. os.rmdir(path): 指定したパスのディレクトリを削除します。
  6. os.remove(path): 指定したパスのファイルを削除します。
  7. os.rename(src, dst): ファイルまたはディレクトリの名前を変更します。

プロセス管理:

  1. os.fork(): 新しいプロセスを作成します（UNIXのみ）。
  2. os.execv(path, args): 指定したパスのプログラムを実行します。
  3. os.kill(pid, sig): 指定したプロセスIDのプロセスにシグナルを送信します。

環境変数:

  1. os.getenv(key): 指定したキーの環境変数の値を取得します。
  2. os.putenv(key, value): 指定したキーと値の組で環境変数を設定します。
  3. os.environ: 現在の環境変数を表す辞書オブジェクトです。

パス操作:

  1. os.path.join(path1, path2, ...): 複数のパス要素を連結して新しいパスを作成します。
  2. os.path.abspath(path): 相対パスを絶対パスに変換します。
  3. os.path.exists(path): 指定したパスが存在するかどうかを確認します。
  4. os.path.isdir(path): 指定したパスがディレクトリであるかどうかを確認します。
  5. os.path.isfile(path): 指定したパスがファイルであるかどうかを確認します。

これらはosモジュールの一部の機能です。他のosモジュールの機能としては、以下のようなものがあります。

ファイル操作:

  1. os.path.getsize(path): ファイルのサイズをバイト単位で取得します。
  2. os.path.getctime(path): ファイルの作成時刻を取得します。
  3. os.path.getmtime(path): ファイルの最終更新時刻を取得します。
  4. os.path.splitext(path): パスから拡張子を含まない部分と拡張子の部分を分割します。

パス操作:

  1. os.path.dirname(path): パスのディレクトリ名部分を取得します。
  2. os.path.basename(path): パスのベース名（ディレクトリを除いた部分）を取得します。
  3. os.path.exists(path): パスが存在するかどうかを確認します。
  4. os.path.isabs(path): パスが絶対パスかどうかを確認します。
  5. os.path.join(path1, path2, ...): 複数のパス要素を連結して新しいパスを作成します。
  6. os.path.abspath(path): 相対パスを絶対パスに変換します。

その他の機能:

  1. os.name: オペレーティングシステムの名前を取得します。
  2. os.system(command): シェルコマンドを実行します。
  3. os.urandom(n): 暗号学的に安全な乱数を生成します。
  4. os.walk(top, topdown=True, onerror=None, followlinks=False): 指定したディレクトリ以下のファイルとディレクトリを再帰的に取得します。

これらはosモジュールの一部の機能ですが、osモジュールにはさらに多くの関数や定数が存在します。
osモジュールは、オペレーティングシステムとの対話やファイルシステム操作に非常に便利です。異なるプラットフォームでの移植性を考慮しながら、ファイルやディレクトリの作成、移動、削除、プロセスの管理、環境変数の取得など、さまざまなタスクを実行するために利用できます。

ファイル操作

ファイルの存在チェックやコピー、名前の変更、パーミッションの変更など、ファイルの基本的な操作方法を紹介します。以下のコード例では、標準ライブラリのosモジュールを使用してこれらの操作を行います。

import os

# ファイルの存在チェック
if os.path.exists("sample.txt"):
    print("ファイルが存在します")

# ファイルのコピー
os.rename("sample.txt", "sample_copy.txt")

# ファイルの削除
os.remove("sample_copy.txt")

ディレクトリ操作

ディレクトリの作成や削除、ディレクトリ内のファイル一覧の取得など、ディレクトリに関する操作方法を詳しく解説します。以下のコード例を通じて、ディレクトリ操作を下記に示します。

import os

# ディレクトリの作成
os.mkdir("my_directory")

# ディレクトリ内のファイル一覧の取得
file_list = os.listdir("my_directory")
print(file_list)

# カレントディレクトリの変更
os.chdir("my_directory")
current_dir = os.getcwd()
print(current_dir)

# ディレクトリの削除
os.rmdir("my_directory")

パス名

パス名の取得や組み立て、シンボリックリンクパス名の解決など、パス操作に関する便利な関数やモジュールを紹介します。

pathlibモジュール

pathlibモジュールは、Python 3.4以降で利用可能な、パス操作を行うためのモジュールです。このモジュールは、OSに依存しないパスの操作を簡単かつ直感的に行うことができます。pathlibモジュールは、ファイルやディレクトリのパスをオブジェクトとして表現し、それらのオブジェクトに対して操作を行うことができます。

以下に、pathlibモジュールの主なクラスとメソッドを解説します。

Pathクラス:

Pathクラスは、ファイルシステムのパスを表現するためのクラスです。Pathオブジェクトを作成することで、パスに関する操作を行うことができます。

  1. Path(path): 指定されたパスを表すPathオブジェクトを作成します。
  2. pathlib.Path.cwd(): 現在の作業ディレクトリを表すPathオブジェクトを返します。
  3. Path.exists(): パスが存在するかどうかを判定します。
  4. Path.is_file(): パスがファイルかどうかを判定します。
  5. Path.is_dir(): パスがディレクトリかどうかを判定します。
  6. Path.name: パスの末尾の部分（ファイル名またはディレクトリ名）を取得します。
  7. Path.suffix: パスの拡張子を取得します。
  8. Path.parent: パスの親ディレクトリを表すPathオブジェクトを取得します。
  9. Path.parts: パスの各要素をタプルとして取得します。
  10. Path.joinpath(*paths): 複数のパス要素を連結して新しいPathオブジェクトを作成します。
  11. Path.resolve(): パスを絶対パスに変換します。
  12. Path.glob(pattern): 指定したパターンにマッチするパスをイテレートするジェネレータを返します。

以下は、pathlibモジュールの使用例です。

from pathlib import Path

# ファイルパスを作成
file_path = Path('path/to/file.txt')

# パスが存在するか確認
if file_path.exists():
    print('File exists!')

# ファイル名を取得
print(file_path.name)  # file.txt

# 拡張子を取得
print(file_path.suffix)  # .txt

# 親ディレクトリを取得
print(file_path.parent)  # path/to

# ファイルパスを絶対パスに変換
abs_file_path = file_path.resolve()
print(abs_file_path) # 絶対パス

# パスの要素を取得
print(file_path.parts) # ('path', 'to', 'file.txt')

# ファイルパスを変更して新しいパスを作成
new_file_path = file_path.with_name('new_file.txt')
print(new_file_path) # path/to/new_file.txt

# ディレクトリ内の特定のファイルを検索
for path in Path('path/to/directory').glob('*.txt'):
    print(path) # path/to/directory/file1.txt, path/to/directory/file2.txt, ...

pathlibモジュールを使用すると、パスの操作が直感的で読みやすくなります。オブジェクト指向のインターフェースを提供するため、ファイルパスの組み立てや操作、存在確認、ファイルの検索など、さまざまなタスクを効率的に実行することができます。また、OSに依存せずに動作するため、プラットフォームの違いに対処する必要がありません。

以下のコード例では、os.pathモジュールとpathlibモジュールを使用してパス操作を行います。

import os
from pathlib import Path

# 絶対パスの取得
absolute_path = os.path.abspath("sample.txt")
print(absolute_path)

# シンボリックリンクパスの解決
real_path = os.path.realpath("symlink")
print(real_path)

# パスの組み立て
file_name = "sample.txt"
directory = "/path/to/directory"
path = os.path.join(directory, file_name)
print(path)

# pathlibの使用
path = Path("sample.txt")
print(path.name)
print(path.suffix)
print(path.parent)

BytesIOとStringIO

BytesIOとStringIOは、メモリ上でバイナリデータやテキストデータを扱うための便利なツールです。

BytesIOクラス:

BytesIOクラスは、バイトデータを扱うためのメモリバッファを提供します。主なメソッドとしては以下のものがあります。

  1. getvalue(): バッファ内のデータ全体をバイト列として取得します。
  2. write(b): バッファにバイトデータを書き込みます。
  3. read(n): バッファから指定されたバイト数を読み取ります。
  4. seek(offset[, whence]): バッファ内の現在位置を移動します。

StringIOクラス:

StringIOクラスは、文字列データを扱うためのメモリバッファを提供します。主なメソッドとしては以下のものがあります。

  1. getvalue(): バッファ内のデータ全体を文字列として取得します。
  2. write(s): バッファに文字列データを書き込みます。
  3. read(n): バッファから指定された文字数を読み取ります。
  4. seek(offset[, whence]): バッファ内の現在位置を移動します。

以下のコード例では、BytesIOとStringIOを使ってメモリ上でのデータ操作を行います。

from io import BytesIO, StringIO

# BytesIOを使用してバイナリデータを扱う
byte_data = b"Hello, World!"
byte_io = BytesIO(byte_data)
content = byte_io.read()
print(content)

# StringIOを使用してテキストデータを扱う
text_data = "Hello, World!"
text_io = StringIO(text_data)
content = text_io.read()
print(content)

BytesIOクラスとStringIOクラスは、それぞれバイトデータと文字列データを操作するためのメモリバッファを提供します。これらのクラスは、ファイル操作と同様のインターフェースを提供するため、ファイルにアクセスするようなコードを簡単に書くことができます。また、一時的なデータの保存や、バッファリングなどの用途にも利用されます。

以下に、BytesIOクラスとStringIOクラスの特徴をまとめます。

  1. メモリ内にバッファを作成してデータを保持します。ファイルに書き込む代わりに、メモリ内でデータの読み書きが行われます。
  2. バイトデータ（BytesIO）や文字列データ（StringIO）を扱うことができます。
  3. write()メソッドを使用してデータを書き込み、read()メソッドを使用してデータを読み取ります。
  4. seek()メソッドを使用してバッファ内の位置を移動することができます。これにより、読み取りや書き込みの位置を制御することができます。
  5. getvalue()メソッドを使用して、バッファ内のデータ全体をバイト列（BytesIO）または文字列（StringIO）として取得することができます。
  6. close()メソッドを使用してバッファをクローズし、リソースを解放することができます。ただし、通常はクローズする必要はありません。

これらのクラスは、特にファイルやネットワークからデータを読み込んだり、データを書き込んだりする際に便利です。また、テストやデータ処理など、一時的なデータの保存や操作にも役立ちます。

応用アプリケーション（スケジュール管理アプリケーション）

これらのファイルとディレクトリ操作の知識を活用して、スケジュール管理アプリケーションを作成してみましょう。このアプリケーションは、ユーザーが予定やイベントを作成し、それをファイルに保存する機能を持ちます。また、保存されたスケジュールを読み出して表示する機能も備えています。

以下は、簡単なスケジュール管理アプリケーションのコード例です。

import os

def create_event(event_name, date):
    event = f"{event_name}: {date}\n"
    with open("schedule.txt", "a") as file:
        file.write(event)

def display_schedule():
    if os.path.exists("schedule.txt"):
        with open("schedule.txt", "r") as file:
            content = file.read()
            print(content)
    else:
        print("スケジュールはありません")

# イベントの作成
create_event("ミーティング", "2023-06-01")
create_event("誕生日パーティー", "2023-06-10")
create_event("旅行", "2023-06-15")

# スケジュールの表示
display_schedule()

この応用アプリケーションでは、create_event()関数を使用してイベントを作成し、それをファイルに追加保存します。また、display_schedule()関数を使用して保存されたスケジュールを読み出して表示します。

まとめ

以上が、ファイルとディレクトリ操作に関する解説です。この記事では、Pythonの標準ライブラリを活用してファイルとディレクトリを操作する方法を学びました。

まず、ファイル入出力については、open()関数を使用してファイルを作成・オープンし、write()関数やread()関数を使ってテキストやバイナリデータを書き込みや読み出しを行いました。また、with文を使用することで、ファイルの自動的なクローズを実現しました。

次に、ファイルとディレクトリの操作方法について学びました。存在チェックやファイルタイプの判定、コピー・削除・リネームなどの操作を行うための関数やメソッドを紹介しました。さらに、ディレクトリ内のファイル一覧の作成やカレントディレクトリの変更、パターンにマッチするファイルのリスト作成など、便利な機能も紹介しました。

最後に、パス名に関する操作についても触れました。パス名の取得や組み立て、シンボリックリンクの解決など、ファイルやディレクトリのパス操作を行うための関数やクラスを紹介しました。

これらの機能を活用することで、Pythonを使ったファイルやディレクトリの操作が容易になります。例として、スケジュール管理アプリケーションを作成しました。このアプリケーションでは、イベントの作成と保存、保存されたスケジュールの表示を行います。

これらの知識を活用して、Pythonの開発でファイルやディレクトリ操作を効果的に行いましょう。

Python
こちらもおすすめ！！