PyTips 0x06 - Python 开发命令行工具

Shihira 发布于2019-07-24 18:32 / 2911人阅读

摘要：项目地址作为一种脚本语言，可以非常方便地用于系统尤其是系统命令行工具的开发。自身也集成了一些标准库，专门用于处理命令行相关的问题。命令行工具的一般结构标准输入输出系统中，一切皆为文件，因此标准输入输出可以完全可以看做是对文件的操作。

项目地址：https://git.io/pytips

Python 作为一种脚本语言，可以非常方便地用于系统（尤其是*nix系统）命令行工具的开发。Python 自身也集成了一些标准库，专门用于处理命令行相关的问题。

命令行工具的一般结构：

1. 标准输入输出

*nix 系统中，一切皆为文件，因此标准输入、输出可以完全可以看做是对文件的操作。标准化输入可以通过管道（pipe）或重定向（redirect）的方式传递：

# script reverse.py
#!/usr/bin/env python
import sys
for l in sys.stdin.readlines():
    sys.stdout.write(l[::-1])

保存为 reverse.py，通过管道 | 传递：

chmod +x reverse.py
cat reverse.py | ./reverse.py

nohtyp vne/nib/rsu/!#
sys tropmi
:)(senildaer.nidts.sys ni l rof
)]1-::[l(etirw.tuodts.sys

通过重定向 < 传递：

./reverse.py < reverse.py
# 输出结果同上

2. 命令行参数

一般在命令行后追加的参数可以通过 sys.argv 获取， sys.argv 是一个列表，其中第一个元素为当前脚本的文件名：

# script argv.py
#!/usr/bin/env python
import sys
print(sys.argv) # 下面返回的是 Jupyter 运行的结果

["/Users/rainy/Projects/GitHub/pytips/venv3/lib/python3.5/site-packages/ipykernel/__main__.py", "-f", "/Users/rainy/Library/Jupyter/runtime/kernel-0533e681-bd7c-4c4d-9094-a78fde7fc2ed.json"]

运行上面的脚本：

chmod +x argv.py
./argv.py hello world
python argv.py hello world

# 返回的结果是相同的
# ["./test.py", "hello", "world"]

对于比较复杂的命令行参数，例如通过 --option 传递的选项参数，如果是对 sys.argv 逐项进行解析会很麻烦，Python 提供标准库 argparse（旧的库为 optparse，已经停止维护）专门解析命令行参数：

# script convert.py
#!/usr/bin/env python
import argparse as apa
def loadConfig(config):
    print("Load config from: {}".format(config))
def setTheme(theme):
    print("Set theme: {}".format(theme))
def main():
    parser = apa.ArgumentParser(prog="convert") # 设定命令信息，用于输出帮助信息
    parser.add_argument("-c", "--config", required=False, default="config.ini")
    parser.add_argument("-t", "--theme", required=False, default="default.theme")
    parser.add_argument("-f") # Accept Jupyter runtime option
    args = parser.parse_args()
    loadConfig(args.config)
    setTheme(args.theme)

if __name__ == "__main__":
    main()

Load config from: config.ini
Set theme: default.theme

利用 argparse 可以很方便地解析选项参数，同时可以定义指定参数的相关属性（是否必须、默认值等），同时还可以自动生成帮助文档。执行上面的脚本：

./convert.py -h
usage: convert [-h] [-c CONFIG] [-t THEME]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
  -t THEME, --theme THEME

3. 执行系统命令

当 Python 能够准确地解读输入信息或参数之后，就可以通过 Python 去做任何事情了。这里主要介绍通过 Python 调用系统命令，也就是替代 Shell 脚本完成系统管理的功能。我以前的习惯是将命令行指令通过 os.system(command) 执行，但是更好的做法应该是用 subprocess 标准库，它的存在就是为了替代旧的 os.system; os.spawn* 。

subprocess 模块提供简便的直接调用系统指令的call()方法，以及较为复杂可以让用户更加深入地与系统命令进行交互的Popen对象。

# script list_files.py
#!/usr/bin/env python
import subprocess as sb
res = sb.check_output("ls -lh ./*.ipynb", shell=True) # 为了安全起见，默认不通过系统 Shell 执行，因此需要设定 shell=True
print(res.decode()) # 默认返回值为 bytes 类型，需要进行解码操作

-rw-r--r--  1 rainy  staff   3.4K  3  8 17:36 ./2016-03-06-The-Zen-of-Python.ipynb
-rw-r--r--  1 rainy  staff   6.7K  3  8 17:45 ./2016-03-07-iterator-and-generator.ipynb
-rw-r--r--  1 rainy  staff   6.0K  3 10 12:35 ./2016-03-08-Functional-Programming-in-Python.ipynb
-rw-r--r--  1 rainy  staff   5.9K  3  9 16:28 ./2016-03-09-List-Comprehension.ipynb
-rw-r--r--  1 rainy  staff    10K  3 10 14:14 ./2016-03-10-Scope-and-Closure.ipynb
-rw-r--r--  1 rainy  staff   8.0K  3 11 16:30 ./2016-03-11-Arguments-and-Unpacking.ipynb
-rw-r--r--  1 rainy  staff   8.5K  3 14 19:31 ./2016-03-14-Command-Line-tools-in-Python.ipynb

如果只是简单地执行系统命令还不能满足你的需求，可以使用 subprocess.Popen 与生成的子进程进行更多交互：

import subprocess as sb

p = sb.Popen(["grep", "communicate"], stdin=sb.PIPE, stdout=sb.PIPE)
res, err = p.communicate(sb.check_output("cat ./*", shell=True))
if not err:
    print(res.decode())

  "    "p = sb.Popen(["grep", "communicate"], stdout=sb.PIPE)
",
",
  "    "# res = p.communicate(sb.check_output("cat ./*"))"
",
"p = sb.Popen(["grep", "communicate"], stdin=sb.PIPE, stdout=sb.PIPE)
",
"res, err = p.communicate(sb.check_output("cat ./*", shell=True))
",

欢迎关注公众号 PyHub！

GPU服务器海外云主机命令行工具 php命令行工具命令行ddos工具linux 服务器命令行管理工具

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/37810.html

PyTips 0x07 - Python 字符串

摘要：项目地址所有用过的人应该都看过下面两行错误信息这就是界的锟斤拷今天和接下来几期的内容将主要关注中的字符串字节及两者之间的相互转换。项目地址：https://git.io/pytips 所有用过 Python (2&3)的人应该都看过下面两行错误信息： UnicodeEncodeError: ascii codec cant encode characters in position...

go4it 2019-07-24 18:32 评论0 收藏0
PyTips 0x16 - Python 迭代器工具

摘要：借鉴了中的某些迭代器的构造方法，并在中实现该模块是通过实现，源代码。项目地址：https://git.io/pytips 0x01 介绍了迭代器的概念，即定义了 __iter__() 和 __next__() 方法的对象，或者通过 yield 简化定义的可迭代对象，而在一些函数式编程语言（见 0x02 Python 中的函数式编程）中，类似的迭代器常被用于产生特定格式的列表（或序列）...

mayaohua 2019-07-31 11:42 评论0 收藏0
PyTips 0x04 - Python 闭包与作用域

摘要：项目地址闭包在计算机科学中，闭包英语，又称词法闭包或函数闭包，是引用了自由变量的函数。这个被引用的自由变量将和这个函数一同存在，即使已经离开了创造它的环境也不例外。项目地址：https://git.io/pytips 闭包（Closure）在计算机科学中，闭包（英语：Closure），又称词法闭包（Lexical Closure）或函数闭包（function closures），是...

leejan97 2019-07-24 18:30 评论0 收藏0
PyTips 0x17-Python 中的枚举类型

摘要：中的枚举类型枚举类型可以看作是一种标签或是一系列常量的集合，通常用于表示某些特定的有限集合，例如星期月份状态等。 Python 中的枚举类型枚举类型可以看作是一种标签或是一系列常量的集合，通常用于表示某些特定的有限集合，例如星期、月份、状态等。Python 的原生类型（Built-in types）里并没有专门的枚举类型，但是我们可以通过很多方法来实现它，例如字典、类等： WEEKD...

yedf 2019-07-25 10:17 评论0 收藏0
Evil Python

摘要：用将倒放这次让我们一个用做一个小工具将动态图片倒序播放发现引力波的机构使用的包美国科学家日宣布，他们去年月首次探测到引力波。宣布这一发现的，是激光干涉引力波天文台的负责人。这个机构诞生于上世纪年代，进行引力波观测已经有近年。那些年我们写过的爬虫从写 nodejs 的第一个爬虫开始陆陆续续写了好几个爬虫，从爬拉勾网上的职位信息到爬豆瓣上的租房帖子，再到去爬知乎上的妹子照片什么的，爬虫...

Turbo 2019-07-30 15:07 评论0 收藏0