できない.dev

ファイルが存在するか調べるには

ファイルの有無を調べる基本形を各言語で示す。
ディレクトリと区別する判定と、確認してから開くまでの間に状態が変わりうる点まで扱う。

公開: 更新:

選んだ言語は、ほかのサンプルコードを開いたときも最初に表示する。

Python

from pathlib import Path
 
p = Path("a.txt")
if p.is_file():
    print("exists")

Path.is_file() はパスが存在し、かつ通常のファイルであるときだけ True を返す。
exists() はディレクトリでも True になるため、開くことが前提の判定には is_file() を使う。

JavaScript

import { stat } from "node:fs/promises";
 
const exists = await stat("a.txt")
  .then((s) => s.isFile())
  .catch(() => false);

fs/promises の stat は対象が無いと ENOENT で reject するので、catch で false に倒して真偽値にする。
同期版の existsSync は手軽だがイベントループを止めるため、非同期処理の中では避ける。

TypeScript

import { stat } from "node:fs/promises";
 
const exists: boolean = await stat("a.txt")
  .then((s) => s.isFile())
  .catch(() => false);

書き方は JavaScript と同じで、catch を挟むと戻り値の型が広がるため boolean と明示しておくと後続の分岐で扱いやすい。

Go

package main
 
import (
	"errors"
	"fmt"
	"io/fs"
	"log"
	"os"
)
 
func check(name string) {
	info, err := os.Stat(name)
	switch {
	case errors.Is(err, fs.ErrNotExist):
		fmt.Println(name, "not found")
	case err != nil:
		log.Fatal(err) // 権限不足など、存在の有無以外の理由で調べられなかった
	case info.Mode().IsRegular():
		fmt.Println(name, "exists")
	default:
		fmt.Println(name, "exists, but not a regular file")
	}
}
 
func main() {
	check("a.txt")       // a.txt exists
	check("dir")         // dir exists, but not a regular file
	check("missing.txt") // missing.txt not found
}

os.Stat のエラーには権限不足なども含まれるため、err != nil をそのまま「存在しない」と読み替えてはいけない。
存在しないことだけを判定するときは errors.Is(err, fs.ErrNotExist) を使う。

Rust

use std::fs;
use std::io::ErrorKind;
use std::path::Path;
 
fn main() {
    println!("{}", Path::new("a.txt").is_file()); // true
    println!("{}", Path::new("dir").is_file()); // false(ディレクトリ)
    println!("{}", Path::new("missing.txt").is_file()); // false
 
    // 無いのか調べられないのかを区別したいときは metadata の Result を見る
    match fs::metadata("missing.txt") {
        Ok(m) => println!("exists, is_file = {}", m.is_file()),
        Err(e) if e.kind() == ErrorKind::NotFound => println!("not found"), // こちらが出る
        Err(e) => println!("error: {e}"),
    }
}

Path::is_file は内部でメタデータを取得し、取得できなければ false を返す。
存在しないのか権限が無いのかを区別したい場合は、fs::metadata の Result を直接見て、エラーの kind が NotFound か PermissionDenied かで分ける。

Java

import java.nio.file.Files;
import java.nio.file.Path;
 
public class Main {
    public static void main(String[] args) {
        System.out.println(Files.isRegularFile(Path.of("a.txt")));       // true
        System.out.println(Files.isRegularFile(Path.of("dir")));         // false(ディレクトリ)
        System.out.println(Files.isRegularFile(Path.of("missing.txt"))); // false
 
        // exists はディレクトリでも true になる
        System.out.println(Files.exists(Path.of("dir"))); // true
 
        // 存在しないと確かめられたときだけ true になるのは notExists
        System.out.println(Files.notExists(Path.of("missing.txt"))); // true
    }
}

Files.isRegularFile は存在しない場合も属性を読めない場合も false を返す。
Files.exists はディレクトリでも true になるため、ファイルとして開く前提なら isRegularFile を選ぶ。
存在しないと確かめられたときだけ true になる Files.notExists もあり、権限不足で調べられないときは exists も notExists も false になる。

C#

using System;
using System.IO;
 
class Program {
    static void Main() {
        Console.WriteLine(File.Exists("a.txt"));       // True
        Console.WriteLine(File.Exists("dir"));         // False(ディレクトリ)
        Console.WriteLine(File.Exists("missing.txt")); // False
 
        // ディレクトリの有無は Directory.Exists で調べる
        Console.WriteLine(Directory.Exists("dir")); // True
    }
}

File.Exists は対象がディレクトリのときや権限が無いときも例外を投げず false を返す。
FileInfo.Exists も同じ挙動なので、判定できなかったのか本当に無いのかを区別したい場合は、実際に開いたときの例外(FileNotFoundException か UnauthorizedAccessException)で確かめる。

存在確認とディレクトリの区別

多くの言語には「存在する」を返す関数と「通常ファイルである」を返す関数の両方がある。
前者は同名のディレクトリがあっても真を返すため、これから開いて読むつもりのパスに対しては後者を使うのが安全である。
ディレクトリを開こうとして実行時に失敗する事故は、この取り違えから起きる。

つまずき

存在確認をしてから実際に開くまでの間に、別のプロセスがそのファイルを消したり作ったりできる。
したがって「確認してから開く」は競合状態を完全には防げない。
確実に扱いたい場合は、確認せずに開いてしまい、失敗したときの例外やエラーを捕まえるほうがよい。
存在確認は「無ければ処理をスキップする」といった、ずれても実害の小さい用途に向く。