哎呀呀 0.7.1

理由

Python标准库包含optparse、getopt和argparse模块，在野外，你将找到许多基于这些模块的替代命令行界面库，如cliff、cement、opster、plac以及许多其他库。其中一些库将应用程序的命令行界面设置与实际代码分开，一些强制使用另一个参数解析API，一些强制你将代码隐藏在非直观的框架结构中，还有一些甚至添加了对其他模块的依赖。

这使得你尖叫“哎呀呀”。哇，它就在这里！

用法

哎呀呀将几乎所有工作委托给argparse模块，该模块在处理参数和打印使用信息方面做得很好。然而，对于许多简单应用程序而言，argparse有点冗长且繁琐，因此哎呀呀允许应用程序作者通过将常用的argparse功能包装在几个非侵入性装饰器中，最小化样板代码。哎呀呀没有隐藏argparse API，因为装饰器具有与它们的argparse对应物完全相同的API。这是一个故意的决策，这也是哎呀呀与其众多替代品不同的地方。

《aaargh.py》文件中的文档字符串包含您使用Aaargh所需的所有信息。有关指定参数、提供默认值、添加帮助文本等方面的信息，请参阅argparse文档。

示例

一个简单的命令行应用程序，暴露了几个函数，看起来像这样

#!/usr/bin/env python

import aaargh

app = aaargh.App(description="A simple greeting application.")

# Application level arguments:
app.arg('--name', help="Name of the person to greet", default="stranger")

# Application level defaults:
app.defaults(name="visitor")  # overrides "stranger"


@app.cmd
def hello(name):  # application level "name" argument is always passed
    print("Hello, world!")


@app.cmd(name="hi", help="Say hi")  # override subcommand name
@app.cmd_arg('-r', '--repeat', type=int, default=1, help="How many times?")
def say_hi(name, repeat):  # both application and subcommand args
    for i in range(repeat):
        print("Hi, %s!" % name)


@app.cmd
@app.cmd_defaults(name="my friend")  # overrides "visitor" for this command only
def greetings(name):
    print("Greetings, %s." % name)


@app.cmd(alias='bye')  # Allow "bye" aswell as goodbye
def goodbye(name):
    print("Goodbye, cruel world!")


if __name__ == '__main__':
    app.run()

该应用程序的命令行界面行为如下

$ ./example.py hello
Hello, world!

$ ./example.py hi --repeat=3
Hi, visitor!
Hi, visitor!
Hi, visitor!

$ ./example.py --help
usage: example.py [-h] [--name NAME] {hello,hi,greetings} ...

A simple greeting application.

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           Name of the person to greet

Subcommands:
  {hello,hi,greetings}
    hello
    hi                  Say hi
    greetings

$ ./example.py hi --help
usage: example.py hi [-h] [-r REPEAT]

optional arguments:
  -h, --help            show this help message and exit
  -r REPEAT, --repeat REPEAT
                        How many times?

安装

使用pip安装非常简单，尤其是当使用virtualenv时

(yourenv) $ pip install aaargh

安装成功后，这应该可以工作

(yourenv) $ python
>>> import aaargh
>>> help(aaargh)

历史记录

版本 0.1 (2012-05-17)

• 首次发布