Python 命令行参数以及代码编译发布为可执行文件

Posted 2023-02-09 大作家佚名

Python 命令行参数以及代码编译发布为可执行文件

• 1. Python 命令行参数
• • 1.1 Python 中也可以所用 sys 的 sys.argv 来获取命令行参数
  • 1.2 Python 提供了 getopt 模块来获取命令行参数。
• 2. Python代码编译发布为可执行文件
• • 2.1 打包工具Pyinstaller
  • 2.2 安装Pyinstaller
  • 2.3 Pyinstaller参数作用
  • 2.4 开始打包

1. Python 命令行参数

$ python test.py arg1 arg2 arg3

1.1 Python 中也可以所用 sys 的 sys.argv 来获取命令行参数

sys.argv 是命令行参数列表。
len(sys.argv) 计算命令行参数个数。
注：sys.argv[0] 表示脚本名。

实例 test.py 文件代码如下：

#!/usr/bin/python3
import sys
print ('参数个数为:', len(sys.argv), '个参数。')
print ('参数列表:', str(sys.argv))
print ('脚本名:', str(sys.argv[0]))

执行以上代码，输出结果为：

$ python3 test.py arg1 arg2 arg3
参数个数为: 4 个参数。
参数列表: ['test.py', 'arg1', 'arg2', 'arg3']
脚本名: test.py

1.2 Python 提供了 getopt 模块来获取命令行参数。

getopt 模块是专门处理命令行参数的模块，用于获取命令行选项和参数，也就是 sys.argv。命令行选项使得程序的参数更加灵活。支持短选项模式 - 和长选项模式 --。该模块提供了两个方法及一个异常处理来解析命令行参数。getopt怎么用，首先导入关键模块：

import sys
import getopt

在使用的时候，由于getopt函数是getopt包里面的一个函数,所以要getopt.getopt(…)这么用。
getopt.getopt 方法 用于解析命令行参数列表，语法格式如下：

getopt.getopt(args, shortopts, longopts=[])

方法参数说明：

• args: 是参数列表。直接把 sys.args[1:] 切片传进来就可以。
• shortopts: 这个参数是个字符串，把需要解析的“短选项”挨着写在一起就可以，这里的“短选项”指的是以 ‘-’ 开头的选项，叫短选项是因为这种选项只支持单个字母，就算你写 -test 这样子的参数，能被 getopt 识别出来的也是 -t 和 est，其中 est 会被当作 -t 选项的参数。所以假设你想支持 “-h -i -o” 三个短选项， shortopts 就可以写成 “hio”。如果其中某个短选项想要接受参数，比如 “-h -i inputfile -o outputfile”，那就需要在字母后面加 “:” 冒号，变成 “hi: o:”
• longopts=[]: 这个参数是个列表，因为每个长选项有多个字母，不可能像短选项一样用一个字符串就都表示出来。所谓长选项，就是以 “–” 开头的选项，比如 --usr --ifile --ofile 等，传参的时候写成 [‘–user’, ‘–ifile’, ‘–ofile’]，如果某个选项需要接受参数，则在后面加 “=” 等号，比如 [‘–user’, ‘–ifile=’, ‘–ofile=’]。

返回值，有两个：

• opts： 是有一个列表，列表里是元组（opt, value）的格式。比如上面的 “-h -i inputfile -o outputfile” 那就是 [(‘-h’, ‘’), (‘-i’, ‘inputfile’), (‘-o’, ‘outputfile’)] 这样的返回值。长选项和短选项以及各自的参数都会按先后次序放在这里。用的时候可以以 for opt,val in opts: 这样的方式来遍历。值得注意的是，返回的 opt 里面，‘-’ 和 ‘–’ 都被保留下来了，另外，当用户输入的长选项没有写完的时候，会被自动补全。比如用户输入的是 --u，通过 getopt 会被自动补全成 --user，这个需要注意（除非有两个长选项都有相同的开头，无法确定是哪个）。
• args： 如果用户输入的信息太多，除了长选项和短选项以及各自选项的参数以外，还有一些其它的未知的参数，则会被放到这里。

接下来我们定义一个 site() 函数，然后通过命令行输入站点名称 name 和网址 url，可以用缩写 n 和 u。
实例演示短选项：

import sys
import getopt

def site():
    name = None
    url = None

    argv = sys.argv[1:]

    try:
        opts, args = getopt.getopt(argv, "n:u:")  # 短选项模式

    except:
        print("Error")

    for opt, arg in opts:
        if opt in ['-n']:
            name = arg
        elif opt in ['-u']:
            url = arg

    print(name + " " + url)

site()

测试以上代码，命令行中输入：

python3 test.py -n RUNOOB -u www.runoob.com

输出结果为：

RUNOOB www.runoob.com

实例演示长选项

import sys
import getopt
 
def site():
    name = None
    url = None
 
    argv = sys.argv[1:]
 
    try:
        opts, args = getopt.getopt(argv, "n:u:",  
                                   ["name=",
                                    "url="])  # 长选项模式
     
    except:
        print("Error")
 
    for opt, arg in opts:
        if opt in ['-n', '--name']:
            name = arg
        elif opt in ['-u', '--url']:
            url = arg
     
 
    print( name + " " + url)
 
site()

测试以上代码，命令行中输入：

python3 test.py -n RUNOOB -u www.runoob.com

输出结果为：

RUNOOB www.runoob.com

参考：
[1] Python3 命令行参数
[2] python中getopt函数详解
[3] Python中getopt的用法详解

2. Python代码编译发布为可执行文件

2.1 打包工具Pyinstaller

PyInstaller其实就是把python解析器和你自己的脚本打包成一个可执行的文件，和编译成真正的机器码完全是两回事，所以千万不要指望成打包成一个可执行文件会提高运行效率，相反可能会降低运行效率，好处就是在运行者的机器上不用安装python和你的脚本依赖的库。

2.2 安装Pyinstaller

如果网络稳定，通常直接使用下面的命令安装即可：

pip install pyinstaller

检查pyinstaller安装成功与否，只需要执行如下命令其中一个即可：

pyinstaller --version
pyinstaller -v

2.3 Pyinstaller参数作用

-F 表示生成单个可执行文件
-D –onedir 创建一个目录，包含exe文件，但会依赖很多文件（默认选项）
-w 表示去掉控制台窗口，这在GUI界面时非常有用。不过如果是命令行程序的话那就把这个选项删除吧
-c –console, –nowindowed 使用控制台，无界面(默认)
-p 表示你自己自定义需要加载的类路径，一般情况下用不到
-i 表示可执行文件的图标
其他参数，可以通过pyinstaller --help查看

2.4 开始打包

进入python需要打包的脚本所在目录，然后执行下面的命令即可：

pyinstaller -F test.py

详见：
[1] Python如何生成可执行的.exe文件
[2] python代码编译发布为可执行文件
[3] 如何将Python程序打包成linux可执行文件