Как вызывать команды оболочки из Ruby

Как мне вызвать команды оболочки изнутри программы на Ruby? Как я могу получить вывод этих команд обратно в Ruby?

Это объяснение основано на комментируемом сценарии Ruby от моего друга. Если вы хотите улучшить скрипт, обновите его по ссылке.

Во-первых, обратите внимание, что когда Ruby вызывает оболочку, он обычно вызывает /bin/sh, а не Bash. Некоторый синтаксис Bash поддерживается не /bin/shво всех системах.

Вот способы выполнить скрипт оболочки:

cmd = "echo 'hi'" # Sample string that can be used

1. Kernel#` обычно называют backticks - `cmd`

   Это похоже на многие другие языки, включая Bash, PHP и Perl.

   Возвращает результат (т.е. стандартный вывод) команды оболочки.

   Документы: http://ruby-doc.org/core/Kernel.html#method-i-60

   value = `echo 'hi'`
   value = `#{cmd}`

2. Встроенный синтаксис, %x( cmd )

   За xсимволом следует разделитель, которым может быть любой символ. Если разделитель является одним из символов (, [, {или <, в буквальном смысле состоит из символов , до закрытия соответствия разделителя, с учетом вложенных пар разделителей. Для всех других разделителей литерал содержит символы до следующего вхождения символа разделителя. Строковая интерполяция #{ ... }разрешена.

   Возвращает результат (то есть стандартный вывод) команды оболочки, так же как обратные пометки.

   Документы: https://docs.ruby-lang.org/en/master/syntax/literals_rdoc.html#label-Percent+Strings

   value = %x( echo 'hi' )
   value = %x[ #{cmd} ]

3. Kernel#system

   Выполняет данную команду в подоболочке.

   Возвращает, trueесли команда была найдена и успешно выполнена, в falseпротивном случае.

   Документы: http://ruby-doc.org/core/Kernel.html#method-i-system

   wasGood = system( "echo 'hi'" )
   wasGood = system( cmd )

4. Kernel#exec

   Заменяет текущий процесс, выполнив данную внешнюю команду.

   Не возвращает ничего, текущий процесс заменяется и никогда не продолжается.

   Документы: http://ruby-doc.org/core/Kernel.html#method-i-exec

   exec( "echo 'hi'" )
   exec( cmd ) # Note: this will never be reached because of the line above

Вот несколько дополнительных советов: $?аналогично $CHILD_STATUSдоступу к состоянию последней команды, выполненной системой, если вы используете обратные галочки, system()или %x{}. Вы можете получить доступ к exitstatusи pidсвойства:

$?.exitstatus

Для получения дополнительной информации см .:

• http://www.elctech.com/blog/im-in-ur-commandline-executin-ma-commands
• http://blog.jayfields.com/2006/06/ruby-kernel-system-exec-and-x.html
• http://tech.natemurray.com/2007/03/ruby-shell-commands.html

Вот блок-схема, основанная на « Когда использовать каждый метод запуска подпроцесса в Ruby ». Смотрите также: « Обманите приложение, думая, что его стандартный вывод - это терминал, а не канал ».

Мне нравится делать это, используя %xлитерал, который позволяет легко (и удобно читать) использовать кавычки в команде, например так:

directorylist = %x[find . -name '*test.rb' | sort]

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

directorylist.each do |filename|
  filename.chomp!
  # work with file
end

Вот лучшая на мой взгляд статья о запуске сценариев оболочки в Ruby: « 6 способов запуска команд оболочки в Ruby ».

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

Мне нужны были более продвинутые вещи, такие как STDOUT и STDERR, поэтому я использовал камень Open4. У вас есть все методы, объясненные там.

Мой любимый это Open3

  require "open3"

  Open3.popen3('nroff -man') { |stdin, stdout, stderr| ... }

При выборе между этими механизмами необходимо учитывать следующие факторы:

1. Вы просто хотите использовать стандартный вывод или вам тоже нужен стандартный вывод? Или даже выделены?
2. Насколько велика ваша продукция? Вы хотите сохранить весь результат в памяти?
3. Вы хотите прочитать некоторые из ваших выводов, пока подпроцесс еще работает?
4. Вам нужны коды результатов?
5. Вам нужен объект Ruby, который представляет процесс и позволяет вам убивать его по требованию?

Возможно , вам что - нибудь из простых обратных кавычек ( ``), system()и IO.popenв полномасштабный Kernel.fork/ Kernel.execс IO.pipeи IO.select.

Вы также можете добавить тайм-ауты в микс, если подпроцесс занимает слишком много времени для выполнения.

К сожалению, это очень многое зависит .

Еще один вариант:

Когда ты:

• нужен как stderr, так и stdout
• не могу / не буду использовать Open3 / Open4 (они генерируют исключения в NetBeans на моем Mac, не знаю почему)

Вы можете использовать перенаправление оболочки:

puts %x[cat bogus.txt].inspect
  => ""

puts %x[cat bogus.txt 2>&1].inspect
  => "cat: bogus.txt: No such file or directory\n"

2>&1Синтаксис работает через Linux , Mac и Windows , начиная с первых дней в MS-DOS.

Я определенно не эксперт по Ruby, но я попробую:

$ irb 
system "echo Hi"
Hi
=> true

Вы также должны быть в состоянии сделать такие вещи, как:

cmd = 'ls'
system(cmd)

Ответы выше уже довольно хороши, но я действительно хочу поделиться следующей сводной статьей: « 6 способов запуска команд оболочки в Ruby »

В основном это говорит нам:

Kernel#exec:

exec 'echo "hello $HOSTNAME"'

systemи $?:

system 'false' 
puts $?

Backticks (`):

today = `date`

IO#popen:

IO.popen("date") { |f| puts f.gets }

Open3#popen3 - stdlib:

require "open3"
stdin, stdout, stderr = Open3.popen3('dc') 

Open4#popen4 -- драгоценный камень:

require "open4" 
pid, stdin, stdout, stderr = Open4::popen4 "false" # => [26327, #<IO:0x6dff24>, #<IO:0x6dfee8>, #<IO:0x6dfe84>]

Если вам действительно нужен Bash, то обратите внимание на «лучший» ответ.

Во-первых, обратите внимание, что когда Ruby вызывает оболочку, он обычно вызывает /bin/sh, а не Bash. Некоторый синтаксис Bash поддерживается не /bin/shво всех системах.

Если вам нужно использовать Bash, вставьте bash -c "your Bash-only command"внутрь желаемого метода вызова:

quick_output = system("ls -la")

quick_bash = system("bash -c 'ls -la'")

Тестировать:

system("echo $SHELL")
system('bash -c "echo $SHELL"')

Или, если вы используете существующий файл сценария, как

script_output = system("./my_script.sh")

Руби должен соблюдать шебанг, но вы всегда можете использовать

system("bash ./my_script.sh")

чтобы убедиться, что при /bin/shзапуске могут быть небольшие накладные расходы /bin/bash, вы, вероятно, этого не заметите.

Вы также можете использовать операторы backtick (`), аналогичные Perl:

directoryListing = `ls /`
puts directoryListing # prints the contents of the root directory

Удобно, если вам нужно что-то простое.

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

Мы можем достичь этого несколькими способами.

Используя Kernel#exec, ничего после этой команды не выполняется:

exec('ls ~')

С помощью backticks or %x

`ls ~`
=> "Applications\nDesktop\nDocuments"
%x(ls ~)
=> "Applications\nDesktop\nDocuments"

Использование Kernel#systemкоманды возвращает в trueслучае успеха, falseесли не удалось, и возвращает в nilслучае сбоя выполнения команды:

system('ls ~')
=> true

Самый простой способ, например:

reboot = `init 6`
puts reboot

Используя ответы здесь и связанные в ответе Михая, я собрал функцию, которая отвечает этим требованиям:

1. Аккуратно фиксирует STDOUT и STDERR, чтобы они не «просачивались», когда мой скрипт запускается из консоли.
2. Позволяет передавать аргументы в оболочку в виде массива, поэтому вам не нужно беспокоиться об экранировании.
3. Записывает состояние завершения команды, чтобы было ясно, когда произошла ошибка.

В качестве бонуса этот также будет возвращать STDOUT в тех случаях, когда команда оболочки успешно завершает работу (0) и помещает что-либо в STDOUT. Таким образом, он отличается от того system, который просто возвращаетtrue в таких случаях.

Кодекс следует. Конкретная функция system_quietly:

require 'open3'

class ShellError < StandardError; end

#actual function:
def system_quietly(*cmd)
  exit_status=nil
  err=nil
  out=nil
  Open3.popen3(*cmd) do |stdin, stdout, stderr, wait_thread|
    err = stderr.gets(nil)
    out = stdout.gets(nil)
    [stdin, stdout, stderr].each{|stream| stream.send('close')}
    exit_status = wait_thread.value
  end
  if exit_status.to_i > 0
    err = err.chomp if err
    raise ShellError, err
  elsif out
    return out.chomp
  else
    return true
  end
end

#calling it:
begin
  puts system_quietly('which', 'ruby')
rescue ShellError
  abort "Looks like you don't have the `ruby` command. Odd."
end

#output: => "/Users/me/.rvm/rubies/ruby-1.9.2-p136/bin/ruby"

Не забудьте spawnкоманду для создания фонового процесса для выполнения указанной команды. Вы даже можете дождаться его завершения, используя Processкласс и возвращаемое значение pid:

pid = spawn("tar xf ruby-2.0.0-p195.tar.bz2")
Process.wait pid

pid = spawn(RbConfig.ruby, "-eputs'Hello, world!'")
Process.wait pid

Док говорит: «Этот метод похож на, #systemно он не ждет завершения команды.

Если у вас есть более сложный случай, чем общий случай, с которым невозможно справиться ``, то ознакомьтесь с Kernel.spawn() . Похоже, это наиболее универсальный / полнофункциональный инструмент, предоставляемый стандартным Ruby для выполнения внешних команд.

Вы можете использовать его для:

• создать группы процессов (Windows).
• перенаправлять ошибки, файлы / друг друга.
• установить env vars, umask.
• измените каталог перед выполнением команды.
• установить ограничения ресурсов для процессора / данных / и т. д.
• Делайте все, что можно сделать с другими вариантами в других ответах, но с большим количеством кода.

Документация Ruby имеет достаточно хороших примеров:

env: hash
  name => val : set the environment variable
  name => nil : unset the environment variable
command...:
  commandline                 : command line string which is passed to the standard shell
  cmdname, arg1, ...          : command name and one or more arguments (no shell)
  [cmdname, argv0], arg1, ... : command name, argv[0] and zero or more arguments (no shell)
options: hash
  clearing environment variables:
    :unsetenv_others => true   : clear environment variables except specified by env
    :unsetenv_others => false  : dont clear (default)
  process group:
    :pgroup => true or 0 : make a new process group
    :pgroup => pgid      : join to specified process group
    :pgroup => nil       : dont change the process group (default)
  create new process group: Windows only
    :new_pgroup => true  : the new process is the root process of a new process group
    :new_pgroup => false : dont create a new process group (default)
  resource limit: resourcename is core, cpu, data, etc.  See Process.setrlimit.
    :rlimit_resourcename => limit
    :rlimit_resourcename => [cur_limit, max_limit]
  current directory:
    :chdir => str
  umask:
    :umask => int
  redirection:
    key:
      FD              : single file descriptor in child process
      [FD, FD, ...]   : multiple file descriptor in child process
    value:
      FD                        : redirect to the file descriptor in parent process
      string                    : redirect to file with open(string, "r" or "w")
      [string]                  : redirect to file with open(string, File::RDONLY)
      [string, open_mode]       : redirect to file with open(string, open_mode, 0644)
      [string, open_mode, perm] : redirect to file with open(string, open_mode, perm)
      [:child, FD]              : redirect to the redirected file descriptor
      :close                    : close the file descriptor in child process
    FD is one of follows
      :in     : the file descriptor 0 which is the standard input
      :out    : the file descriptor 1 which is the standard output
      :err    : the file descriptor 2 which is the standard error
      integer : the file descriptor of specified the integer
      io      : the file descriptor specified as io.fileno
  file descriptor inheritance: close non-redirected non-standard fds (3, 4, 5, ...) or not
    :close_others => false : inherit fds (default for system and exec)
    :close_others => true  : dont inherit (default for spawn and IO.popen)

Метод backticks (`) является самым простым для вызова команд оболочки из Ruby. Возвращает результат команды оболочки:

     url_request = 'http://google.com'
     result_of_shell_command = `curl #{url_request}`

Дана команда типа attrib:

require 'open3'

a="attrib"
Open3.popen3(a) do |stdin, stdout, stderr|
  puts stdout.read
end

Я обнаружил, что хотя этот метод не так запоминающийся, как

system("thecommand")

или

`thecommand`

в обратном кавычках хорошая вещь в этом методе по сравнению с другими методами в том, что обратные кавычки не позволяют мне putsвводить / сохранять команду, которую я хочу запустить в переменной, иsystem("thecommand") , похоже, не позволяют мне получить вывод, тогда как этот метод позволяет мне делать обе эти вещи, и он позволяет мне получать доступ к stdin, stdout и stderr независимо.

См. « Выполнение команд в ruby » и документацию по Ruby для Open3 .

Это не совсем ответ, но, возможно, кто-то найдет его полезным:

При использовании TK GUI в Windows, и вам нужно вызывать команды оболочки из rubyw, у вас всегда будет раздражающее окно CMD, появляющееся менее чем за секунду.

Чтобы избежать этого, вы можете использовать:

WIN32OLE.new('Shell.Application').ShellExecute('ipconfig > log.txt','','','open',0)

или

WIN32OLE.new('WScript.Shell').Run('ipconfig > log.txt',0,0)

Оба будут хранить ipconfigвывод внутриlog.txt , но окна не появятся.

Вам нужно будет require 'win32ole' внутри вашего сценария.

system(), exec()иspawn() будет все всплывающие окна , что раздражает при использовании ТЗ и rubyw.

Вот классный пример, который я использую в скрипте ruby ​​на OS X (чтобы я мог запустить скрипт и получить обновление даже после переключения из окна):

cmd = %Q|osascript -e 'display notification "Server was reset" with title "Posted Update"'|
system ( cmd )