随手可用的Python命令行小工具

安全运维得看我 2024-06-05 11:12:44

熟悉Perl和Ruby的同学都可能用过其命令行选项和命令行模块运行,这些统统被称为“oneline”命令。而用Python则更多是进入python交互解释执行模式,该模式下可以执行任意Python脚本,但是该模式略显啰嗦麻烦,而且不能直接Ctrl+c 等快捷退出,不是很方便。那么Python有没有Perl 单行命令执行模式呢?回答是没有的,但是Python有类似于Perl -m的-m模块快捷执行模式,有点类似Perl oneline形式,本文虫虫给大家总结一下Python的模块命令行可执行的很有用的便捷小工具。

概述

Python解释器也支持一个-m选项,使用该选项可以直接运行Python模块,比如大家可以都用过的用Python起一个便携式Web服务器的命令:

python -m http.server

该命令运行http.server模块作为脚本,并监听默认端口8000在本地上启动一个Web便携式服务器,服务器以启动命令时所在目录为根目录,可以用于通过Web服务分享一些文件、文档或者一些简单的Web服务。

-m

-m 命令行运行参数告诉Python运行给定的Python模块,就好像将其作为脚本运行。这类模块有些模块在import做一些初始化设置,并以小工具形式打开。例如 __hello__就会运行一个小程序Hello,Word(无需我们专门写),显示显示一个直接打印Hello,Word!

绝大多数的模块,并不支持这种命令行脚本执行模式,但是也有一些模块专门提供了这样功能,可以供我们便捷运行和功能演示。Python使用一个__name__变量来区分导入模块和将模块作为脚本运行。

当Python 作为脚本运行模块时,它将模块的名称设置为字符串 "__main__" 通常情况下__name__将包含模块的实际名称。对于包,Python搜寻__main__.py (有一个在要运行的文件zipfile包)。

模块提供这种机制,可用于我们使用一些非常实用的命令行便携工具(oneline)。

Python 标准库包括许多这样的小工具模块,可以作为日常称手工具来使用,虫虫参考官方文档,有一个完整的小工具列表:

http.server

webbrowser

json.tool

calendar

uuid

sqlite3

zipfile

gzip

tarfile

等等

通用命令行工具

在这些模块中,最有用就是一些通用命令行实用工具,这些小工具即时我们不懂Python代码,也可以在具有Python的环境中使用。

python -m http.server启动一个简单的Web服务器。

python -m webbrowser 启动网络浏览器。

python -m json.tool 格式化JSON数据。

python -m calendar 显示命令行日历。

http.server 启动一个Web服务器,详细介绍见概述部分,这是最有用最方便的工具。

webbrowser

运webbrowser模块作为脚本将在默认Web浏览器中打开给定的URL。 例如,

python -m webbrowser -t URL

json.tool

json.tool模块可以作为脚本运行来解析JSON文档并格式化方式显示出来。

echo '{"name":"Chonchong","ID":1,"IsShoW":false,"data":{"number":"41856"}}' |python -m json.tool

calendar

运行calendar模块作为脚本将默认打印本年所有月的日历。

当然可以直接定参数,比如显示上个月的日历:

python -m calendar 2024 05

以上四个模块是通用工具,且为Python内部包自带,可以在任何有Python环境的电脑上都可以使用。

非Linux环境下的shell工具平替

有很多很有用的Linux shell工具无法在Windows或Mac下运行,但是却非常适用的,比如uuid,sqlite3和gzip。下面这些工具则可以作为平替在有Python环境的非Linux系统上使用。

python3.12 -m uuid uuidgen CLI实用程序

python3.12 -m sqlite3 sqlite3 CLI实用程序

python -m zipfile zip和unzip CLI实用程序

python -m gzip gzip & gunzip CLI实用程序

python -m tarfile tar CLI实用程序

python -m base64 base64 CLI实用程序

python -m ftplib ftp小工具

python -m smtplib sendmail 工具

python -m poplib 邮件小工具(Pop协议)

python -m imaplib 邮件小工具(Imap协议)

python -m telnetlib telnet小工具

注意, uid和sqlite3是在Python 3.12中添加的,需要3.12+版本才可以用。

Python代码工具

还有一些工具适用于进行Python编程时候,用户处理Python代码的辅助工具。

pip

