［解決！Python］os.pathモジュールのexists関数を使ってパスが存在するかどうかを確認するには：解決！Python

exists関数に渡したパスが実際に存在するかどうかを確認したり、isdir／isfile関数と組み合わせて処理を振り分けたりする方法を紹介する。

[かわさきしんじ，Deep Insider編集部]

印刷

通知 連載「解決！Python」の新着をメールで通知

見るPost

Shareシェア

はてなブックマーク

SharePocket Button

連載目次

import os
from os.path import exists, splitext, isdir, isfile

mydir = 'mydir'
myfile = 'myfile.txt'
nofile_or_dir = 'nofile_or_dir'

# mydirディレクトリとmyfile.txtファイルを作成
os.mkdir(mydir)

with open(myfile, 'w'):
    pass

print(exists(mydir))  # True
print(exists(myfile))  # True
print(exists(nofile_or_dir))  # False

# ディレクトリが存在しなければ作成する
if not exists(mydir):
    os.mkdir(mydir)
else:
    print(f'{mydir} already exists')

# ファイルが存在していればバックアップを取り、書き込みを行う
if exists(myfile):
    newfile = splitext(myfile)[0] + '.bak'
    os.rename(myfile, newfile)

with open(myfile, 'w') as f:
    f.write('some text')

# 指定されたファイル／ディレクトリの存在確認の後、処理を振り分ける
def do_some_work(path):
    if not exists(path):
        res = input(f'{path} not exists. create it? (y/n)')
        if res == 'y':
            with open(path, 'w'):
                pass

    if isdir(path):
        print(f'{path} is a directory')
    elif isfile(path):
        print(f'{path} is a file')
    else:
        print(f'{path} is not a directory nor file')

paths = [mydir, myfile, nofile_or_dir]
for path in paths:
    do_some_work(path)

os.pathモジュールのexists関数

　os.pathモジュールのexists関数は引数に指定したパス（文字列またはpathlibモジュールで定義されるPathクラスのインスタンスなど）が実際に存在するディレクトリやファイルを指しているかどうかを調べるのに使える。パスが存在していればTrueが、そうでなければFalseが返される。

　以下に例を示す。

import os
from os.path import exists, splitext, isdir, isfile

mydir = 'mydir'
myfile = 'myfile.txt'
nofile_or_dir = 'nofile_or_dir'

# mydirディレクトリとmyfile.txtファイルを作成
os.mkdir(mydir)

with open(myfile, 'w'):
    pass

print(exists(mydir))  # True
print(exists(myfile))  # True
print(exists(nofile_or_dir))  # False

　このコードではまずmydirディレクトリをosモジュールのmkdir関数を使って作成し、その後、myfile.txtファイルを作成している。変数nofile_or_dirの値である「nofile_or_dir」という名前のファイルやディレクトリは存在していない。なお、os.pthモジュールを使用したディレクトリの作成については「ディレクトリを作成／削除するには：osモジュール編」を、open関数を使ったファイルの作成については「ファイルを作成／削除するには」を参照されたい。

　最後の3行ではexists関数を使って3つのパス（mydir、mydir.txt、nofile_or_dir）についてディレクトリやファイルが存在しているかを試している。最初の2つについてはその上で作成しているのでTrueが、最後のnofile_or_dirについてはそのような名前のディレクトリもファイルもないのでFalseが返されている。

続きを読む

　osモジュールのmkdir関数は指定した名前のディレクトリ（またはファイル）が既に存在しているときには例外を発生させる。これを回避するには、exists関数で指定したパスが存在するかどうかを確認するとよい。以下に例を示す。

if not exists(mydir):
    os.mkdir(mydir)
else:
    print(f'{mydir} already exists')

　また、ファイルを新規に作成して、そこに何かを書き込みたいが、同名のファイルがあればそのファイルの拡張子を「.bak」に変更する必要があるといった場合には次のようなコードが書ける。

if exists(myfile):
    newfile = splitext(myfile)[0] + '.bak'
    os.rename(myfile, newfile)

with open(myfile, 'w') as f:
    f.write('some text')

　最初のif文ではexists関数で変数myfileが指すパスが存在しているかどうかを確認している。その名前のディレクトリまたはファイルが存在していれば、os.pathモジュールのsplitext関数を使って変数myfileの値である「myfile.txt」を拡張子とそれ以外の部分に分離し（splitext関数の戻り値は「(拡張子以外, 拡張子)」というタプル）、拡張子以外の部分と'.bak'を結合してバックアップファイルの名前を作成して、os.rename関数で名前を変更している。その後、元のファイル（myfile.txt）を書き込みモードでオープンしてテキストを書き込んでいる（os.rename関数でファイル名を変更しているので、ファイルをオープンするまではmyfile.txtファイルは存在していないことには注意）。

　このように「パスの存在確認」に続けて何かの処理を行うことはよくあるだろう。そのときには「os.pathモジュールのisdir／isfile関数を使ってパスがディレクトリやファイルであるかどうかを調べるには」で紹介したisdir／isfile関数と組み合わせることが考えられる。

　以下に例を示す。

def do_some_work(path):
    if not exists(path):
        res = input(f'{path} not exists. create it? (y/n)')
        if res == 'y':
            with open(path, 'w'):
                pass

    if isdir(path):
        print(f'{path} is a directory')
    elif isfile(path):
        print(f'{path} is a file')
    else:
        print(f'{path} is not a directory nor file')

paths = [mydir, myfile, nofile_or_dir]
for path in paths:
    do_some_work(path)

　関数の先頭では、パスが存在するかどうかを確認し、存在していない場合はファイルを作成するかどうかを問い合わせて、その返答に応じてファイルを作成するかどうかを決めている。その後、渡されたパスの種類に応じて、if文で処理を切り分けるようにしている。

「解決！Python」

この連載を「連載記事アラート」に登録する New