API Reference¶
这里可以查看API 文档
useful_decoration package¶
Submodules¶
useful_decoration.decorations module¶
-
useful_decoration.decorations.
element_mapping
(factor_name)¶ - 用来 修饰 类方法的返回结果,如果 返回为不是一个字典类型, 转成字典返回 {factor_name:value},
如果返回 类型 是一个字典类型 , 则直接返回, 不做任何处理.
- Parameters
factor_name – str 因子名称
- Returns
dict
useful_decoration.func module¶
这里检查对象 属性 是否满足 某些条件,进行 特定返回值 . 检查 对象中 data 属性 ,是否 满足 某些条件 如果 data 满足 某些条件,可以进行计算 ; 否则不算,直接返回默认值 .
-
useful_decoration.func.
checked_arguments
(score, prob)¶
useful_decoration.func_callable module¶
-
useful_decoration.func_callable.
calculate
(a, b)¶ 用户函数 :param a: :param b: :return:
-
useful_decoration.func_callable.
call_back
(params_dict: collections.OrderedDict)¶ 用户自定义的一个 callback ,这个函数 返回 true or false
这里 自定义 a >10 我认为 检查失败 :param params_dict: :return: true or false
-
useful_decoration.func_callable.
case_one
()¶
-
useful_decoration.func_callable.
case_two
()¶
-
useful_decoration.func_callable.
check_args
(data)¶ 这里如果判断 参数都小于10 认为可以通过检查 :param data: :return:
-
useful_decoration.func_callable.
checked_arguments
(*, callback, default)¶ - Parameters
callback – function 这个 callable 只接受 一个参数 Orderdict this function 返回 True,or False 如果为 True 则进行 下面的逻辑 fn的逻辑, 否则不进行 fn 的逻辑,直接返回 规定的默认值default
default – 如果 不能检查 成功 ,返回 default值
- Returns
-
useful_decoration.func_callable.
fun
(*args, **kwargs)¶
-
useful_decoration.func_callable.
predict
(**kwargs)¶ 用户函数 :param kargs: :return:
-
useful_decoration.func_callable.
predict_callback
(data)¶ user defined :param data: dict :return:
useful_decoration.func_para module¶
这里检查对象 属性 是否满足 某些条件,进行 特定返回值 .
-
useful_decoration.func_para.
check_arguments
(d)¶ 这里是 检查 参数的条件, 这里可以随便写 . :param d: :return:
-
useful_decoration.func_para.
checked_arguments
(f)¶
-
useful_decoration.func_para.
run
(*args, **kwargs)¶ 模型函数,计算分值用的. :param args: :param kwargs: :return:
useful_decoration.single module¶
@Time : 2020/4/12 19:34 @File : single.py @Author : 15769162764@163.com
-
useful_decoration.single.
Person
()¶ This is Person
-
useful_decoration.single.
my_sum
(a, b)¶
-
useful_decoration.single.
single
(fn)¶ 这个函数 只会计算一次.并且对函数的参数不敏感. single is not sensitive to argument values, and will always return the ame value if called with different arguments.
- Parameters
fn –
- Returns
-
useful_decoration.single.
singleton
(cls)¶ 类装饰器 的使用, 这样简单的可以生成一个对象 :param cls: :return:
-
useful_decoration.single.
test_person
()¶
useful_decoration.timer module¶
-
useful_decoration.timer.
code_timer
(name='default')¶ 计算代码段的运行时间 :param name: 用于区分不同代码段的名称 :return: :usage:
- ..code-block:
- with timer(‘delay’):
time.sleep(3)
-
useful_decoration.timer.
fn_timer
(fn=None, *, prefix='', interval=0.0)¶ 计算 fn 的运算时间
- Parameters
fn – 函数, callable 对象
prefix – str 给函数一个标识 前缀 默认是 “”
interval – float 单位是 s, 给定一个阈值,超过某一个阈值,就记录时间. 否则不记录, 该参数 默认值 是:0.0 ,即 记录所有的函数的运行时间.
- Returns