如何从 Ruby 调用 shell 命令

Question

如何从 Ruby 程序内部调用 shell 命令？ 然后我如何将这些命令的输出返回到 Ruby 中？

Answer 1

这个解释是基于我一个朋友的注释Ruby 脚本。 如果您想改进脚本，请随时在链接中更新它。

首先，请注意，当 Ruby 调用 shell 时，它通常调用/bin/sh ，而不是Bash。 并非所有系统上的/bin/sh都支持某些 Bash 语法。

以下是执行 shell 脚本的方法：

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

1. Kernel#` ，通常称为反引号 – `cmd`

   这就像许多其他语言一样，包括 Bash、PHP 和 Perl。

   返回 shell 命令的结果（即标准输出）。

   文档： http : //ruby-doc.org/core/Kernel.html#method-i-60

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

2. 内置语法， %x( cmd )

   x字符后面是一个分隔符，它可以是任何字符。 如果分隔符是字符( 、 [ 、 {或< ，则文字由匹配结束分隔符之前的字符组成，考虑嵌套的分隔符对。对于所有其他分隔符，文字包含直到下一次出现的分隔符。允许字符串插值#{ ... } 。

   返回shell命令的结果（即标准输出），就像反引号一样。

   文档： https : //docs.ruby-lang.org/en/master/syntax/literals_rdoc.html#label-Percent+Strings

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

3. Kernel#system

   在子shell中执行给定的命令。

   如果找到并成功运行命令，则返回true ，否则返回false 。

   文档： http : //ruby-doc.org/core/Kernel.html#method-i-system

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

4. 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

更多阅读请参见：

• 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

Answer 2

这是基于“ 何时使用每种方法在 Ruby 中启动子进程”的流程图。 另请参阅“ 诱使应用程序认为其标准输出是终端，而不是管道”。

Answer 3

我喜欢这样做的方式是使用%x文字，这使得在命令中使用引号变得容易（且可读！），如下所示：

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

在这种情况下，它将使用当前目录下的所有测试文件填充文件列表，您可以按预期进行处理：

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

Answer 4

这是我认为关于在 Ruby 中运行 shell 脚本的最佳文章：“在 Ruby中运行 shell 命令的 6 种方法”。

如果您只需要获取输出，请使用反引号。

我需要更高级的东西，比如 STDOUT 和 STDERR，所以我使用了 Open4 gem。 您在那里解释了所有方法。

Answer 5

我最喜欢的是Open3

  require "open3"

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

Answer 6

在这些机制之间进行选择时需要考虑的一些事情是：

1. 你只是想要标准输出还是你需要标准错误？ 甚至分开？
2. 你的输出有多大？ 你想把整个结果保存在内存中吗？
3. 您想在子进程仍在运行时读取一些输出吗？
4. 您需要结果代码吗？
5. 您是否需要一个 Ruby 对象来表示进程并允许您按需终止它？

您可能需要从简单的反引号什么（``）， system()并IO.popen到成熟Kernel.fork / Kernel.exec与IO.pipe和IO.select 。

如果子流程执行时间过长，您可能还想将超时纳入混合。

不幸的是，这在很大程度上取决于。

Answer 7

我绝对不是 Ruby 专家，但我会试一试：

$ irb 
system "echo Hi"
Hi
=> true

您还应该能够执行以下操作：

cmd = 'ls'
system(cmd)

Answer 8

还有一种选择：

当你：

• 需要标准错误和标准输出
• 不能/不会使用 Open3/Open4（它们在我的 Mac 上的 NetBeans 中抛出异常，不知道为什么）

您可以使用外壳重定向：

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语法从 MS-DOS 的早期开始就适用于Linux 、Mac 和Windows 。

Answer 9

上面的答案已经相当不错了，但我真的很想分享以下总结文章：“ 6 种在 Ruby 中运行 Shell 命令的方法”

基本上，它告诉我们：

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>]

Answer 10

如果您真的需要 Bash，请按照“最佳”答案中的说明进行操作。

首先，请注意，当 Ruby 调用 shell 时，它通常调用/bin/sh ，而不是Bash。 并非所有系统上的/bin/sh都支持某些 Bash 语法。

如果您需要使用 Bash， bash -c "your Bash-only command"在所需的调用方法中插入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")

Ruby应该尊重 shebang，但你总是可以使用

system("bash ./my_script.sh")

为了确保，虽然/bin/sh运行/bin/bash可能会有轻微的开销，但您可能不会注意到。

Answer 11

您还可以使用反引号运算符 (`)，类似于 Perl：

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

如果你需要一些简单的东西就很方便。

您想使用哪种方法取决于您要完成的任务； 查看文档以获取有关不同方法的更多详细信息。

Answer 12

不要忘记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但它不等待命令完成。

Answer 13

最简单的方法是，例如：

reboot = `init 6`
puts reboot

Answer 14

我们可以通过多种方式实现它。

使用Kernel#exec ，执行此命令后没有任何内容：

exec('ls ~')

使用backticks or %x

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

使用Kernel#system命令，如果成功则返回true ，如果不成功则返回false ，如果命令执行失败则返回nil ：

system('ls ~')
=> true

Answer 15

使用此处的答案并在 Mihai 的答案中链接，我整理了一个满足这些要求的函数：

1. 整齐地捕获 STDOUT 和 STDERR，因此当我的脚本从控制台运行时它们不会“泄漏”。
2. 允许将参数作为数组传递给 shell，因此无需担心转义。
3. 捕获命令的退出状态，以便在发生错误时一目了然。

作为奖励，如果 shell 命令成功退出 (0) 并将任何内容放在 STDOUT 上，此命令也会返回 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"

Answer 16

如果您有一个比普通情况更复杂的情况，不能用``处理，请查看Kernel.spawn() 。 这似乎是股票 Ruby 提供的最通用/功能最齐全的执行外部命令的方法。

您可以将其用于：

• 创建进程组 (Windows)。
• 将输入、输出、错误重定向到文件/彼此。
• 设置环境变量，umask。
• 在执行命令之前更改目录。
• 为 CPU/数据/等设置资源限制。
• 用其他答案中的其他选项做所有可以做的事情，但要使用更多代码。

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)

Answer 17

反引号 (`) 方法是从 Ruby 调用 shell 命令最简单的方法。 它返回 shell 命令的结果：

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

Answer 18

给定像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 文档。

Answer 19

这不是一个真正的答案，但也许有人会发现它很有用：

在 Windows 上使用 TK GUI 时，您需要从 ruby​​w 调用 shell 命令，您总是会在不到一秒钟的时间内弹出一个烦人的 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 和 ruby​​w 时都会弹出那个烦人的窗口。

Answer 20

不确定shell命令。 我使用以下将系统命令的输出捕获到变量val 中：

val = capture(:stdout) do
  system("pwd")
end

puts val

缩短版：

val = capture(:stdout) { system("pwd") }

捕获方法由active_support/core_ext/kernel/reporting.rb 提供

同样，我们也可以使用:stderr捕获标准错误

Answer 21

您可以使用如下format方法打印一些信息：

puts format('%s', `ps`)
puts format('%d MB', (`ps -o rss= -p #{Process.pid}`.to_i / 1024))

Answer 22

这是我在 OS X 上的 ruby​​ 脚本中使用的一个很酷的脚本（这样我就可以启动脚本并即使在离开窗口后也能获得更新）：

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