mirror of
https://github.com/LCTT/TranslateProject.git
synced 2025-01-19 22:51:41 +08:00
Merge pull request #14706 from wxy/20190703-Parse-arguments-with-Python
PRF&PUB:20190703 Parse arguments with Python
This commit is contained in:
Xingyu.Wang
GitHub
commit
3c35ed073d
@ -1,67 +1,63 @@
|
||||
[#]: collector: (lujun9972)
|
||||
[#]: translator: (geekpi)
|
||||
[#]: reviewer: ( )
|
||||
[#]: publisher: ( )
|
||||
[#]: url: ( )
|
||||
[#]: reviewer: (wxy)
|
||||
[#]: publisher: (wxy)
|
||||
[#]: url: (https://linux.cn/article-11144-1.html)
|
||||
[#]: subject: (Parse arguments with Python)
|
||||
[#]: via: (https://opensource.com/article/19/7/parse-arguments-python)
|
||||
[#]: author: (Seth Kenlon https://opensource.com/users/seth/users/notsag)
|
||||
|
||||
使用 Python 解析参数
|
||||
======
|
||||
使用 argparse 模块像专业人士一样解析参数。
|
||||
![COBOL punch card][1]
|
||||
|
||||
> 使用 argparse 模块像专业人士一样解析参数。
|
||||
|
||||
|
||||
|
||||
如果你在使用 [Python][2] 进行开发，你可能会在终端中使用命令，即使只是为了启动 Python 脚本或使用 [pip][3] 安装 Python 模块。命令可能简单而单一：
|
||||
|
||||
|
||||
```
|
||||
`$ ls`
|
||||
$ ls
|
||||
```
|
||||
|
||||
命令也可能需要参数：
|
||||
|
||||
|
||||
```
|
||||
`$ ls example`
|
||||
$ ls example
|
||||
```
|
||||
|
||||
命令也可以有选项或标志：
|
||||
|
||||
|
||||
```
|
||||
`$ ls --color example`
|
||||
$ ls --color example
|
||||
```
|
||||
|
||||
有时选项也有参数：
|
||||
|
||||
|
||||
```
|
||||
`$ sudo firewall-cmd --list-all --zone home`
|
||||
$ sudo firewall-cmd --list-all --zone home
|
||||
```
|
||||
|
||||
### 参数
|
||||
|
||||
POSIX shell 会自动将你输入的内容作为命令分成数组。例如，这是一个简单的命令：
|
||||
|
||||
|
||||
```
|
||||
`$ ls example`
|
||||
$ ls example
|
||||
```
|
||||
|
||||
命令 **ls** 的位置是 **$0**，参数 **example** 位置是 **$1**。
|
||||
命令 `ls` 的位置是 `$0`，参数 `example` 位置是 `$1`。
|
||||
|
||||
你_可以_写一个循环迭代每项。确定它是否是命令、选项还是参数。并据此采取行动。幸运的是，已经有一个名为 [argparse][4] 的模块。
|
||||
你**可以**写一个循环迭代每项。确定它是否是命令、选项还是参数。并据此采取行动。幸运的是，已经有一个名为 [argparse][4] 的模块。
|
||||
|
||||
### Argparse
|
||||
### argparse
|
||||
|
||||
argparse 模块很容易集成到 Python 程序中，并有多种便利功能。例如，如果你的用户更改选项的顺序或使用一个不带参数的选项（称为_布尔_，意味着选项可以打开或关闭设置），然后另一个需要参数（例如 **\--color red**），argparse 可以处理多种情况。如果你的用户忘记了所需的选项，那么 argparse 模块可以提供友好的错误消息。
|
||||
argparse 模块很容易集成到 Python 程序中，并有多种便利功能。例如，如果你的用户更改选项的顺序或使用一个不带参数的选项（称为**布尔**，意味着选项可以打开或关闭设置），然后另一个需要参数（例如 `--color red`），argparse 可以处理多种情况。如果你的用户忘记了所需的选项，那么 argparse 模块可以提供友好的错误消息。
|
||||
|
||||
要在应用中使用 argparse，首先要定义为用户提供的选项。你可以接受几种不同的参数，但语法一致又简单。
|
||||
要在应用中使用 argparse，首先要定义为用户提供的选项。你可以接受几种不同的参数，而语法一致又简单。
|
||||
|
||||
这是一个简单的例子：
|
||||
|
||||
|
||||
```
|
||||
#!/usr/bin/env python
|
||||
import argparse
|
||||
@ -77,22 +73,20 @@ def getOptions(args=sys.argv[1:]):
|
||||
return options
|
||||
```
|
||||
|
||||
此示例代码创建一个名为 **getOptions** 的函数，并告诉 Python 查看每个可能的参数，前面有一些可识别的字符串（例如 **\--input** 或者 **-i**）。 Python 找到的任何选项都将作为 **options** 对象从函数中返回（**options** 是一个任意名称，且没有特殊含义。它只是一个包含函数已解析的所有参数的摘要的数据对象）。
|
||||
此示例代码创建一个名为 `getOptions` 的函数，并告诉 Python 查看每个可能的参数，前面有一些可识别的字符串（例如 `--input` 或者 `-i`）。 Python 找到的任何选项都将作为 `options` 对象从函数中返回（`options` 是一个任意名称，且没有特殊含义。它只是一个包含函数已解析的所有参数的摘要的数据对象）。
|
||||
|
||||
默认情况下，Python 将用户给出的任何参数视为字符串。如果需要提取整数（数字），则必须指定选项 **type=int**，如示例代码中的 **\--number** 选项。
|
||||
默认情况下，Python 将用户给出的任何参数视为字符串。如果需要提取整数（数字），则必须指定选项 `type=int`，如示例代码中的 `--number` 选项。
|
||||
|
||||
如果你有一个只是关闭和打开功能的参数，那么你必须使用 **boolean** 类型，就像示例代码中的 **\--verbose** 标志一样。这种选项只保存 **True** 或 **False**，用户用来指定是否使用标志。如果使用该选项，那么会激活 **stored_true**。
|
||||
|
||||
当 **getOptions** 函数运行时，你就可以使用 **options** 对象的内容，并让程序根据用户调用命令的方式做出决定。你可以使用测试打印语句查看**选项**的内容。将其添加到示例文件的底部：
|
||||
如果你有一个只是关闭和打开功能的参数，那么你必须使用 `boolean` 类型，就像示例代码中的 `--verbose` 标志一样。这种选项只保存 `True` 或 `False`，用户用来指定是否使用标志。如果使用该选项，那么会激活 `stored_true`。
|
||||
|
||||
当 `getOptions` 函数运行时，你就可以使用 `options` 对象的内容，并让程序根据用户调用命令的方式做出决定。你可以使用测试打印语句查看 `options` 的内容。将其添加到示例文件的底部：
|
||||
|
||||
```
|
||||
`print(getOptions())`
|
||||
print(getOptions())
|
||||
```
|
||||
|
||||
然后带上参数运行代码：
|
||||
|
||||
|
||||
```
|
||||
$ python3 ./example.py -i foo -n 4
|
||||
Namespace(input='foo', number=4, output=None, verbose=False)
|
||||
@ -100,8 +94,7 @@ Namespace(input='foo', number=4, output=None, verbose=False)
|
||||
|
||||
### 检索值
|
||||
|
||||
示例代码中的 **options** 对象包含了用户提供的选项后面的值（或派生的布尔值）。例如，在示例代码中，可以通过 **options.number** 来检索 **\--number**。
|
||||
|
||||
示例代码中的 `options` 对象包含了用户提供的选项后面的值（或派生的布尔值）。例如，在示例代码中，可以通过 `options.number` 来检索 `--number`。
|
||||
|
||||
```
|
||||
options = getOptions(sys.argv[1:])
|
||||
@ -118,12 +111,11 @@ print(options.number)
|
||||
# 这里插入你的 Python 代码
|
||||
```
|
||||
|
||||
示例中的布尔选项 **\--verbose** 是通过测试 **options.verbose** 是否为 True（意味着用户使用了 **\--verbose** 标志）或 False（用户没有使用 **\--verbose** 标志），并采取相应的措施。
|
||||
示例中的布尔选项 `--verbose` 是通过测试 `options.verbose` 是否为 `True`（意味着用户使用了 `--verbose` 标志）或 `False`（用户没有使用 `--verbose` 标志），并采取相应的措施。
|
||||
|
||||
### 帮助和反馈
|
||||
|
||||
argparse 还包含一个内置的 **\--help**（简称 **-h**）选项，它提供了有关如何使用命令的提示。这是从你的代码派生的，因此生成此帮助系统不需要额外的工作：
|
||||
|
||||
argparse 还包含一个内置的 `--help`（简写 `-h`）选项，它提供了有关如何使用命令的提示。这是从你的代码派生的，因此生成此帮助系统不需要额外的工作：
|
||||
|
||||
```
|
||||
$ ./example.py --help
|
||||
@ -144,11 +136,10 @@ optional arguments:
|
||||
|
||||
### 像专业人士一样用 Python 解析
|
||||
|
||||
这是一个简单的示例，来演示如何在 Python 应用中的解析参数以及如何快速有效地记录它的语法。下次编写 Python 脚本时，请使用 argparse 为其提供一些选项。 你以后会感谢自己，你的命令不会像一个快速的 hack，更像是一个“真正的” Unix 命令！
|
||||
这是一个简单的示例，来演示如何在 Python 应用中的解析参数以及如何快速有效地记录它的语法。下次编写 Python 脚本时，请使用 argparse 为其提供一些选项。你以后会感到自得，你的命令不会像一个快速的临时脚本，更像是一个“真正的” Unix 命令！
|
||||
|
||||
以下是可用于测试的示例代码：
|
||||
|
||||
|
||||
```
|
||||
#!/usr/bin/env python3
|
||||
# GNU All-Permissive License
|
||||
@ -188,7 +179,7 @@ via: https://opensource.com/article/19/7/parse-arguments-python
|
||||
作者：[Seth Kenlon][a]
|
||||
选题：[lujun9972][b]
|
||||
译者：[geekpi](https://github.com/geekpi)
|
||||
校对：[校对者ID](https://github.com/校对者ID)
|
||||
校对：[wxy](https://github.com/wxy)
|
||||
|
||||
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
|
||||
|
||||
Loading…
Reference in New Issue
Block a user