Вызов команд оболочки из Ruby
Вопрос
Как мне вызывать команды оболочки изнутри программы Ruby?Как мне затем получить выходные данные этих команд обратно в Ruby?
Решение
Это объяснение основано на прокомментированном Ruby скрипт от моего друга.Если вы хотите улучшить скрипт, не стесняйтесь обновить его по ссылке.
Во-первых, обратите внимание, что когда Ruby обращается к оболочке, она обычно вызывает /bin/sh
, нет Удар.Некоторый синтаксис Bash не поддерживается /bin/sh
во всех системах.
Вот способы выполнения сценария оболочки:
cmd = "echo 'hi'" # Sample string that can be used
Kernel#`
, обычно называемые обратными метками –`cmd`
Это похоже на многие другие языки, включая Bash, PHP и Perl.
Возвращает результат выполнения команды командной строки.
Документы: http://ruby-doc.org/core/Kernel.html#method-i-60
value = `echo 'hi'` value = `#{cmd}`
Встроенный синтаксис,
%x( cmd )
Следуя за
x
символ - это разделитель, которым может быть любой символ.Если разделителем является один из символов(
,[
,{
, или<
, литерал состоит из символов вплоть до соответствующего закрывающего разделителя, с учетом вложенных пар разделителей.Для всех других разделителей литерал содержит символы до следующего вхождения символа разделителя.Интерполяция строк#{ ... }
это разрешено.Возвращает результат выполнения команды командной строки, точно так же, как обратные подсказки.
Документы: http://www.ruby-doc.org/docs/ProgrammingRuby/html/language.html
value = %x( echo 'hi' ) value = %x[ #{cmd} ]
Kernel#system
Выполняет заданную команду в подоболочке.
ВОЗВРАТ
true
если команда была найдена и успешно выполнена,false
в противном случае.Документы: http://ruby-doc.org/core/Kernel.html#method-i-system
wasGood = system( "echo 'hi'" ) wasGood = system( cmd )
Kernel#exec
Заменяет текущий процесс, выполняя заданную внешнюю команду.
Возвращает none, текущий процесс заменяется и никогда не продолжается.
Документы: 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
Для получения дополнительной информации см.:
Другие советы
Вот блок-схема, основанная на этот ответ.Смотрите также, используя script
чтобы эмулировать терминал.
Мне нравится делать это так, используя %x
буквальный, который упрощает (и читабельность!) использование кавычек в команде, например:
directorylist = %x[find . -name '*test.rb' | sort]
Который, в этом случае, заполнит список файлов всеми тестовыми файлами в текущем каталоге, которые вы можете обработать должным образом:
directorylist.each do |filename|
filename.chomp!
# work with file
end
Вот лучшая статья, на мой взгляд, о запуске shell-скриптов в Ruby:"6 Способов запуска команд оболочки в Ruby".
Если вам нужно только получить выходные данные, используйте обратные метки.
Мне нужны были более продвинутые материалы, такие как STDOUT и STDERR, поэтому я использовал Open4 gem.Там вам объяснены все методы.
Мое любимое блюдо - это Открытый3
require "open3"
Open3.popen3('nroff -man') { |stdin, stdout, stderr| ... }
Вот некоторые вещи, о которых следует подумать при выборе между этими механизмами:
- Вам нужен только стандартный вывод или вам также нужен stderr ?или даже отделились?
- Насколько велик ваш объем производства?Вы хотите сохранить весь результат в памяти?
- Вы хотите прочитать некоторые из ваших выходных данных, пока подпроцесс еще запущен?
- Вам нужны коды результатов?
- Вам нужен объект 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 $?
Обратные подсказки (`):
today = `date`
IO#popen
:
IO.popen("date") { |f| puts f.gets }
Open3#popen3
-- стандартный файл:
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 не поддерживается/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
, вы, вероятно, не заметите.
Вы также можете использовать операторы возврата (`), аналогичные Perl:
directoryListing = `ls /`
puts directoryListing # prints the contents of the root directory
Удобно, если вам нужно что-то простое.
Какой метод вы хотите использовать, зависит от того, чего именно вы пытаетесь достичь;более подробную информацию о различных методах см. в документации.
самый простой способ - это, например:
reboot = `init 6`
puts reboot
Используя ответы здесь и ссылки в ответе Михая, я собрал функцию, которая отвечает этим требованиям:
- Аккуратно фиксирует STDOUT и STDERR, чтобы они не "протекали" при запуске моего скрипта с консоли.
- Позволяет передавать аргументы в оболочку в виде массива, так что нет необходимости беспокоиться об экранировании.
- Фиксирует состояние завершения команды, чтобы было ясно, когда произошла ошибка.
В качестве бонуса, этот также вернет стандартный вывод в случаях, когда команда оболочки успешно завершает работу (0) и помещает что-либо в стандартный вывод.Таким образом, он отличается от 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"
Мы можем достичь этого несколькими способами.
Используя Kernel#exec
, ничего после выполнения этой команды не выполняется:
exec('ls ~')
Используя backticks or %x
`ls ~`
=> "Applications\nDesktop\nDocuments"
%x(ls ~)
=> "Applications\nDesktop\nDocuments"
Используя Kernel#system
команда, возвращает true
в случае успеха, false
в случае неудачи и возвращает nil
если выполнение команды завершается неудачей:
system('ls ~')
=> true
Не забывайте о 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()
здесь.Это, по-видимому, наиболее общий / полнофункциональный вариант, предоставляемый биржевой Рубин для выполнения внешних команд.
Например.вы можете использовать его для:
- создание групп процессов (Windows)
- перенаправлять входящие, исходящие ошибки на файлы / друг на друга.
- установить переменные среды, 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 в backticks, что хорошо в этом методе по сравнению с другими методами..является , например,backticks, похоже, не позволяет мне "помещать" команду, которую я запускаю / сохранять команду, которую я хочу запустить, в переменную, а system ("thecommand"), похоже, не позволяет мне получить результат.Принимая во внимание, что этот метод позволяет мне выполнять обе эти вещи, и он позволяет мне получать доступ к stdin, stdout и stderr независимо.
https://blog.bigbinary.com/2012/10/18/backtick-system-exec-in-ruby.html
http://ruby-doc.org/stdlib-2.4.1/libdoc/open3/rdoc/Open3.html
На самом деле это не ответ, но, возможно, кто-то найдет это полезным, и это связано с этим.
При использовании 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()
будет ли всплывать это раздражающее окно при использовании TK и rubyw.
Вот классный вариант, который я использую в ruby-скрипте на OS X (чтобы я мог запустить скрипт и получить обновление даже после переключения из окна):
cmd = %Q|osascript -e 'display notification "Server was reset" with title "Posted Update"'|
system ( cmd )