Python3 Shell脚本执行-手动timeout

Python 3.6.8
场景:特殊的网络场景,有多台服务器的数据需要收集和整理,其中有多个环节需进行SSH和SCP;网络和服务器都是不稳定的,这时设置超时必不可少,比如,ssh认证如果出现问题,shell命令会要求输入密码,那条线就彻底挂起了,池子就变小了;而且这种挂起的日志容易被掩埋,导致问题无法及时处理;希望代码对你有帮助

过程说明

最初使用了subprocess的getstatusoutput直接获得执行状态和结果,功能是达到了,但后续出现了两种问题,导致任务堵塞了。一个是ssh执行命令,一个是shell脚本执行时间过长,其实是有异常"假死"了。这时任务应该跳过继续进行或重试,所以需要进行超时判断,设置好超时时间。

首先我查了文档,发现getstatusoutput封装了check_output,底层是Popen都是有timeout参数的,但设置上后还是无效。查看了之前的邮件组后发现了原因,关键是如果命令创建了新的子线程,子线程是没有超时的,python不会选择kill group;因为python无法确定子线程要做什么,不能简单粗暴,交由使用者决定怎么处理。而且不同平台的支持支持也不同,python不想做这吃力不讨好的事。

那么就自力更生吧,我的目标就是只要是超时就结束并返回异常。最终有了以下的代码:

代码

import subprocess
import time
import logging

# 执行shell命令的方法
# cmd shell命令, timeout 超时:秒
# return (执行状态:int,执行结果:str,执行错误:str)
def run_cmd(cmd, timeout=None):
    try:
        exec_status = -1
        exec_err = ""
        exec_result = ""
        # deprecated,无法提供超时功能
        # exec_status, exec_result = subprocess.getstatusoutput(cmd)

        try:
            # shell=True 因为需要使用通道和字符串子命令,所以默认打开
            with subprocess.Popen(cmd,  shell=True, universal_newlines=True, stderr=subprocess.STDOUT,stdout=subprocess.PIPE) as process:
                # 主要超时控制
                if timeout:
                    to_count = 0
                    while True:
                        # interval sec: 5 因为还有很多long time command,超时间隔不需要太细
                        time.sleep(5)
                        to_count += 5
                        if to_count > timeout:
                            # 回归到subprocess的超时处理
                            process.kill()
                            raise subprocess.TimeoutExpired(process.args, timeout, output=None,
                                             stderr=None)
                        if process.poll() is None:
                            continue
                        else:
                            break

                try:
                    # 完成后获取结果
                    stdout, stderr = process.communicate(input)
                # 此处是subprocess的异常处理,直接使用
                except subprocess.TimeoutExpired:
                    process.kill()
                    stdout, stderr = process.communicate()
                    raise subprocess.TimeoutExpired(process.args, timeout, output=stdout,
                                         stderr=stderr)
                except:
                    process.kill()
                    process.wait()
                    raise
                retcode = process.poll()
                if retcode:
                    raise subprocess.CalledProcessError(retcode, process.args,
                                             output=stdout, stderr=stderr)
                data = subprocess.CompletedProcess(process.args, retcode, stdout, stderr).stdout
                exec_status = 0
        except subprocess.CalledProcessError as ex:
            data = ex.output
            exec_status = ex.returncode
        if data[-1:] == '\n':
            exec_result = data[:-1]

        if exec_status != 0:
            exec_err = exec_result
            exec_result = None
        return exec_status, exec_result, exec_err
    # 自身封装的异常处理,为了记录和返回统一格式
    except subprocess.TimeoutExpired:
        logging.error("cmd:{} is timeout".format(cmd))
        return -9, None, "timeout"
    except BaseException as ose:
        logging.error("cmd:{} error:{}".format(cmd, ose.__str__()))
        return -1, None, ose.__str__()

测试代码

run_cmd("sleep 4m", 10)
run_cmd("python", 10)
run_cmd("python")
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容