pax_global_header00006660000000000000000000000064151021257430014512gustar00rootroot0000000000000052 comment=98e97018045635db5bbff502bf6b1a689d2801d7 flying-sheep-legacy-api-wrap-98e9701/000077500000000000000000000000001510212574300173545ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/.editorconfig000066400000000000000000000003151510212574300220300ustar00rootroot00000000000000root = true [*] charset = utf-8 end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true max_line_length = 88 indent_size = 4 indent_style = space [*.{yml,yaml,toml}] indent_size = 2 flying-sheep-legacy-api-wrap-98e9701/.github/000077500000000000000000000000001510212574300207145ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/.github/workflows/000077500000000000000000000000001510212574300227515ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/.github/workflows/ci.yml000066400000000000000000000032351510212574300240720ustar00rootroot00000000000000# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: Python tests on: push: branches: [main] pull_request: branches: [main] env: PYTEST_ADDOPTS: "-v --color=yes" FORCE_COLOR: "1" jobs: get-environments: runs-on: ubuntu-latest outputs: envs: ${{ steps.get-envs.outputs.envs }} steps: - uses: actions/checkout@v5 with: { filter: blob:none, fetch-depth: 0 } - uses: astral-sh/setup-uv@v7 - id: get-envs run: | ENVS_JSON=$(NO_COLOR=1 uvx hatch env show --json | jq -c 'to_entries | map(select(.key | startswith("hatch-test")) | { name: .key, python: .value.python })') echo "envs=${ENVS_JSON}" | tee $GITHUB_OUTPUT test: needs: [get-environments] runs-on: ubuntu-latest strategy: matrix: env: ${{ fromJSON(needs.get-environments.outputs.envs) }} steps: - uses: actions/checkout@v5 - uses: actions/setup-python@v6 with: python-version: ${{ matrix.env.python }} - uses: astral-sh/setup-uv@v7 - run: uv pip install --system -e .[test] - run: | coverage run -m pytest coverage xml coverage-rich report - uses: codecov/codecov-action@v5 with: fail_ci_if_error: true files: test-data/coverage.xml flags: ${{ matrix.env.name }} token: 872498ea-6ef6-4f1d-8006-bc6e557580f6 check: if: always() needs: - get-environments - test runs-on: ubuntu-latest steps: - uses: re-actors/alls-green@release/v1 with: jobs: ${{ toJSON(needs) }} flying-sheep-legacy-api-wrap-98e9701/.github/workflows/publish.yml000066400000000000000000000010531510212574300251410ustar00rootroot00000000000000name: Publish Python Package on: release: types: [published] jobs: publish: runs-on: ubuntu-latest environment: name: pypi url: https://pypi.org/project/legacy-api-wrap/ permissions: id-token: write # to authenticate as Trusted Publisher to pypi.org steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: python-version: "3.x" cache: "pip" - run: pip install build - run: python -m build - uses: pypa/gh-action-pypi-publish@release/v1 flying-sheep-legacy-api-wrap-98e9701/.gitignore000066400000000000000000000001001510212574300213330ustar00rootroot00000000000000__pycache__/ /*cache/ /dist/ /test-data/ .DS_Store .directory flying-sheep-legacy-api-wrap-98e9701/.pre-commit-config.yaml000066400000000000000000000013351510212574300236370ustar00rootroot00000000000000repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v6.0.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.14.2 hooks: - id: ruff args: [--fix, --exit-non-zero-on-fix] - id: ruff args: [--preview, --select=CPY] - id: ruff-format - repo: https://github.com/biomejs/pre-commit rev: v2.3.1 hooks: - id: biome-format - repo: https://github.com/tox-dev/pyproject-fmt rev: v2.11.0 hooks: - id: pyproject-fmt - repo: https://github.com/pre-commit/mirrors-mypy rev: v1.18.2 hooks: - id: mypy additional_dependencies: - pytest flying-sheep-legacy-api-wrap-98e9701/.vscode/000077500000000000000000000000001510212574300207155ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/.vscode/extensions.json000066400000000000000000000001671510212574300240130ustar00rootroot00000000000000{ "recommendations": [ "charliermarsh.ruff", "ms-python.python", "biomejs.biome", ], } flying-sheep-legacy-api-wrap-98e9701/.vscode/settings.json000066400000000000000000000010031510212574300234420ustar00rootroot00000000000000{ "python.testing.unittestEnabled": false, "python.testing.pytestEnabled": true, "python.testing.pytestArgs": ["--color=yes"], "[python]": { "editor.formatOnSave": true, "editor.defaultFormatter": "charliermarsh.ruff", "editor.codeActionsOnSave": { "source.fixAll": "always", "source.organizeImports": "always", }, }, "[json][jsonc]": { "editor.formatOnSave": true, "editor.defaultFormatter": "biomejs.biome", }, } flying-sheep-legacy-api-wrap-98e9701/LICENSE.rst000066400000000000000000000371221510212574300211750ustar00rootroot00000000000000Mozilla Public License Version 2.0 ================================== 1. Definitions -------------- 1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. 1.3. "Contribution" means Covered Software of a particular Contributor. 1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. "Incompatible With Secondary Licenses" means (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. "Executable Form" means any form of the work other than Source Code Form. 1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. "License" means this document. 1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. "Modifications" means any of the following: (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or (b) any new file in Source Code Form that contains any Covered Software. 1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. "Source Code Form" means the form of the work preferred for making modifications. 1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions -------------------------------- 2.1. Grants ~~~~~~~~~~~ Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date ~~~~~~~~~~~~~~~~~~~ The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: (a) for any code that a Contributor has removed from Covered Software; or (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses ~~~~~~~~~~~~~~~~~~~~~~~~ No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation ~~~~~~~~~~~~~~~~~~~ Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use ~~~~~~~~~~~~~ This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions ~~~~~~~~~~~~~~~ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities ------------------- 3.1. Distribution of Source Form ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. 3.2. Distribution of Executable Form ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If You distribute Covered Software in Executable Form then: (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices ~~~~~~~~~~~~ You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation --------------------------------------------------- If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination -------------- 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. 6. Disclaimer of Warranty ------------------------- Covered Software is provided under this License on an "as is" basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer. 7. Limitation of Liability -------------------------- Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party's negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You. 8. Litigation ------------- Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. 9. Miscellaneous ---------------- This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License --------------------------- 10.1. New Versions ~~~~~~~~~~~~~~~~~~ Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions ~~~~~~~~~~~~~~~~~~~~~~~ If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice ------------------------------------------- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - "Incompatible With Secondary Licenses" Notice --------------------------------------------------------- This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0. flying-sheep-legacy-api-wrap-98e9701/README.rst000066400000000000000000000021151510212574300210420ustar00rootroot00000000000000Legacy API Wrapper |b-pypi| |b-codecov| ======================================= .. |b-pypi| image:: https://img.shields.io/pypi/v/legacy-api-wrap.svg :target: https://pypi.org/project/legacy-api-wrap .. |b-codecov| image:: https://codecov.io/gh/flying-sheep/legacy-api-wrap/graph/badge.svg :target: https://codecov.io/gh/flying-sheep/legacy-api-wrap 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 flying-sheep-legacy-api-wrap-98e9701/biome.jsonc000066400000000000000000000010201510212574300214760ustar00rootroot00000000000000{ "$schema": "https://biomejs.dev/schemas/2.1.1/schema.json", "overrides": [ { "includes": ["./.vscode/*.json", "**/*.jsonc"], "json": { "formatter": { "trailingCommas": "all", "indentStyle": "space", "indentWidth": 4, }, "parser": { "allowComments": true, "allowTrailingCommas": true, }, }, }, ], } flying-sheep-legacy-api-wrap-98e9701/pyproject.toml000066400000000000000000000057411510212574300222770ustar00rootroot00000000000000[build-system] build-backend = "hatchling.build" requires = [ "hatch-docstring-description", "hatch-vcs", "hatchling" ] [project] name = "legacy-api-wrap" readme = "README.rst" license = "MPL-2.0" authors = [ { name = "Philipp A.", email = "flying-sheep@web.de" } ] requires-python = ">=3.9" classifiers = [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.14", "Topic :: Software Development :: Libraries :: Python Modules", "Typing :: Typed", ] dynamic = [ "description", "version" ] dependencies = [ ] optional-dependencies.test = [ "anyconfig[toml]>=0.14", # coverage-rich uses anyconfig "coverage", "coverage-rich", "pytest", "typer<0.14", # https://github.com/WaylonWalker/coverage-rich/issues/4 ] urls.Source = "https://github.com/flying-sheep/legacy-api-wrap" [tool.hatch.version] source = "vcs" [tool.hatch.build.targets.wheel] packages = [ "src/legacy_api_wrap", "src/testing/legacy_api_wrap" ] [tool.hatch.metadata.hooks.docstring-description] [tool.hatch.envs.hatch-test] default-args = [ ] features = [ "test" ] extra-dependencies = [ "ipython" ] scripts.run = "pytest{env:HATCH_TEST_ARGS:} {args}" scripts.run-cov = "coverage run -m pytest{env:HATCH_TEST_ARGS:} {args}" scripts.cov-combine = "coverage combine" scripts.cov-report = "coverage-rich report" [[tool.hatch.envs.hatch-test.matrix]] python = [ "3.9", "3.14" ] [tool.ruff] line-length = 100 lint.select = [ "ALL" ] lint.ignore = [ "COM812", # incompatible with formatter "D203", # zero instead of one blank lines before class "D213", # multiline summary on first instead of second line "ISC001", # incompatible with formatter ] lint.extend-per-file-ignores."src/testing/*.py" = [ "INP001" ] lint.extend-per-file-ignores."tests/**/test_*.py" = [ "D100", # tests need no module docstrings "D103", # tests need no function docstrings "INP001", # tests should not have __init__.py "PLR2004", # tests use magic values "S101", # tests use `assert` ] lint.allowed-confusables = [ "’" ] lint.flake8-copyright.notice-rgx = "SPDX-License-Identifier: MPL-2\\.0" lint.isort.known-first-party = [ "legacy_api_wrap" ] lint.isort.required-imports = [ "from __future__ import annotations" ] [tool.pytest.ini_options] addopts = [ "--import-mode=importlib", "--strict-markers", "-Werror", "-ptesting.legacy_api_wrap.pytest", "--doctest-modules", "--doctest-glob=*.rst", ] [tool.coverage] run.data_file = "test-data/coverage" xml.output = "test-data/coverage.xml" html.directory = "test-data/htmlcov" run.omit = [ "src/testing/*", "tests/*" ] report.exclude_also = [ "if TYPE_CHECKING:" ] [tool.mypy] strict = true explicit_package_bases = true mypy_path = "src" flying-sheep-legacy-api-wrap-98e9701/src/000077500000000000000000000000001510212574300201435ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/src/legacy_api_wrap/000077500000000000000000000000001510212574300232715ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/src/legacy_api_wrap/__init__.py000066400000000000000000000077161510212574300254150ustar00rootroot00000000000000# SPDX-License-Identifier: MPL-2.0 """Legacy API wrapper. >>> from legacy_api_wrap import legacy_api >>> @legacy_api('d', 'c') ... def fn(a, b=None, *, c=2, d=1, e=3): ... return c, d, e >>> fn(12, 13, 14) == (2, 14, 3) True """ from __future__ import annotations import sys from functools import wraps from inspect import Parameter, signature from typing import TYPE_CHECKING from warnings import warn if TYPE_CHECKING: from collections.abc import Callable from typing import ParamSpec, TypeVar P = ParamSpec("P") R = TypeVar("R") INF = float("inf") POS_TYPES = {Parameter.POSITIONAL_ONLY, Parameter.POSITIONAL_OR_KEYWORD} # The actual returned Callable of course accepts more positional parameters, # but we want the type to lie so end users don’t rely on the deprecated API. def legacy_api( *old_positionals: str, category: type[Warning] = DeprecationWarning, stacklevel: int = 2, skip_file_prefixes: tuple[str, ...] = (), ) -> Callable[[Callable[P, R]], Callable[P, R]]: """Legacy API wrapper. You want to change the API of a function: >>> def fn(a, b=None, d=1, c=2, e=3): ... return c, d, e Add a the decorator, specifying the parameter names that the old function had after the new function’s ``*``. Feel free to reorder the newly keyword-only parameters, and/or to add more. >>> @legacy_api('d', 'c') ... def fn(a, b=None, *, c=2, d=1, e=3): ... return c, d, e And the function can be called using one of both signatures, raising a warning. >>> fn(12, 13, 14) == (2, 14, 3) True Parameters ---------- old_positionals The positional parameter names that the old function had after the new function’s ``*``. category The warning class to use for the deprecation. Typically, you want to use ``DeprecationWarning``, ``PendingDeprecationWarning``, ``FutureWarning``, or a custom subclass of those. stacklevel The stacklevel to use for the deprecation warning. By default, the first stack frame is the call site of the wrapped function. skip_file_prefixes A sequence of file path prefixes to skip when determining the stacklevel. Supported since Python 3.12. See :func:`warnings.warn` documentation. """ def wrapper(fn: Callable[P, R]) -> Callable[P, R]: sig = signature(fn) par_types = [p.kind for p in sig.parameters.values()] has_var = Parameter.VAR_POSITIONAL in par_types n_required = sum(1 for p in sig.parameters.values() if p.default is Parameter.empty) n_positional = sys.maxsize if has_var else sum(1 for p in par_types if p in POS_TYPES) @wraps(fn) def fn_compatible(*args_all: P.args, **kw: P.kwargs) -> R: __tracebackhide__ = True if len(args_all) <= n_positional: return fn(*args_all, **kw) args_pos, args_rest = args_all[:n_positional], args_all[n_positional:] if len(args_rest) > len(old_positionals): n_max = n_positional + len(old_positionals) msg = ( f"{fn.__name__}() takes from {n_required} to {n_max} parameters, " f"but {len(args_pos) + len(args_rest)} were given." ) raise TypeError(msg) warn( f"The specified parameters {old_positionals[: len(args_rest)]!r} are " "no longer positional. " f"Please specify them like `{old_positionals[0]}={args_rest[0]!r}`", category=category, stacklevel=stacklevel, **( {"skip_file_prefixes": skip_file_prefixes} if sys.version_info >= (3, 12) else {} ), ) kw_new = {**kw, **dict(zip(old_positionals, args_rest))} return fn(*args_pos, **kw_new) # type: ignore[arg-type] return fn_compatible return wrapper flying-sheep-legacy-api-wrap-98e9701/src/legacy_api_wrap/py.typed000066400000000000000000000000001510212574300247560ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/src/testing/000077500000000000000000000000001510212574300216205ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/src/testing/legacy_api_wrap/000077500000000000000000000000001510212574300247465ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/src/testing/legacy_api_wrap/__init__.py000066400000000000000000000001141510212574300270530ustar00rootroot00000000000000# SPDX-License-Identifier: MPL-2.0 """Testing utils for legacy_api_wrap.""" flying-sheep-legacy-api-wrap-98e9701/src/testing/legacy_api_wrap/py.typed000066400000000000000000000000001510212574300264330ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/src/testing/legacy_api_wrap/pytest.py000066400000000000000000000017161510212574300266550ustar00rootroot00000000000000# SPDX-License-Identifier: MPL-2.0 """Pytest plugin for legacy_api_wrap.""" from __future__ import annotations import sys import warnings from typing import TYPE_CHECKING import pytest if TYPE_CHECKING: from collections.abc import Generator __all__ = ["_doctest_env", "_modify_env"] @pytest.fixture def _doctest_env() -> Generator[None, None, None]: """Pytest fixture to make doctests not error on expected warnings.""" sys.stderr, stderr_orig = sys.stdout, sys.stderr with warnings.catch_warnings(): warnings.resetwarnings() # reset -Werror warnings.filterwarnings("ignore", r"The specified parameters", DeprecationWarning) yield sys.stderr = stderr_orig @pytest.fixture(autouse=True) def _modify_env(request: pytest.FixtureRequest) -> None: """Autorun fixture that conditionally modifies the test environment.""" if isinstance(request.node, pytest.DoctestItem): request.getfixturevalue("_doctest_env") flying-sheep-legacy-api-wrap-98e9701/tests/000077500000000000000000000000001510212574300205165ustar00rootroot00000000000000flying-sheep-legacy-api-wrap-98e9701/tests/test_basic.py000066400000000000000000000024021510212574300232060ustar00rootroot00000000000000# SPDX-License-Identifier: MPL-2.0 from __future__ import annotations from inspect import signature import pytest from legacy_api_wrap import legacy_api # def old(a, b=None, d=1, c=2): # pass @legacy_api("d", "c") def new(a, b=None, *, c=2, d=1, e=3): # type: ignore[no-untyped-def] # noqa: ANN001, ANN201 return {"a": a, "b": b, "c": c, "d": d, "e": e} def test_inspection_correct() -> None: assert str(signature(new)) == "(a, b=None, *, c=2, d=1, e=3)" def test_new_param_available() -> None: new(12, e=13) def test_old_positional_order() -> None: with pytest.deprecated_call(): res = new(12, 13, 14) # type: ignore[misc] assert res["d"] == 14 def test_warning_stack() -> None: with pytest.deprecated_call() as record: new(12, 13, 14) # type: ignore[misc] w = record.pop() assert w.filename == __file__ def test_too_many_args() -> None: with pytest.raises( TypeError, match=r"new\(\) takes from 1 to 4 parameters, but 5 were given\.", ): new(1, 2, 3, 4, 5) # type: ignore[misc] def test_customize() -> None: @legacy_api("a", category=FutureWarning) def new(*, a: int) -> int: return a with pytest.raises(FutureWarning): new(1) # type: ignore[misc]