legacy-api-wrap 1.4

此模块定义了一个包装旧版API的装饰器。主要用例是在关键字参数存在之前定义的API。

>>> from legacy_api_wrap import legacy_api

我们有一些带有许多位置参数的函数

>>> def fn(a, b=None, d=1, c=2):
...     return c, d, e

我们希望将位置参数 d 和 c 转换为关键字参数，更改它们的顺序并添加一个参数。为此，我们只需要在装饰器中指定旧位置参数的名称和顺序。

>>> @legacy_api('d', 'c')
... def fn(a, b=None, *, c=2, d=1, e=3):
...     return c, d, e

添加装饰器后，用户可以继续调用旧版API并收到 DeprecationWarning

>>> fn(12, 13, 14) == (2, 14, 3)
True