简单脚本参数分析器
scription的Python项目详细描述
说明
用于增强命令行脚本的轻量级库；包括 指定数据类型的参数，参数检查，基本输入/输出 用户，支持suid[1]，发送电子邮件，执行子程序，以及 脚本中的子命令
装饰工
- Script: sets global variables and/or parameters for Commands; the decorated function will be called by Main/Run before any specified Command
- Command: marks function as a subcommand for the script (e.g. add, delete, list, etc.); if no subcommand is specified on the command-line, scription will look for a Command with the same name as the script
- Alias: registers other names for Commands (e.g. delete / remove / kill)
功能
- Main: if the importing module’s __name__ is __main__, call Run() (this allows for importing the script as a module)
- Run: unconditionally attempts to run the Script function (if any) and the Command found on the command-line
Main() or Run() should be the last thing in the script
课程
- Spec: can be used when defining the command-line parameters (can also just use tuples)
帮助函数/类
- abort: quits immediately by raising SystemExit
- Execute: class for executing other programs; uses subprocess.Popen by default, but if pty=True is specified then pty.fork will be used (handy for programs that only accept input from a pty)
- get_response: function for displaying text and getting feedback
- help: quits immediately, but adds a reference to –help in the quit message
- log_exception: logs an exception with logging.logger
- mail: rudimentary mail sender
- OrmFile: lightweight orm – supports str, int, float, date, time, datetime, bool, and path (which defaults to str); custom data types can also be specified
- print: wrapper around print that adds a ‘verbose_level’ keyword (default: 1); default verbosity is 0 (so print does nothing), but can be increased using -v, -vv, –verbose, or –verbose=2 (in Python 2 the script must use ‘from __future__ import print_function’ to use scription’s print)
- user_ids: context manager useful for suid scripts – all actions taken within the context are run as the user/group specified
功能
- extra parameters defined by Script are global, and can be accessed from any function or Command
- ‘module’ is a namespace inserted into the script
- ‘script_command’ is the Command selected from the command line (useful when one needs to call the subcommand directly from a main() function)
- ‘script_command_name’ is the name of the script_command
- ‘script_verbosity’ is the level of verboseness selected (defaults to 0)
- ‘script_name’ is the name of the script
- builtin options are: –help, –verbose (-v or -vv), –version, –all-versions –version attempts to display the version of the main package in use –all-versions attempts to display the versions of any imported packages
- command-line is decoded to unicode under Python 2 (Python 3 does this for us)
[1]我使用suid python程序，可在http://selliott.org/python/suid-python.c
欢迎加入QQ群-->： 979659372
