A simple tool for generate the console app
To install Mushroom from source, first clone the repository and then run:
python setup.py installOr install from pypi through command below:
pip install mushroom-cliYou can make your script automatically to be a console app like this:
import mushroom
def hello(name:str="World"):
print("Hello {}".format(name))
if __name__ == "__main__":
mushroom.Mushroom(hello)Or using mushroom in this way(decorator).
import mushroom
@mushroom.mushroom()
def hello(name:str="World"):
print("Hello {}".format(name))
if __name__ == "__main__":
hello()Then you can use it like this:
python hello.py --help # print the help documentation
python hello.py --name David # Hello David
python hello.py # Hello World该模块只需要引入后直接作用与主入口函数后，便可以识别主入口函数的变量并且生成对应的命令行。
New:增加了修饰器的使用方式
所以需要主函数在定义传入变量是注明是什么类型的变量,跟例子展示的一样。 没有注明则认为是str类型。
注意！！！ 在输入字符串时一般直接输入字符串内容即可，不需要加引号。但如果字符串的开头为'-',会被识别为新的参数，很容易引发错误。
不建议输入的字符串以'-'开头。若必须以'-'开头，在字符串内容前后加上转义的引号。譬如 \'-someargs\'。
此外该模块也可以支持bool类型的变量，譬如
import mushroom
def hello(flag:bool=True):
if flag:
print("Hello World.")
else:
print("Nothing happened.")
if __name__ == "__main__":
mushroom.Mushroom(hello)这个时候只需要
python hello.py --flag # Nothing happend.
python hello.py # Hello World.因为默认的flag是True,所以传入flag参数的时候则为否。反之亦然。 bool类型的变量只需要 --flag即可
也有可能存在需要传入多个参数的情况。这个时候只需要让多参数的变量类型标注为List。
from typing import List
import mushroom
def my_sum(nums:List[int]):
return sum(nums)
if __name__ == "__main__":
mushroom.Mushroom(my_sum)这样可以在命令行中执行：
python sum.py --nums 1 2 3 # 6此外，如果List里面没有标明是什么类型的话，默认为int
如果希望展示自己编写脚本的说明，只需要在编写的时候写对应的文档即可。
def my_func():
"""
some document
"""
pass如果有子命令的话，可以构建一个类并且对此进行修饰使用。
import mushroom
class Main(object):
"""
hello app
"""
def __init__(self, name="me"):
self.name = name
def say_hello(self):
"""
self intruduce
"""
print("My name is {}".format(self.name))
def say_bye(self, other):
"""
say bye to other
"""
print("Bye {}".format(other))
if __name__ == '__main__':
mushroom.Mushroom(Main)这个时候 say_hello 和 say_bye 是 这个脚本的子命令。 当然也可以用修饰器的模式。
import mushroom
@mushroom.mushroom()
class Main(object):
"""
hello app
"""
def __init__(self, name="me"):
self.name = name
def say_hello(self):
"""
self intruduce
"""
print("My name is {}".format(self.name))
def say_bye(self, other):
"""
say bye to other
"""
print("Bye {}".format(other))
if __name__ == '__main__':
Main()可以对程序的耗时进行计算，只需要将参数timer设置为True即可。
import mushroom
# @mushroom.mushroom(timer=True)
def hello(name:str="World"):
print("Hello {}".format(name))
if __name__ == "__main__":
mushroom.Mushroom(hello, timer=True)除了提供长参数外，mushroom还可以提供对应的短参数方便使用。 短参数的构建规则为：
- 参数的首字母为改长参数的短参数，譬如
-a是--alpha的短参数。 - 参数如果由多个单词和下划线组成，则每个单词的首字母拼接后便是短参数。譬如
-fa是--flag_alpha的短参数。 - 出现短参数冲突时，有两种调整的方法
number和letternumber主要是在重复的短参数后面加个数字用作区分。目前默认是number，尚未在模块中开放修改参数。letter主要是出现重复的短参数后，搜索尚为使用的单字母作为该参数的短参数。
可以在main入口文档里面写入@para字段，然后给自己的option加上标注。
# mushroom_test.py
import mushroom
def hello(nums:int=3, name:str="World", flag_a:bool=False):
"""
This is a hello app.
@para:name:人名
@para:nums:重复次数
@para:flag_a:一个flag
"""
print("Hello {}".format(name))
print("times:{}".format(nums))
if flag_a:
print("This is True")
if __name__ == "__main__":
mushroom.Mushroom(hello, timer=True)
然后在命令行输入
> python mushroom_test.py -h
usage: mushroom_test.py [-h] [--nums NUMS] [--name NAME] [--flag_a]
This is a hello app.
@para:name:人名
@para:nums:重复次数
@para:flag_a:一个flag
optional arguments:
-h, --help show this help message and exit
--nums NUMS, -n NUMS 重复次数, default:3, type:int
--name NAME, -n2 NAME
人名, default:World, type:str
--flag_a, -fa 一个flag, deafult:False, it will be True if it's applied.前面提到，mushroom会根据在定义入口函数时的参数注释进行数据类型检查。这是为了防止传入的参数与预期的不符合。但如果希望关闭检查功能，或者程序内部会对数据类型进行检查，可以设置mushroom.Mushroom(strict_mode=False)进行关闭（默认开启），关闭后传入的参数统一按照标注的类型进行转换。
mushroom在0.3.2后新增了错误追踪功能并且在0.3.4版进行了完善。可以设置mushroom.Mushroom(traceback=True)进行开启（默认关闭）。当开启了错误追踪后，如果运行的程序出现Exception，mushroom会将其捕获并且提供类pdb的界面对当前的堆栈进行检查。
# mushroom_test_traceback.py
import mushroom
def main(a:int, b:float=0):
print(a / b)
if __name__ == '__main__':
mushroom.Mushroom(main, traceback=True, strict_mode=False)python mushroom_test_traceback.py -a 1 -b 0
错误类型： <class 'ZeroDivisionError'>
错误信息： float division by zero
==============================
Traceback (most recent call last):
File "mushroom_test_traceback.py", line 9, in <module>
mushroom.Mushroom(main, traceback=True, strict_mode=False)
File "/usr/anaconda3/lib/python3.8/site-packages/mushroom/core.py", line 25, in Mushroom
rslt = run_func(args, func)
File "/usr/anaconda3/lib/python3.8/site-packages/mushroom/func_parser.py", line 52, in run_func
return func(**kwargs)
File "mushroom_test_traceback.py", line 5, in main
print(a / b)
ZeroDivisionError: float division by zero
==============================
Welcome to the shell, type help or ? to list commands.
>> help
Documented commands (type help <topic>):
========================================
all back continue help list print show step
Undocumented commands:
======================
exit quit
>> help list
打印当前所有的非私有变量,如果是local则打印locals()里面的,如果是global则打印globals()里面的,默认local
>> list
'a; b'
>> help print
打印当前frame里面的变量,可以支持索引以及方法的打印
examle:
>> print var_name
>> print var_name.attr_name
>> print var_name["key"]
>> print var_name[1]
>> print var_name.type
>> print a
'in locals: a : 1'
>> quit这里的错误追踪跟pdb不一样，是通过python自身的exception hook进行捕获。所有只有简单的堆栈追踪以及变量打印的功能，不过作为当前状态检查够用了。
- 还需要进一步完善变量的打印功能
- 还需要进一步完善断点功能
- 打算增加函数重载的功能