diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 6c40342..3493735 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -69,3 +69,16 @@ jobs: - name: Test run: tox -e py + + typing: + runs-on: ubuntu-latest + timeout-minutes: 10 + permissions: + contents: read + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: "3.12" + - run: python -m pip install tox + - run: tox -e typing,typing-old diff --git a/LICENSE.typeshed b/LICENSE.typeshed new file mode 100644 index 0000000..1326448 --- /dev/null +++ b/LICENSE.typeshed @@ -0,0 +1,237 @@ +The "typeshed" project is licensed under the terms of the Apache license, as +reproduced below. + += = = = = + +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + += = = = = + +Parts of typeshed are licensed under different licenses (like the MIT +license), reproduced below. + += = = = = + +The MIT License + +Copyright (c) 2015 Jukka Lehtosalo and contributors + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + += = = = = diff --git a/README.md b/README.md index 4b280a9..9b3a845 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,8 @@ Mypy Extensions The `mypy_extensions` module defines extensions to the Python standard library `typing` module that are supported by the mypy type checker and the mypyc compiler. + +Type declarations are bundled with the package (PEP 561). Mypy versions that +ship their own mypy-extensions stubs continue to use those declarations. The +bundled declarations are adapted from typeshed under Apache-2.0; the runtime +implementation remains MIT-licensed. See LICENSE and LICENSE.typeshed. diff --git a/mypy_extensions.py b/mypy_extensions/__init__.py similarity index 100% rename from mypy_extensions.py rename to mypy_extensions/__init__.py diff --git a/mypy_extensions/__init__.pyi b/mypy_extensions/__init__.pyi new file mode 100644 index 0000000..810a37b --- /dev/null +++ b/mypy_extensions/__init__.pyi @@ -0,0 +1,101 @@ +# Adapted from typeshed (Apache-2.0); see LICENSE.typeshed. +import abc +from collections.abc import ItemsView, KeysView, Mapping, ValuesView +from typing import Any, ClassVar, Generic, Protocol, TypeVar, overload, type_check_only +from typing_extensions import Never, Self, deprecated + +_T = TypeVar("_T") +_U = TypeVar("_U") + +class _IdentityFunction(Protocol): + def __call__(self, arg: _T, /) -> _T: ... + +# Internal mypy fallback type for all typed dicts (does not exist at runtime) +# N.B. Keep this mostly in sync with typing(_extensions)._TypedDict +@type_check_only +@deprecated("Use typing._TypedDict instead") +class _TypedDict(Mapping[str, object], metaclass=abc.ABCMeta): + __total__: ClassVar[bool] + # Unlike typing(_extensions).TypedDict, + # subclasses of mypy_extensions.TypedDict do NOT have the __required_keys__ and __optional_keys__ ClassVars + def copy(self) -> Self: ... + # Using Never so that only calls using mypy plugin hook that specialize the signature + # can go through. + def setdefault(self, k: Never, default: object) -> object: ... + # Mypy plugin hook for 'pop' expects that 'default' has a type variable type. + def pop(self, k: Never, default: _T = ...) -> object: ... # pyright: ignore[reportInvalidTypeVarUse] + def update(self, m: Self, /) -> None: ... + def items(self) -> ItemsView[str, object]: ... + def keys(self) -> KeysView[str]: ... + def values(self) -> ValuesView[object]: ... + def __delitem__(self, k: Never) -> None: ... + + @overload + def __or__(self, value: Self, /) -> Self: ... + @overload + def __or__(self, value: dict[str, Any], /) -> dict[str, object]: ... + + @overload + def __ror__(self, value: Self, /) -> Self: ... + @overload + def __ror__(self, value: dict[str, Any], /) -> dict[str, object]: ... + + # supposedly incompatible definitions of `__or__` and `__ior__`: + def __ior__(self, value: Self, /) -> Self: ... # type: ignore[misc] + +@deprecated("Use typing.TypedDict or typing_extensions.TypedDict instead") +def TypedDict(typename: str, fields: dict[str, type[Any]], total: bool = ...) -> type[dict[str, Any]]: ... + +@overload +def Arg(type: _T, name: str | None = ...) -> _T: ... +@overload +def Arg(*, name: str | None = ...) -> Any: ... + +@overload +def DefaultArg(type: _T, name: str | None = ...) -> _T: ... +@overload +def DefaultArg(*, name: str | None = ...) -> Any: ... + +@overload +def NamedArg(type: _T, name: str | None = ...) -> _T: ... +@overload +def NamedArg(*, name: str | None = ...) -> Any: ... + +@overload +def DefaultNamedArg(type: _T, name: str | None = ...) -> _T: ... +@overload +def DefaultNamedArg(*, name: str | None = ...) -> Any: ... + +@overload +def VarArg(type: _T) -> _T: ... +@overload +def VarArg() -> Any: ... + +@overload +def KwArg(type: _T) -> _T: ... +@overload +def KwArg() -> Any: ... + +# Return type that indicates a function does not return. +@deprecated("Use typing.Never instead") +class NoReturn: ... + +# This is consistent with implementation. Usage intends for this as +# a class decorator, but mypy does not support type[_T] for abstract +# classes until this issue is resolved, https://github.com/python/mypy/issues/4717. +def trait(cls: _T) -> _T: ... +def mypyc_attr(*attrs: str, **kwattrs: object) -> _IdentityFunction: ... + +class FlexibleAlias(Generic[_T, _U]): ... + +# Mypy and mypyc treat these native int types as different from 'int', but this is +# a non-standard extension. For other tools, aliasing these to 'int' allows them +# to mostly do the right thing with these types. +i64 = int +i32 = int +i16 = int +i8 = int +u64 = int +u32 = int +u16 = int +u8 = int diff --git a/mypy_extensions/py.typed b/mypy_extensions/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/pyproject.toml b/pyproject.toml index ae7ce94..a10864e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,7 +10,9 @@ readme = "README.md" authors = [ {name = "The mypy developers", email = "jukka.lehtosalo@iki.fi"} ] -license = "MIT" +license = "MIT AND Apache-2.0" +license-files = ["LICENSE", "LICENSE.typeshed"] +dependencies = ["typing_extensions>=4.8"] classifiers = [ "Development Status :: 5 - Production/Stable", "Environment :: Console", @@ -30,4 +32,4 @@ requires-python = ">=3.10" Homepage = "https://github.com/python/mypy_extensions" [tool.flit.sdist] -include = ["tox.ini", "*/*test*.py"] +include = ["tox.ini", "tests/*.py"] diff --git a/tests/check_typing.py b/tests/check_typing.py new file mode 100644 index 0000000..9d9daf1 --- /dev/null +++ b/tests/check_typing.py @@ -0,0 +1,68 @@ +"""Check installed declarations and built artifacts (run via tox -e typing).""" +from pathlib import Path +import subprocess +import sys +import tarfile +import tempfile +import zipfile + +root = Path(__file__).resolve().parents[1] +wheel, = (root / 'dist').glob('*.whl') +sdist, = (root / 'dist').glob('*.tar.gz') +with zipfile.ZipFile(wheel) as archive: + names = archive.namelist() + for asset in ['__init__.py', '__init__.pyi', 'py.typed']: + assert f'mypy_extensions/{asset}' in names + assert any(n.endswith('/licenses/LICENSE.typeshed') for n in names) +with tarfile.open(sdist) as archive: + names = archive.getnames() + assert any(n.endswith('/mypy_extensions/__init__.pyi') for n in names) + assert any(n.endswith('/LICENSE.typeshed') for n in names) + +with tempfile.TemporaryDirectory() as directory: + directory = Path(directory) + # Running outside the checkout prevents a source-tree import from hiding + # packaging problems. Tox installs a built package into its environment. + probe = subprocess.check_output( + [sys.executable, '-c', 'import mypy_extensions; print(mypy_extensions.__file__)'], + cwd=directory, text=True, + ).strip() + assert 'site-packages' in Path(probe).parts + assert Path(probe).with_suffix('.pyi').is_file() + positive = directory / 'positive.py' + positive.write_text('''from mypy_extensions import mypyc_attr, trait, i64 +@trait +class Example: + pass +@mypyc_attr("trait") +class Decorated: + pass +number: int = i64(3) +''') + negative = directory / 'negative.py' + negative.write_text('from mypy_extensions import mypyc_attr, i64\n' + 'mypyc_attr(123)\nnumber: str = i64(3)\n') + for checker in ['mypy', 'pyright']: + command = [sys.executable, '-m', checker] + if checker == 'mypy': + command += ['--strict', '--no-incremental'] + else: + command += ['--pythonpath', sys.executable] + subprocess.run(command + [str(positive)], cwd=directory, check=True) + if checker == 'mypy': + trace = subprocess.run(command + ['--verbose', str(positive)], cwd=directory, + capture_output=True, text=True, check=True) + assert 'typeshed/stubs/mypy-extensions/mypy_extensions.pyi' in trace.stderr + result = subprocess.run(command + [str(negative)], cwd=directory, + capture_output=True, text=True) + assert result.returncode == 1, result.stdout + result.stderr + assert '2 errors' in result.stdout, result.stdout + # Trace Pyright's resolution to ensure it uses the installed stub rather + # than bundled typeshed. Mypy deliberately retains its bundled declarations. + result = subprocess.run( + [sys.executable, '-m', 'pyright', '--dependencies', '--verbose', '--pythonpath', + sys.executable, str(positive)], cwd=directory, capture_output=True, text=True, + check=True, + ) + assert str(Path(probe).with_suffix('.pyi')) in result.stdout, result.stdout +print('Installed declarations and wheel/sdist assets verified') diff --git a/tox.ini b/tox.ini index 8a56f3b..211437d 100644 --- a/tox.ini +++ b/tox.ini @@ -18,3 +18,21 @@ max-line-length = 99 ignore = # multiple statements on one line (colon) (we use this for classes with empty body) E701 + +[testenv:typing] +description = check built artifacts and installed type declarations +deps = + build + mypy==2.4.1 + pyright==1.1.414 +commands = + python -m build + python tests/check_typing.py + +[testenv:typing-old] +description = verify compatibility with mypy's older bundled declarations +deps = + build + mypy==1.10.0 + pyright==1.1.414 +commands = {[testenv:typing]commands}