Суть функции IsNotExist()?

Question

[Vadim Rublev]

В чём смысл функции os.IsNotExist()? Она ведь использует функцию os.Stat(), получая её ошибку - if _, err := os.Stat(filename); os.IsNotExist(err) { ... }.
( Инфо: https://golang.org/pkg/os/#IsNotExist )
Почему не использовать просто функцию os.Stat()? (Как некоторые и делают.)

И попутно: функция IsNotExist() возвращает true - если файл не существует, и false - если файл существует? Т. е.?:
if _, err := os.Stat(filename); os.IsNotExist(err) {
fmt.Println("file does not exist") - это_true
} else {
_файл_найден_ - это_false
}

Answer 1

[Владислав]

os.IsNotExist(err) проверяет ошибку, что это ошибка отсутствия файла, можно проверять ошибку не только Stat, но и ошибку при открытии файла.

Stat может вернуть не только ошибку не найденного файла, но и ошибку ввода/вывода, таймаут и ещё букет ошибок, для этого и используется доп проверка ошибки os.IsNotExist(err)

Не верное заключение по поводу примера кода, верно так:

_, err := os.Stat(filename)
if err != nil {
    if os.IsNotExist(err) {
        fmt.Println("file does not exist") // это_true
    } else {
    // другая ошибка  - это_false
    }
} else {
    // тут файл существует 
}

Comments

[Vadim Rublev]

Понял. Спасибо!
P.S. У вас первый "if" - лишний (?).

[Владислав]

Vadim Rublev, да, верно, с телефона редактировал, ваш пример копировал, не заметил. Поправил.

[Vadim Rublev]

Собственно, у меня задача проверить наличие файла в папке...
Может быть есть функция специально для этого?
А то гугленье и советы_старших_товарищей всё про Stat(). Хотя она не для проверки наличия.

[Владислав]

Vadim Rublev, по факту только Stat() + проверка на ошибку через os.IsNotExist()
Го пытается быть ближе к низкоуровневым языкам, но вы можете написать обёртку и использовать её, типа:
func IsFileExist() (bool, error) {}

[Vadim Rublev]

Это понятно - про обёртку. )
Спасибо!

[Vadim Rublev]

А использовать вместо функции os.Stat() функцию os.Open() - не гуд? Потому что при os.Open() надо будет потом ещё закрывать файл (если он имеется)?

[Владислав]

Vadim Rublev, Я точно не уверен, почему везде используют os.Stat(), но я думаю, что если вы всё равно хотите открывать файл и с ним работать, то можете использовать os.Open(), при ошибке, закрывать файл не потребуется, так как он не открылся.
Но если вам просто нужно проверить, а есть ли файл, не читая/записывая в него, то используйте os.Stat()

[Владислав]

Vadim Rublev, провёл замеры скорости с Stat и Open
Open медленнее:

Benchmark_Stat-8   	  305805	      4037 ns/op
Benchmark_Open-8   	  257210	      4964 ns/op

spoiler

func Benchmark_Stat(b *testing.B) {
	for i := 0; i < b.N; i++ {
		_, err := os.Stat("/tmp/not_exist")
		_ = os.IsNotExist(err)
	}
}

func Benchmark_Open(b *testing.B) {
	for i := 0; i < b.N; i++ {
		_, err := os.Open("/tmp/not_exist")
		_ = os.IsNotExist(err)
	}
}

[Vadim Rublev]

> если вы всё равно хотите открывать файл и с ним работать, то можете использовать os.Open()
Ну это понятно.

Вот про скорость работы тоже была мысль... )
Ок.

[Vadim Rublev]

...Если вникнуть, то ваш код нужно скорректировать вот так:

_, err := os.Stat(filename)
if err != nil {
    if os.IsNotExist(err) {
        fmt.Println("file does not exist") // это_true
    } else {
        // другая ошибка (файл существует)  - это_false
    }
} else {
    // тут данные функции os.Stat()
}

:-)

[Vadim Rublev]

И таки для проверки наличия файла вот такой более лучший код (из офиц. Документации функции os.IsNotExist() ):

if _, err := os.Stat(filename); os.IsNotExist(err) {
    fmt.Println("file does not exist")   // Это true.
} else {
    // Файл существует - это false.
}

[Владислав]

другая ошибка (файл существует)

Vadim Rublev, не факт, что когда другая ошибка, файл существует.
Например, у вас вышел из строя ссд, но он замонтирован. При чтении с него будет таймаут не зависимо от того, есть файл или нет.

тут данные функции os.Stat()

там может быть что угодно, открытие файла и чтение данных, удаление файла, другие взаимодействия с файлом.

[Vadim Rublev]

> там может быть что угодно, открытие файла и чтение данных, удаление файла, ...
Это всё у функции os.Stat()? (Речь же про неё.)

> не факт, что когда другая ошибка, файл существует.
> Например, у вас вышел из строя ссд, ...
Может и не факт. Но другого инструмента у нас нет. Сказано в Документации (и общей практикой): вот эту "другую ошибку" считать за наличие файла - значит так и считаем.

[Владислав]

И таки для проверки наличия файла вот такой более лучший код (из офиц. Документации функции os.IsNotExist() ):

Vadim Rublev, зависит от того, что требуется, так как данная функция не всегда подходит.
Если вы проверяете наличие файла, перед тем как его прочесть, то да, вариант нормальный.

Но, давайте представим такую логику программы:
Файл является маркером, например, если файл существует, то пересоздаём БД и потом удаляем файл.
Так вот, в случае кода:

if _, err := os.Stat(filename); os.IsNotExist(err) {
    // ничего не делаем, файла нет
} else {
    // удаляем бд
    // создаём новую
    // удаляем файл маркера
}

вы потеряете бд просто из за битого сектора или подвисания системы ввода/вывода.

[Владислав]

Vadim Rublev,

> там может быть что угодно, открытие файла и чтение данных, удаление файла, ...
Это всё у функции os.Stat()? (Речь же про неё.)

os.Stat() - просто позволяет получить информацию о файле, её можно игнорировать, если вас интересует только проверка на наличие/отсутствие файла.

То есть в том примере который я описал, вы сначала проверяете через os.Stat(), что файл существует, а только потом читаете его через os.Open() (или делаете что-то другое)

[Vadim Rublev]

Это понятно - что нюансы есть.
Но вот конкретно ваш первоначальный код для конкретно моей задачи проверки наличия файла для его отдачи в ответ на URL-запрос - не подходит, ибо там внешний-первый if мешается. А "общий" код из Документации - самое то.

[Владислав]

Vadim Rublev, я просто пытался объяснить, как оно работает на самом деле и что нужно учитывать при использовании такого кода, но конечно, всегда можно упростить под задачу.

[Vadim Rublev]

Я говорю о том, что считается (как и в Документации сказано) "файл есть" - это там где false у функции os.IsNotExist(). В этом суть моей поправки.
Все остальное тоже верно.