Python中判断subprocess调起的shell命令是否结束

前言

最近在使用subprocess遇到个问题，折腾了好半天才找到简单的解决办法，在这里记录下。

环境

Python：2.7.10

库：subprocess, logging

问题

使用subprocess的Popen类来执行shell命令，要怎么样才能知道命令执行结束了，以此来执行回调方法。

解决办法

使用subprocess.Popen.poll方法来获取命令的执行情况。

poll方法的返回值有两种情况   

1. 当命令未运行结束的时候，返回None   

2. 当命令结束时，返回命令的返回值

演示

这里使用logging模块来辅助显示命令执行时间

分别使用两种调用shell命令的方式来测试

shell=True

shell=False

完整演示

补充：system函数返回（如何判断调用的shell命令是否执行成功）

例：

status = system("./test.sh");

1、先统一两个说法：

（1）system返回值：指调用system函数后的返回值，比如上例中status为system返回值

（2）shell返回值：指system所调用的shell命令的返回值，比如上例中，test.sh中返回的值为shell返回值。

2、如何正确判断test.sh是否正确执行？

仅判断status是否==0？或者仅判断status是否!=-1?

都错！

3、man中对于system的说明

RETURN VALUE

The value returned is -1 on error (e.g. fork() failed), and the return

status of the command otherwise. This latter return status is in the

format specified in wait(2). Thus, the exit code of the command will

be WEXITSTATUS(status). In case /bin/sh could not be executed, the

exit status will be that of a command that does exit(127).

看得很晕吧？

system函数对返回值的处理，涉及3个阶段：

阶段1：创建子进程等准备工作。如果失败，返回-1。

阶段2：调用/bin/sh拉起shell脚本，如果拉起失败或者shell未正常执行结束（参见备注1），原因值被写入到status的低8~15比特位中。system的man中只说明了会写了127这个值，但实测发现还会写126等值。

阶段3：如果shell脚本正常执行结束，将shell返回值填到status的低8~15比特位中。

备注1：

只要能够调用到/bin/sh，并且执行shell过程中没有被其他信号异常中断，都算正常结束。

比如：不管shell脚本中返回什么原因值，是0还是非0，都算正常执行结束。即使shell脚本不存在或没有执行权限，也都算正常执行结束。

如果shell脚本执行过程中被强制kill掉等情况则算异常结束。

如何判断阶段2中，shell脚本是否正常执行结束呢？系统提供了宏：WIFEXITED(status)。如果WIFEXITED(status)为真，则说明正常结束。

如何取得阶段3中的shell返回值？你可以直接通过右移8bit来实现，但安全的做法是使用系统提供的宏：WEXITSTATUS(status)。

由于我们一般在shell脚本中会通过返回值判断本脚本是否正常执行，如果成功返回0，失败返回正数。

所以综上，判断一个system函数调用shell脚本是否正常结束的方法应该是如下3个条件同时成立：

（1）-1 != status

（2）WIFEXITED(status)为真

（3）0 == WEXITSTATUS(status)

注意：

根据以上分析，当shell脚本不存在、没有执行权限等场景下时，以上前2个条件仍会成立，此时WEXITSTATUS(status)为127，126等数值。

所以，我们在shell脚本中不能将127，126等数值定义为返回值，否则无法区分中是shell的返回值，还是调用shell脚本异常的原因值。shell脚本中的返回值最好多1开始递增。

判断shell脚本正常执行结束的健全代码如下：

#include  <stdio.h>
#include  <stdlib.h> 
int main() 
{ 
    pid_t status;   
    status = system("./test.sh"); 
    if(status == -1)
    {
 printf("system error... \n");
     }
 else
 {
            if(WIFEXITED(status))
     {
                if(0 == WEXITSTATUS(status))
         {
                    printf("run  successfully... \n");
                }
  else
  {
                    printf("run failed %d \n",WEXITSTATUS(status));
                 }
             }
      else
     {
                printf("exit code %d \n",WEXITSTATUS(status));
            }
 }
    return 0;
 } 

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。如有错误或未考虑完全的地方，望不吝赐教。

最新评论