代码收藏家 argcomplete：一个酷炫的Python库，让命令行自动补全变得简单！
前言
大家好，今天为大家分享一个超酷的 Python 库 – argcomplete。
Github地址：https://github.com/kislyuk/argcomplete
命令行工具是开发者和系统管理员的得力助手，但随着命令行选项的增多，用户可能会感到困惑。Python 中的 argcomplete 库可以帮助轻松地为命令行工具添加自动补全功能，提高用户体验。本文将介绍如何使用 Python argcomplete 库实现命令行自动补全，并提供详细的示例代码和用法说明。
目录
编辑
前言
什么是 Python argcomplete？
安装 Python argcomplete
示例：使用 argparse 实现自动补全
示例：使用 click 实现自动补全
使用 Python argcomplete 进行高级配置
1. 自定义参数提示
2. 忽略特定选项
3. 使用自定义自动补全函数
总结
什么是 Python argcomplete？
Python argcomplete 是一个用于自动补全命令行选项和参数的库，它可以与 argparse 或 click 等常见的命令行解析库一起使用。argcomplete 能够帮助命令行工具自动生成选项和参数的提示，用户只需按下 Tab 键就能看到可用的选项和参数，大大提高了命令行工具的易用性。
安装 Python argcomplete
要开始使用 Python argcomplete，首先需要安装它。
可以使用 pip 包管理器来安装 Python argcomplete：
pip install argcomplete
安装完成后，需要在命令行工具脚本中导入 argcomplete，并启用自动补全功能。
示例：使用 argparse 实现自动补全
首先，将演示如何在一个使用 argparse 的命令行工具中启用自动补全。假设有一个脚本 mycli.py ，用于执行某些操作，它接受 --verbose 和 --output 两个选项。想要为这个脚本添加自动补全功能。
import argparse
def main():
parser = argparse.ArgumentParser(description='My Command Line Tool')
parser.add_argument('--verbose', help='Enable verbose mode', action='store_true')
parser.add_argument('--output', help='Specify output file')
args = parser.parse_args()
if args.verbose:
print('Verbose mode enabled')
if args.output:
print(f'Output file: {args.output}')
if __name__ == '__main__':
main()
要为这个脚本启用自动补全功能，可以在脚本中添加以下代码：
import argparse
import argcomplete
def main():
parser = argparse.ArgumentParser(description='My Command Line Tool')
parser.add_argument('--verbose', help='Enable verbose mode', action='store_true')
parser.add_argument('--output', help='Specify output file')
argcomplete.autocomplete(parser)
args = parser.parse_args()
if args.verbose:
print('Verbose mode enabled')
if args.output:
print(f'Output file: {args.output}')
if __name__ == '__main__':
main()
在上述代码中，首先导入 argcomplete 库，然后在 argcomplete.autocomplete(parser) 中启用自动补全功能。这将自动生成选项和参数的提示，使用户能够更轻松地使用命令行工具。
示例：使用 click 实现自动补全
除了 argparse，argcomplete 也可以与 click 命令行解析库一起使用。下面是一个使用 click 的命令行工具，并添加了自动补全功能的示例。
首先，需要安装 click 库：
pip install click
然后，创建一个名为 mycli.py 的脚本，包含以下代码：
import click
@click.command()
@click.option('--verbose', is_flag=True, help='Enable verbose mode')
@click.option('--output', help='Specify output file')
def main(verbose, output):
if verbose:
click.echo('Verbose mode enabled')
if output:
click.echo(f'Output file: {output}')
if __name__ == '__main__':
main()
接下来，在脚本中添加 argcomplete 的代码以启用自动补全功能：
import click
import argcomplete
@click.command()
@click.option('--verbose', is_flag=True, help='Enable verbose mode')
@click.option('--output', help='Specify output file')
def main(verbose, output):
if verbose:
click.echo('Verbose mode enabled')
if output:
click.echo(f'Output file: {output}')
if __name__ == '__main__':
argcomplete.autocomplete(main)
现在，命令行工具将具有自动补全功能，用户只需按下 Tab 键就能看到可用的选项和参数。
使用 Python argcomplete 进行高级配置
当使用Python的argcomplete库进行命令行自动补全时，可以进行高级配置以满足不同的需求。这包括自定义参数提示、忽略特定选项等。以下是一些常见的高级配置示例：
1. 自定义参数提示
可以为每个选项和参数定义自定义的提示信息，以便用户更好地理解它们的含义。使用 argcomplete 库的 argcomplete.completers 模块可以轻松实现这一点。
例如，可以为 --output 选项定义一个自定义提示信息：
import argparse
import argcomplete
from argcomplete.completers import FilesCompleter
def main():
parser = argparse.ArgumentParser(description='My Command Line Tool')
parser.add_argument('--verbose', help='Enable verbose mode', action='store_true')
parser.add_argument('--output', help='Specify output file', metavar='FILE')
argcomplete.autocomplete(parser)
args = parser.parse_args()
if args.verbose:
print('Verbose mode enabled')
if args.output:
print(f'Output file: {args.output}')
if __name__ == '__main__':
main()
在上述示例中，使用 metavar 参数来为 --output 选项定义了自定义提示信息，以便用户知道它需要输入一个文件名。
2. 忽略特定选项
有时候，可能希望在特定情况下禁用自动补全功能，或者不希望某些选项或参数被自动补全。可以使用 argcomplete 的 argcomplete.exclusive 模块来实现这一点。
以下是一个示例，其中禁用了 --output 选项的自动补全：
import argparse
import argcomplete
from argcomplete.completers import FilesCompleter
from argcomplete.exclusive import mutually_exclusive
def main():
parser = argparse.ArgumentParser(description='My Command Line Tool')
parser.add_argument('--verbose', help='Enable verbose mode', action='store_true')
parser.add_argument('--output', help='Specify output file', metavar='FILE')
parser.add_argument('--input', help='Specify input file', metavar='FILE')
mutually_exclusive(parser, ['--output', '--input']) # 禁用--output和--input同时使用时的自动补全
argcomplete.autocomplete(parser)
args = parser.parse_args()
if args.verbose:
print('Verbose mode enabled')
if args.output:
print(f'Output file: {args.output}')
if args.input:
print(f'Input file: {args.input}')
if __name__ == '__main__':
main()
在上述示例中，使用 mutually_exclusive 函数来禁用了 --output 和 --input 选项同时使用时的自动补全。这样用户就不能同时为这两个选项输入值。
3. 使用自定义自动补全函数
如果需要更高级的自动补全行为，可以定义自己的自动补全函数。这在处理复杂的参数或根据上下文动态生成提示时非常有用。
以下是一个示例，其中定义了一个自定义的自动补全函数来为 --output 选项提供文件名提示：
import argparse
import argcomplete
def custom_completer(prefix, **kwargs):
# 在此自定义自动补全逻辑，返回一个包含建议值的列表
suggestions = ['file1.txt', 'file2.txt', 'file3.txt']
return [s for s in suggestions if s.startswith(prefix)]
def main():
parser = argparse.ArgumentParser(description='My Command Line Tool')
parser.add_argument('--verbose', help='Enable verbose mode', action='store_true')
parser.add_argument('--output', help='Specify output file', metavar='FILE')
argcomplete.autocomplete(parser, custom_completer=custom_completer)
args = parser.parse_args()
if args.verbose:
print('Verbose mode enabled')
if args.output:
print(f'Output file: {args.output}')
if __name__ == '__main__':
main()
在上述示例中，定义了一个名为 custom_completer 的自定义自动补全函数，它返回一个包含建议值的列表。然后，通过 argcomplete.autocomplete 函数将自动补全函数应用于 --output 选项。
总结
Python argcomplete 是一个强大的命令行自动补全库，它可以轻松为命令行工具添加自动补全功能，提高用户体验。本文介绍了如何使用 argcomplete 来实现自动补全，并提供了使用 argparse 和 click 的示例。希望本文能够帮助大家更好地了解和利用 Python argcomplete 库。
