Registry / serialization / legacy-api-wrap

legacy-api-wrap

library1.5pypypi✓ verified 24d ago

legacy-api-wrap (version 1.5) provides a decorator for Python functions to seamlessly bridge old and new API interfaces. It allows developers to deprecate old argument names while still supporting them, typically by emitting warnings when old names are used. The library is actively maintained with feature-driven releases, ensuring compatibility and developer-friendly transitions.

serialization

pip install legacy-api-wrap

github ↗package ↗

INSTALL

IMPORT

SIG · LEGACY-API-WRAP

legacy-api-wrap

serializationpythonv1.5

Install

1.5s avg

Import

30ms

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.5 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.032s · 17.8MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 1.5s · import 0.028s · 18MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

legacy_api

✓ from legacy_api_wrap import legacy_api

✗ from legacy_api_wrap import legacy_api_wrap

wraps

✓ from legacy_api_wrap import wraps

✗ from legacy_api_wrap import legacy_api_wrap

Parameter

✓ from legacy_api_wrap import Parameter

✗ from legacy_api_wrap import legacy_api_wrap

This example demonstrates defining a function with a new API signature and wrapping it with `legacy_api_wrap` to allow calls using old argument names. It also shows how the decorator emits `FutureWarning`s when old arguments are used.

from legacy_api_wrap import legacy_api_wrap import warnings # Define the new function with updated argument names @legacy_api_wrap(old_arg_name='new_arg_name', another_old='yet_another') def my_new_function(new_arg_name: str, yet_another: int = 10): """This function uses the new API signature.""" print(f"New function called! new_arg_name='{new_arg_name}', yet_another={yet_another}") print("Calling with old API arguments (expecting a FutureWarning):") with warnings.catch_warnings(record=True) as w: warnings.simplefilter("always") # Ensure warnings are always captured my_new_function(old_arg_name="Hello Legacy", another_old=5) assert len(w) > 0 assert issubclass(w[-1].category, FutureWarning) print(f"Warning caught: {w[-1].message}") print("\nCalling with new API arguments:") my_new_function(new_arg_name="Hello Modern", yet_another=20)

Debug

Known issues

gotchaThe primary purpose of `legacy_api_wrap` is to *emit warnings* (defaulting to `FutureWarning`) when old argument names are used. It does not silence these warnings by default, and users may need to explicitly configure Python's `warnings` module or a custom `warning_category` (since v1.4) to alter this behavior.

fix

Be aware of `FutureWarning`s emitted during migration. To change their behavior, use `warnings.filterwarnings()` or pass a custom `warning_category` to the decorator, e.g., `@legacy_api_wrap(..., warning_category=DeprecationWarning)`.

affects: v1.0+

gotchaWhen using the decorator, ensure that the `kwargs` mapping correctly translates *all* necessary old arguments to their new counterparts. If an old argument is passed that is not mapped and is required by the new function, it will result in a `TypeError` from the underlying function, similar to calling it directly without the required argument.

fix

Thoroughly test the wrapped function with old API calls, ensuring all expected arguments are mapped within the `@legacy_api_wrap(...)` decorator configuration.

affects: v1.0+

gotchaIf a function wrapped with `legacy_api_wrap` is called with both an old argument name and its corresponding new argument name (e.g., `old_arg='val1', new_arg='val2'`), the value passed to the *new* argument name will take precedence. This can lead to subtle bugs if callers accidentally provide conflicting arguments.

fix

Document this behavior for users of the wrapped function and ensure migration guides clarify that only new argument names should be used once fully migrated. Avoid passing both old and new names simultaneously.

affects: v1.0+

Upgrade

Version history

1.5latest on PyPI · released Nov 3, 2025

Audit

Dependencies

No dependency data recorded yet.

Agent activity

5 hits · last 30 days

node

Resources

githubhttps://github.com/flying-sheep/legacy-api-wrap ↗

packagehttps://pypi.org/project/legacy-api-wrap/ ↗