Merge branch 'master' into mypyc-lower-get-item

Author: JukkaL

.pre-commit-config.yaml

@@ -1,17 +1,17 @@
 exclude: '^(mypyc/external/)|(mypy/typeshed/)|misc/typeshed_patches'  # Exclude all vendored code from lints
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0  # must match test-requirements.txt
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.8.0  # must match test-requirements.txt
+    rev: 24.8.0
     hooks:
       - id: black
         exclude: '^(test-data/)'
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.9  # must match test-requirements.txt
+    rev: v0.6.9
     hooks:
       - id: ruff
         args: [--exit-non-zero-on-fix]

MANIFEST.in

@@ -9,6 +9,7 @@ recursive-include mypy/typeshed *.pyi
 
 # mypy and mypyc
 include mypy/py.typed
+include mypyc/py.typed
 recursive-include mypy *.py
 recursive-include mypyc *.py
 

README.md

@@ -17,8 +17,8 @@ Got a question?
 
 We are always happy to answer questions! Here are some good places to ask them:
 
-- for anything you're curious about, try [gitter chat](https://gitter.im/python/typing)
 - for general questions about Python typing, try [typing discussions](https://github.com/python/typing/discussions)
+- for anything you're curious about, try [gitter chat](https://gitter.im/python/typing)
 
 If you're just getting started,
 [the documentation](https://mypy.readthedocs.io/en/stable/index.html)
@@ -30,7 +30,6 @@ If you think you've found a bug:
 - check our [common issues page](https://mypy.readthedocs.io/en/stable/common_issues.html)
 - search our [issue tracker](https://github.com/python/mypy/issues) to see if
   it's already been reported
-- consider asking on [gitter chat](https://gitter.im/python/typing)
 
 To report a bug or request an enhancement:
 
@@ -101,8 +100,6 @@ repo directly:
 
 ```bash
 python3 -m pip install -U git+https://github.com/python/mypy.git
-# or if you don't have 'git' installed
-python3 -m pip install -U https://github.com/python/mypy/zipball/master
 ```
 
 Now you can type-check the [statically typed parts] of a program like this:
@@ -118,14 +115,16 @@ programs, even if mypy reports type errors:
 python3 PROGRAM
 ```
 
-You can also try mypy in an [online playground](https://mypy-play.net/) (developed by
-Yusuke Miyazaki). If you are working with large code bases, you can run mypy in
+If you are working with large code bases, you can run mypy in
 [daemon mode], that will give much faster (often sub-second) incremental updates:
 
 ```bash
 dmypy run -- PROGRAM
 ```
 
+You can also try mypy in an [online playground](https://mypy-play.net/) (developed by
+Yusuke Miyazaki).
+
 [statically typed parts]: https://mypy.readthedocs.io/en/latest/getting_started.html#function-signatures-and-dynamic-vs-static-typing
 [daemon mode]: https://mypy.readthedocs.io/en/stable/mypy_daemon.html
 
@@ -134,18 +133,17 @@ Integrations
 
 Mypy can be integrated into popular IDEs:
 
+- VS Code: provides [basic integration](https://code.visualstudio.com/docs/python/linting#_mypy) with mypy.
 - Vim:
   - Using [Syntastic](https://github.com/vim-syntastic/syntastic): in `~/.vimrc` add
     `let g:syntastic_python_checkers=['mypy']`
   - Using [ALE](https://github.com/dense-analysis/ale): should be enabled by default when `mypy` is installed,
     or can be explicitly enabled by adding `let b:ale_linters = ['mypy']` in `~/vim/ftplugin/python.vim`
 - Emacs: using [Flycheck](https://github.com/flycheck/)
 - Sublime Text: [SublimeLinter-contrib-mypy](https://github.com/fredcallaway/SublimeLinter-contrib-mypy)
-- Atom: [linter-mypy](https://atom.io/packages/linter-mypy)
-- PyCharm: [mypy plugin](https://github.com/dropbox/mypy-PyCharm-plugin) (PyCharm integrates
-  [its own implementation](https://www.jetbrains.com/help/pycharm/type-hinting-in-product.html) of [PEP 484](https://peps.python.org/pep-0484/))
-- VS Code: provides [basic integration](https://code.visualstudio.com/docs/python/linting#_mypy) with mypy.
-- pre-commit: use [pre-commit mirrors-mypy](https://github.com/pre-commit/mirrors-mypy).
+- PyCharm: [mypy plugin](https://github.com/dropbox/mypy-PyCharm-plugin)
+- pre-commit: use [pre-commit mirrors-mypy](https://github.com/pre-commit/mirrors-mypy), although
+  note by default this will limit mypy's ability to analyse your third party dependencies.
 
 Web site and documentation
 --------------------------
@@ -171,8 +169,6 @@ contributors of all experience levels.
 
 To get started with developing mypy, see [CONTRIBUTING.md](CONTRIBUTING.md).
 
-If you need help getting started, don't hesitate to ask on [gitter](https://gitter.im/python/typing).
-
 Mypyc and compiled version of mypy
 ----------------------------------
 
@@ -190,4 +186,4 @@ To use a compiled version of a development
 version of mypy, directly install a binary from
 <https://github.com/mypyc/mypy_mypyc-wheels/releases/latest>.
 
-To contribute to the mypyc project, check out <https://github.com/mypyc/mypyc>
+To contribute to the mypyc project, check out the issue tracker at <https://github.com/mypyc/mypyc>

docs/requirements-docs.txt

@@ -1,3 +1,4 @@
 sphinx>=8.1.0
 furo>=2022.3.4
 myst-parser>=4.0.0
+sphinx_inline_tabs>=2023.04.21

docs/source/command_line.rst

@@ -166,6 +166,17 @@ imports.
 
     For more details, see :ref:`ignore-missing-imports`.
 
+.. option:: --follow-untyped-imports
+
+    This flag makes mypy analyze imports from installed packages even if
+    missing a :ref:`py.typed marker or stubs <installed-packages>`.
+
+    .. warning::
+
+        Note that analyzing all unannotated modules might result in issues
+        when analyzing code not designed to be type checked and may significantly
+        increase how long mypy takes to run.
+
 .. option:: --follow-imports {normal,silent,skip,error}
 
     This flag adjusts how mypy follows imported modules that were not
@@ -537,12 +548,12 @@ potentially problematic or redundant in some way.
 
         This limitation will be removed in future releases of mypy.
 
-.. option:: --report-deprecated-as-error
+.. option:: --report-deprecated-as-note
 
-    By default, mypy emits notes if your code imports or uses deprecated
-    features.    This flag converts such notes to errors, causing mypy to
-    eventually finish with a non-zero exit code.  Features are considered
-    deprecated when decorated with ``warnings.deprecated``.
+    If error code ``deprecated`` is enabled, mypy emits errors if your code
+    imports or uses deprecated features. This flag converts such errors to
+    notes, causing mypy to eventually finish with a zero exit code. Features
+    are considered deprecated when decorated with ``warnings.deprecated``.
 
 .. _miscellaneous-strictness-flags:
 

docs/source/conf.py

@@ -35,7 +35,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.intersphinx", "docs.source.html_builder", "myst_parser"]
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx_inline_tabs",
+    "docs.source.html_builder",
+    "myst_parser",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/source/config_file.rst

@@ -315,6 +315,24 @@ section of the command line docs.
     match the name of the *imported* module, not the module containing the
     import statement.
 
+.. confval:: follow_untyped_imports
+
+    :type: boolean
+    :default: False
+
+    Makes mypy analyze imports from installed packages even if missing a
+    :ref:`py.typed marker or stubs <installed-packages>`.
+
+    If this option is used in a per-module section, the module name should
+    match the name of the *imported* module, not the module containing the
+    import statement.
+
+    .. warning::
+
+        Note that analyzing all unannotated modules might result in issues
+        when analyzing code not designed to be type checked and may significantly
+        increase how long mypy takes to run.
+
 .. confval:: follow_imports
 
     :type: string

docs/source/error_code_list2.rst

@@ -236,13 +236,13 @@ incorrect control flow or conditional checks that are accidentally always true o
 Check that imported or used feature is deprecated [deprecated]
 --------------------------------------------------------------
 
-By default, mypy generates a note if your code imports a deprecated feature explicitly with a
+If you use :option:`--enable-error-code deprecated <mypy --enable-error-code>`,
+mypy generates an error if your code imports a deprecated feature explicitly with a
 ``from mod import depr`` statement or uses a deprecated feature imported otherwise or defined
 locally.  Features are considered deprecated when decorated with ``warnings.deprecated``, as
-specified in `PEP 702 <https://peps.python.org/pep-0702>`_.  You can silence single notes via
-``# type: ignore[deprecated]`` or turn off this check completely via ``--disable-error-code=deprecated``.
-Use the :option:`--report-deprecated-as-error <mypy --report-deprecated-as-error>` option for
-more strictness, which turns all such notes into errors.
+specified in `PEP 702 <https://peps.python.org/pep-0702>`_.
+Use the :option:`--report-deprecated-as-note <mypy --report-deprecated-as-note>` option to
+turn all such errors into notes.
 
 .. note::
 

docs/source/extending_mypy.rst

@@ -245,4 +245,4 @@ Mypy ships ``mypy.plugins.proper_plugin`` plugin which can be useful
 for plugin authors, since it finds missing ``get_proper_type()`` calls,
 which is a pretty common mistake.
 
-It is recommended to enable it is a part of your plugin's CI.
+It is recommended to enable it as a part of your plugin's CI.

docs/source/running_mypy.rst

@@ -277,6 +277,31 @@ If you are getting this error, try to obtain type hints for the library you're u
     to the library -- see our documentation on creating
     :ref:`PEP 561 compliant packages <installed-packages>`.
 
+4.  Force mypy to analyze the library as best as it can (as if the library provided
+    a ``py.typed`` file), despite it likely missing any type annotations. In general,
+    the quality of type checking will be poor and mypy may have issues when
+    analyzing code not designed to be type checked.
+
+    You can do this via setting the
+    :option:`--follow-untyped-imports <mypy --follow-untyped-imports>`
+    command line flag or :confval:`follow_untyped_imports` config file option to True.
+    This option can be specified on a per-module basis as well:
+
+    .. tab:: mypy.ini
+
+        .. code-block:: ini
+
+            [mypy-untyped_package.*]
+            follow_untyped_imports = True
+
+    .. tab:: pyproject.toml
+
+        .. code-block:: toml
+
+            [[tool.mypy.overrides]]
+            module = ["untyped_package.*"]
+            follow_untyped_imports = true
+
 If you are unable to find any existing type hints nor have time to write your
 own, you can instead *suppress* the errors.
 
@@ -293,10 +318,22 @@ not catch errors in its use.
     suppose your codebase
     makes heavy use of an (untyped) library named ``foobar``. You can silence
     all import errors associated with that library and that library alone by
-    adding the following section to your config file::
+    adding the following section to your config file:
+
+    .. tab:: mypy.ini
 
-        [mypy-foobar.*]
-        ignore_missing_imports = True
+        .. code-block:: ini
+
+            [mypy-foobar.*]
+            ignore_missing_imports = True
+
+    .. tab:: pyproject.toml
+
+        .. code-block:: toml
+
+            [[tool.mypy.overrides]]
+            module = ["foobar.*"]
+            ignore_missing_imports = true
 
     Note: this option is equivalent to adding a ``# type: ignore`` to every
     import of ``foobar`` in your codebase. For more information, see the
@@ -309,11 +346,21 @@ not catch errors in its use.
     in your codebase, use :option:`--disable-error-code=import-untyped <mypy --ignore-missing-imports>`.
     See :ref:`code-import-untyped` for more details on this error code.
 
-    You can also set :confval:`disable_error_code`, like so::
+    You can also set :confval:`disable_error_code`, like so:
+
+    .. tab:: mypy.ini
+
+        .. code-block:: ini
+
+            [mypy]
+            disable_error_code = import-untyped
+
+    .. tab:: pyproject.toml
 
-        [mypy]
-        disable_error_code = import-untyped
+        .. code-block:: ini
 
+            [tool.mypy]
+            disable_error_code = ["import-untyped"]
 
     You can also set the :option:`--ignore-missing-imports <mypy --ignore-missing-imports>`
     command line flag or set the :confval:`ignore_missing_imports` config file