在Python中设置函数签名
假设我有一个泛型函数f
。我想以 编程方式 创建一个功能f2
与相同f
但具有自定义签名的函数。
更多详情
给定一个列表l
和字典,d
我希望能够:
- 将的非关键字参数设置
f2
为中的字符串l
- 将的关键字参数设置为
f2
中的键d
,将默认值设置为的值d
即。假设我们有
l = ["x", "y"]
d = {"opt": None}
def f(*args, **kwargs):
# My code
然后我想要一个带有签名的函数:
def f2(x, y, opt=None):
# My code
一个特定的用例
这只是我的特定用例的简化版本。我仅作为示例。
我的实际用例(简化)如下。我们有一个通用的初始化函数:
def generic_init(self, *args, **kwargs):
"""Function to initiate a generic object"""
for name, arg in zip(self.__init_args__, args):
setattr(self, name, arg)
for name, default in self.__init_kw_args__.items():
if name in kwargs:
setattr(self, name, kwargs[name])
else:
setattr(self, name, default)
我们想在多个类中使用此函数。特别是,我们想要创建一个__init__
行为类似于的函数generic_init
,但在 创建时
具有一些类变量定义的签名:
class my_class:
__init_args__ = ["x", "y"]
__kw_init_args__ = {"my_opt": None}
__init__ = create_initiation_function(my_class, generic_init)
setattr(myclass, "__init__", __init__)
我们希望create_initiation_function创建一个具有使用__init_args__
和定义的签名的新函数__kw_init_args__
。有可能写create_initiation_function
吗?
请注意:
- 如果我只是想改善帮助,可以设置
__doc__
。 - 我们想在创建时设置功能签名。之后,无需更改。
- 不用创建类似的函数
generic_init
,而是使用不同的签名,我们可以创建一个具有所需签名的新函数,该函数只需调用generic_init
- 我们要定义
create_initiation_function
。我们不想手动指定新功能!
-
对于您的用例,在类/函数中使用文档字符串应该可以工作-可以在help()中显示,并且可以通过编程设置(func . doc =“ stuff”)。
我看不到任何设置实际签名的方法。我本以为functools模块可以做到的,但至少在py2.5和py2.6中没有。
如果输入错误,也可以引发TypeError异常。
嗯,如果您不介意真正的邪恶,则可以使用compile()/ eval()来做到。如果您所需的签名由arglist = [“ foo”,“ bar”,“
baz”]指定,并且您的实际函数是f( args,* kwargs),则可以管理:argstr = ", ".join(arglist) fakefunc = "def func(%s):\n return real_func(%s)\n" % (argstr, argstr) fakefunc_code = compile(fakefunc, "fakesource", "exec") fakeglobals = {} eval(fakefunc_code, {"real_func": f}, fakeglobals) f_with_good_sig = fakeglobals["func"] help(f) # f(*args, **kwargs) help(f_with_good_sig) # func(foo, bar, baz)
更改docstring和func_name应该可以为您提供完整的解决方案。但是,呃…