从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命令的结果,就像反引号一样.

   文档:http://www.ruby-doc.org/docs/ProgrammingRuby/html/language.html

   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

这是基于此答案的流程图.也参见,使用__CODE__以模拟终端.

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. 你想要stdout还是需要stderr？甚至分开了？
2. 你的产量有多大？你想把整个结果保存在记忆中吗？
3. 在子进程仍在运行时,是否要读取一些输出？
4. 你需要结果代码吗？
5. 您是否需要一个代表该过程的ruby对象并让您按需杀死它？

你可能需要从简单的反引号(``),system()IO.popen到full-blown Kernel.fork/ Kernel.execwith IO.pipe和IO.select.

如果子进程执行时间过长,您可能还希望将超时投入到混合中.

不幸的是,这非常取决于.

Answer 7

还有一个选择:

当你:

• 需要stderr以及stdout
• 不能/不会使用Open3/Open4(他们在我的Mac上的NetBeans中抛出异常,不明白为什么)

您可以使用shell重定向:

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

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

从早期的MS-DOS开始,该2>&1语法适用于Linux,Mac和Windows.

Answer 8

我绝对不是Ruby专家,但我会试一试:

$ irb 
system "echo Hi"
Hi
=> true

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

cmd = 'ls'
system(cmd)

Answer 9

上面的答案已经非常好了,但我真的想分享以下摘要文章:" 在Ruby中运行Shell命令的6种方法 "

基本上,它告诉我们:

Kernel#exec:

exec 'echo "hello $HOSTNAME"'

system并且$?:

system 'false' 
puts $?

反引号(`):

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

Answer 10

如果你真的需要Bash,请按照"最佳"答案中的说明.

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

如果您需要使用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"))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

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

使用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 13

使用这里的答案并在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 14

最简单的方法是,例如:

reboot = `init 6`
puts reboot

Answer 15

不要忘记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 16

给出如下命令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 17

如果您的案例比普通案例（无法处理``）更复杂，请在Kernel.spawn() 此处查看。这似乎是普通Ruby提供的用于执行外部命令的最通用/最全面的功能。

例如，您可以使用它来：

• 创建进程组（Windows）
• 将错误重定向到文件或其他文件。
• 设置环境变量，umask
• 在执行命令之前更改目录
• 设置CPU /数据/资源限制
• 用其他答案中的其他选项来完成所有事情，但是要编写更多代码。

官方的红宝石文档有足够好的例子。

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 18

• backticks`方法是从ruby调用shell命令的最简单方法。它返回shell命令的结果。

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