Вызов команд оболочки из Ruby
Как я вызываю команды оболочки внутри программы на Ruby? Как я могу получить вывод этих команд обратно в Ruby?
22 ответа
Это объяснение основано на комментируемом сценарии Ruby от моего друга. Если вы хотите улучшить скрипт, обновите его по ссылке.
Во-первых, обратите внимание, что когда Ruby вызывает оболочку, он обычно вызывает /bin/shне Баш. Некоторые синтаксис Bash не поддерживается /bin/sh на всех системах.
Вот способы выполнения сценария оболочки:
cmd = "echo 'hi'" # Sample string that can be used
Kernel#`обычно называют backticks -`cmd`Это похоже на многие другие языки, включая Bash, PHP и Perl.
Возвращает результат команды оболочки.
Документы: http://ruby-doc.org/core/Kernel.html
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
wasGood = system( "echo 'hi'" ) wasGood = system( cmd )Kernel#execЗаменяет текущий процесс, выполнив данную внешнюю команду.
Не возвращает ничего, текущий процесс заменяется и никогда не продолжается.
Документы: http://ruby-doc.org/core/Kernel.html
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
Вот лучшая на мой взгляд статья о запуске сценариев оболочки в Ruby: " 6 способов запуска команд оболочки в Ruby".
Если вам нужно только получить выходные данные, используйте обратные метки.
Мне нужны были более продвинутые вещи, такие как STDOUT и STDERR, поэтому я использовал камень Open4. У вас есть все методы, объясненные там.
Мой любимый это Open3
require "open3"
Open3.popen3('nroff -man') { |stdin, stdout, stderr| ... }
При выборе между этими механизмами нужно подумать о следующих вещах:
- Вы просто хотите использовать стандартный вывод или вам тоже нужен стандартный вывод? или даже выделены?
- Насколько велика ваша продукция? Вы хотите сохранить весь результат в памяти?
- Вы хотите прочитать некоторые из ваших выводов, пока подпроцесс еще работает?
- Вам нужны коды результатов?
- Вам нужен объект ruby, который представляет процесс и позволяет вам убивать его по требованию?
Вам может понадобиться что-нибудь от простых обратных символов (``), system() и IO.popen в полном объеме Kernel.fork/Kernel.exec с IO.pipe а также IO.select,
Вы также можете выбросить тайм-ауты в микс, если подпроцесс занимает слишком много времени для выполнения.
К сожалению, это очень многое зависит.
Я определенно не эксперт по Ruby, но я попробую:
$ irb
system "echo Hi"
Hi
=> true
Вы также должны быть в состоянии сделать такие вещи, как:
cmd = 'ls'
system(cmd)
Еще один вариант:
Когда ты:
- нужен как 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.
Ответы выше уже довольно хороши, но я действительно хочу поделиться следующей сводной статьей: " 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 не поддерживается/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
Используя ответы здесь и связанные в ответе Михая, я собрал функцию, которая отвечает этим требованиям:
- Аккуратно фиксирует STDOUT и STDERR, чтобы они не "просачивались", когда мой скрипт запускается из консоли.
- Позволяет передавать аргументы в оболочку в виде массива, поэтому вам не нужно беспокоиться об экранировании.
- Записывает состояние завершения команды, чтобы было ясно, когда произошла ошибка.
В качестве бонуса, этот также вернет 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 но он не ждет, пока команда закончит.
Самый простой способ, например:
reboot = `init 6`
puts reboot
Дана команда, например, attrib
require 'open3'
a="attrib"
Open3.popen3(a) do |stdin, stdout, stderr|
puts stdout.read
end
Я обнаружил, что, хотя этот метод не такой запоминающийся, как, например, system("thecommand") или команда в backticks, хорошая вещь в этом методе по сравнению с другими методами... например, backticks не позволяют мне "ставить" 'команда, которую я запускаю / храню команду, которую я хочу запустить в переменной, и система ("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
Метод backticks `является самым простым для вызова команд оболочки из ruby. Возвращает результат команды оболочки.
url_request = 'http://google.com' result_of_shell_command = `curl #{url_request}`
Если у вас есть более сложный случай, чем общий случай (который не может быть обработан с ``) затем проверить Kernel.spawn() здесь Похоже, это наиболее общий / полнофункциональный инструмент, предоставляемый стандартным Ruby для выполнения внешних команд.
Например, вы можете использовать его для:
- создавать группы процессов (Windows)
- перенаправлять ошибки, файлы / друг друга.
- установить env vars, umask
- изменить каталог перед выполнением команды
- установить ограничения ресурсов для процессора / данных /...
- Делайте все, что можно сделать с другими вариантами в других ответах, но с большим количеством кода.
Официальная рубиновая документация имеет достаточно хороших примеров.
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)
Не совсем ответ, но, возможно, кто-то найдет это полезным, и это касается этого.
При использовании 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.
Не уверен в командах оболочки. Я использовал следующее для захвата вывода системной команды в переменную val:
val = capture(:stdout) do
system("pwd")
end
puts val
сокращенная версия:
val = capture(:stdout) { system("pwd") }
Метод захвата предоставляется файлом active_support/core_ext/kernel/reporting.rb.
Точно так же мы можем также фиксировать стандартные ошибки с помощью
:stderr
Вы можете использовать
formatметод, как показано ниже, чтобы распечатать некоторую информацию:
puts format('%s', `ps`)
puts format('%d MB', (`ps -o rss= -p #{Process.pid}`.to_i / 1024))
Вот классный пример, который я использую в сценарии ruby на OS X (чтобы я мог запустить сценарий и получить обновление даже после переключения из окна):
cmd = %Q|osascript -e 'display notification "Server was reset" with title "Posted Update"'|
system ( cmd )