pip大家都熟悉,为Python的官方包管理器,可以用安装和管理第三方模块和包。

venv

venv模块用户创建虚拟环境。

pdb

pdb模块为Python GDB风格的命令行调试器。可以启动内置的断点调试功能,pdb命令默认将在程序的第一行设置PDB断点。

unittest

unittest模块可用于在Python自动化测试。是Python自带的测试框架,它基于JUnit的单元测试框架,支持测试自动化和单元测试。提供了一组用于编写和运行测试的工具和库,包括测试装置、测试套件和测试运行器。运行unittest可以在当前目录中搜索所有测试用例,并自动执行。

pydoc

运行pydoc模块作为命令行脚本将显示给定模块或对象的文档。如果将相同的对象名称传递给内置函数,也会看到同样的文档内容。

doctest

运行doctest命令行脚本将评估给定Python文件中的所有测试文档。

ensurepip

ensurepip脚本适用于那些发现不小心误删除pip并需要重装。

idlelib

有没有想过如何从命令行启动Python的图形IDLE工具,只需运行python -m idlelib。

zipapp

想要将Python模块捆绑到由Python直接运行的ZIP文件,则可以运行python -m zipapp my_module帮你是实现这个功能。

Python代码分析工具

Python还包括一些其他专门用于分析Python代码分析工具。如果想分析一些Python代码以了解其运行方式,这些工具可能会帮上大忙。

Tokenize 将Python模块分解为“标记”树

ast 显示代码的抽象语法树

dis 将Python代码反汇编为字节码

inspect检查Python对象的源代码

pyclbr 查看模块对象的概述

asyncio 启动异步感知REPL

cProfile 分析Python程序

profile 使用Python分析 Python 程序

pstats 显示cProfile生成的文件的统计信息

pickle 可读地显示pickle文件内容

pickletools 反汇编pickle文件

tabnanny 检查文件中是否存在混合制表符和空格

根据名字tokenize, ast,和dis模块的就可以基本知道其相应的功能。

tokenize

tokenize 模块/脚本会 Python文件分解为“令牌”树,比如对于一个源码为:

hello.py文件分析:

python -m tokenize hello.py

ast

ast模块/脚本更进一步,将标记转变为“抽象语法树”:

python -m ast hello.py

dis

dis模块将抽象语法树分解为Python“字节码”:

python -m dis hello.py

inspect

inspect模块可以用作脚本来检查给定Python对象的源代码。

pyclbr

pyclbr模块用来快速概览特定Python模块中的每个类、方法和函数:

pyclbr名称为“Python类浏览器”简称,它最初只是用于浏览类和方法。

asyncio

如果写过async/await异步程序,则可能会发现异步REPL很方便。

python -m asyncio

cProfile & pstats

cProfile脚本将通过记录代码在各种操作和各种函数中花费的时间来分析的代码。

python -m cProfile -s tottime -m http.server 8000

pstat命令可以处理和计算由cProfile生成的配置文件的输出的统计信息。profile脚本相当于cProfile脚本,但它完全是用Python编写的并且速度较慢,所以cProfile优于profile。

pickle & pickletools

有一个pickle对象序列化文件并想看看里面有什么?运行pickle模块解析并显示这类的数据:

运行pickletools模块将显示每条数据的详细解释:

code

code模块用于制作交互式Python解释器,启动运行交互式Python REPL:

runpy

这runpy模块用于按名称动态运行给定的Python模块。

python -m runpy runpy runpy unittest

小玩具

还有要提到是一些,专门用于好玩的小工具。比如,_hello_和Python复活节彩蛋等。

__hello__

前面讲过了。

this

想在终端上看到Zen of Python的打印结果吗?任何一个import this或运行this作为脚本:

antigravity

antigravity模块将直接打开你浏览器导航到XKCD漫画页面。

python -m antigravity

总结

本文列举了Python模块中自带的命令行工具,善用这些工具可以很便捷帮我们做一些功能,而且可以极大提高我们Python语言内功和发现如多称手的Python“瑞士军刀”,可以发现很多工具在Python内置包中已经提供另外,我们无需另外安装和借助第三方的工具。当然如果你在写Python模块的话,也可以试着实现一些类似的小工具。

1 阅读:156

安全运维得看我

简介:感谢大家的关注