класс Tempfile

# File lib/tempfile.rb, line 558
def Tempfile.create(basename="", tmpdir=nil, mode: 0, anonymous: false, **options, &block)
  if anonymous
    create_anonymous(basename, tmpdir, mode: mode, **options, &block)
  else
    create_with_filename(basename, tmpdir, mode: mode, **options, &block)
  end
end

Создаёт файл в файловой системе; возвращает новый объект File, основанный на этом файле.

Без блока и аргументов создаёт и возвращает файл, у которого:

• Class является File (а не Tempfile).

• Директория — системный временный каталог (зависит от системы).

• Сгенерированное имя файла уникально в этой директории.

• Права доступа — 0600; см. Права доступа к файлам.

• Режим — 'w+' (чтение/запись, позиция в конце файла).

Удаление временного файла зависит от ключевого аргумента anonymous и наличия блока. См. описание ключевого аргумента anonymous ниже.

Пример:

f = Tempfile.create     # => #<File:/tmp/20220505-9795-17ky6f6>
f.class                 # => File
f.path                  # => "/tmp/20220505-9795-17ky6f6"
f.stat.mode.to_s(8)     # => "100600"
f.close
File.exist?(f.path)     # => true
File.unlink(f.path)
File.exist?(f.path)     # => false

Tempfile.create {|f|
  f.puts "foo"
  f.rewind
  f.read                # => "foo\n"
  f.path                # => "/tmp/20240524-380207-oma0ny"
  File.exist?(f.path)   # => true
}                       # The file is removed at block exit.

f = Tempfile.create(anonymous: true)
# The file is already removed because anonymous
f.path                  # => "/tmp/"  (no filename since no file)
f.puts "foo"
f.rewind
f.read                  # => "foo\n"
f.close

Tempfile.create(anonymous: true) {|f|
  # The file is already removed because anonymous
  f.path                # => "/tmp/"  (no filename since no file)
  f.puts "foo"
  f.rewind
  f.read                # => "foo\n"
}

Аргумент basename, если задан, может быть одним из следующих:

• Строка: сгенерированное имя файла начинается с basename:

  Tempfile.create('foo') # => #<File:/tmp/foo20220505-9795-1gok8l9>
  

• Массив из двух строк [prefix, suffix]: сгенерированное имя файла начинается с prefix и заканчивается suffix:

  Tempfile.create(%w/foo .jpg/) # => #<File:/tmp/foo20220505-17839-tnjchh.jpg>
  

С аргументами basename и tmpdir, файл создаётся в директории tmpdir:

Tempfile.create('foo', '.') # => #<File:./foo20220505-9795-1emu6g8>

Ключевые аргументы mode и options передаются непосредственно методу File.open:

• Значение, заданное для mode, должно быть целым числом и может быть представлено как логическое ИЛИ констант, определённых в File::Constants.

• Для options, см. Параметры открытия.

Ключевой аргумент anonymous определяет момент удаления файла.

• anonymous=false (по умолчанию) без блока: файл не удаляется.

• anonymous=false (по умолчанию) с блоком: файл удаляется после выхода из блока.

• anonymous=true без блока: файл удаляется перед возвратом.

• anonymous=true с блоком: файл удаляется перед вызовом блока.

В первом случае (anonymous=false без блока), файл не удаляется автоматически. Его необходимо явно закрыть. Его можно переименовать в нужное имя файла. Если файл больше не нужен, его следует явно удалить.

Метод File#path созданного объекта файла возвращает временную директорию с конечным слэшем, когда anonymous равно true.

Когда задан блок, он создаёт файл, как описано выше, передаёт его в блок и возвращает значение блока. Перед возвратом объект файла закрывается, а подлежащий файл удаляется:

Tempfile.create {|file| file.path } # => "/tmp/20220505-9795-rkists"

Примечание по реализации:

Ключевой аргумент +anonymous=true+ реализован с помощью FILE_SHARE_DELETE в Windows. O_TMPFILE используется в Linux.

Связанные методы: Tempfile.new.

# File lib/tempfile.rb, line 219
def initialize(basename="", tmpdir=nil, mode: 0, **options)
  warn "Tempfile.new doesn't call the given block.", uplevel: 1 if block_given?

  @unlinked = false
  @mode = mode|File::RDWR|File::CREAT|File::EXCL
  tmpfile = nil
  ::Dir::Tmpname.create(basename, tmpdir, **options) do |tmpname, n, opts|
    opts[:perm] = 0600
    tmpfile = File.open(tmpname, @mode, **opts)
    @opts = opts.freeze
  end

  super(tmpfile)

  @finalizer_manager = FinalizerManager.new(__getobj__.path)
  @finalizer_manager.register(self, __getobj__)
end

Создаёт файл в файловой системе; возвращает новый объект Tempfile, основанный на этом файле.

Если возможно, рассмотрите использование Tempfile.create, который:

• Избегает накладных расходов на делегирование, возникающих, когда Tempfile.new вызывает метод суперкласса DelegateClass(File).

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

Создаёт и возвращает файл, у которого:

• Class является Tempfile (а не File, как в Tempfile.create).

• Директория — системный временный каталог (зависит от системы).

• Сгенерированное имя файла уникально в этой директории.

• Права доступа — 0600; см. Права доступа к файлам.

• Режим — 'w+' (чтение/запись, позиция в конце файла).

Подлежащий файл удаляется, когда объект Tempfile уничтожается и возвращается сборщиком мусора.

Пример:

