Legacy API wrapper.
Project description
This module defines a decorator to wrap legacy APIs. The primary use case is APIs defined before keyword-only parameters existed.
>>> from legacy_api_wrap import legacy_api
We have a function with many positional parameters lying around:
>>> def fn(a, b=None, d=1, c=2): ... return c, d, e
We want to convert the positional parameters d and c to keyword-only, change their order and add a parameter. For this we only need to specify name and order of the old positional parameters in the decorator.
>>> @legacy_api('d', 'c') ... def fn(a, b=None, *, c=2, d=1, e=3): ... return c, d, e
After adding the decorator, users can keep calling the old API and get a DeprecationWarning:
>>> fn(12, 13, 14) == (2, 14, 3) True
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
legacy-api-wrap-1.1.tar.gz
(14.8 kB
view hashes)
Built Distribution
Close
Hashes for legacy_api_wrap-1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ba149887f07c5748eb8c793a0cab53ff16ce3cce1b4efe372fbd103e7c03826 |
|
MD5 | 8f03ade5a77ed7a72dd2988d6239f5cc |
|
BLAKE2b-256 | 845fc400f9094ea8c3ef83184126bea6f5cdfb19bdd0fe048c57a1d697e70f2c |