f = Tempfile.new # => #<Tempfile:/tmp/20220505-17839-1s0kt30>
f.class               # => Tempfile
f.path                # => "/tmp/20220505-17839-1s0kt30"
f.stat.mode.to_s(8)   # => "100600"
File.exist?(f.path)   # => true
File.unlink(f.path)   #
File.exist?(f.path)   # => false

Аргумент basename, если задан, может быть одним из:

• Строка: сгенерированное имя файла начинается с basename:

  Tempfile.new('foo') # => #<Tempfile:/tmp/foo20220505-17839-1whk2f>
  

• Массив из двух строк [prefix, suffix]: сгенерированное имя файла начинается с prefix и заканчивается suffix:

  Tempfile.new(%w/foo .jpg/) # => #<Tempfile:/tmp/foo20220505-17839-58xtfi.jpg>
  

С аргументами basename и tmpdir, файл создаётся в директории tmpdir:

Tempfile.new('foo', '.') # => #<Tempfile:./foo20220505-17839-xfstr8>

Ключевые аргументы mode и options передаются непосредственно методу File.open:

• Значение, заданное с mode, должно быть целым числом и может быть представлено как логическое ИЛИ констант, определённых в File::Constants.

• Для options, см. Параметры открытия.

Связанные методы: Tempfile.create.

# File lib/tempfile.rb, line 439
def open(*args, **kw)
  tempfile = new(*args, **kw)

  if block_given?
    begin
      yield(tempfile)
    ensure
      tempfile.close
    end
  else
    tempfile
  end
end

Создаёт новый Tempfile.

Этот метод не рекомендуется и существует в основном для обратной совместимости. Пожалуйста, используйте Tempfile.create вместо него, который избегает затрат на делегирование, не полагается на финализатор и также удаляет файл при наличии блока.

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

Если блок не задан, это синоним для Tempfile.new.

Если задан блок, то будет создан объект Tempfile, и блок будет выполнен с объектом Tempfile в качестве аргумента. Объект Tempfile будет автоматически закрыт после завершения блока. Однако файл не будет удалён и необходимо вручную удалить его с помощью Tempfile#close! или Tempfile#unlink. Финализатор попытается удалить файл, но на него нельзя полагаться, так как он может хранить файл на диске намного дольше, чем предполагалось. Например, в CRuby финализаторы могут быть отложены из-за консервативного сканирования стека и ссылок, оставленных в неиспользуемой памяти.

Вызов возвращает значение блока.

В любом случае, все аргументы (*args) будут переданы в Tempfile.new.

Tempfile.open('foo', '/home/temp') do |f|
   # ... do something with f ...
end

# Equivalent:
f = Tempfile.open('foo', '/home/temp')
begin
   # ... do something with f ...
ensure
   f.close
end

# File lib/tempfile.rb, line 279
def close(unlink_now=false)
  _close
  unlink if unlink_now
end

Закрывает файл. Если unlink_now имеет значение true, то файл будет удален (удалён) после закрытия. Конечно, вы можете впоследствии вызвать unlink, если вы не удалили его сейчас.

Если вы явно не удалите временный файл, удаление будет отложено до момента финализации объекта.

# File lib/tempfile.rb, line 286
def close!
  close(true)
end

Закрывает и удаляет (удаляет) файл. Имеет тот же эффект, что и вызов close(true).

# File lib/tempfile.rb, line 257
def open
  _close

  mode = @mode & ~(File::CREAT|File::EXCL)
  __setobj__(File.open(__getobj__.path, mode, **@opts))

  @finalizer_manager.register(self, __getobj__)

  __getobj__
end

Открывает или повторно открывает файл в режиме «r+».

# File lib/tempfile.rb, line 341
def path
  @unlinked ? nil : __getobj__.path
end

Возвращает полное имя пути временного файла. Будет равно null, если unlink был вызван.

# File lib/tempfile.rb, line 347
def size
  if !__getobj__.closed?
    __getobj__.size # File#size calls rb_io_flush_raw()
  else
    File.size(__getobj__.path)
  end
end

Возвращает размер временного файла. В качестве побочного эффекта буфер IO сбрасывается перед определением размера.

# File lib/tempfile.rb, line 323
def unlink
  return if @unlinked
  begin
    File.unlink(__getobj__.path)
  rescue Errno::ENOENT
  rescue Errno::EACCES
    # may not be able to unlink on Windows; just ignore
    return
  end

  @finalizer_manager.unlinked = true

  @unlinked = true
end

Удаляет файл из файловой системы. Файл всегда следует удалять после его использования, как описано в разделе «Явное закрытие» в обзоре Tempfile:

file = Tempfile.new('foo')
begin
   # ...do something with file...
ensure
   file.close
   file.unlink   # deletes the temp file
end

Удаление перед закрытием

В системах POSIX возможно удаление файла до его закрытия. Этот подход подробно описан в обзоре Tempfile (раздел «Удаление после создания»); пожалуйста, обратитесь к нему за дополнительной информацией.

Однако, удаление перед закрытием может не поддерживаться в не-POSIX операционных системах. Microsoft Windows — самый заметный пример: удаление не закрытого файла приведёт к ошибке, которую этот метод будет молча игнорировать. Если вы хотите практиковать удаление перед закрытием всякий раз, когда это возможно, напишите код следующим образом:

file = Tempfile.new('foo')
file.unlink   # On Windows this silently fails.
begin
   # ... do something with file ...
ensure
   file.close!   # Closes the file handle. If the file wasn't unlinked
                 # because #unlink failed, then this method will attempt
                 # to do so again.
end