Merge branch 'master' into msg-regostry-checkstrformat

Author: tusharsadhwani

.git-blame-ignore-revs

@@ -1,2 +1,6 @@
 # Adopt black and isort
-97c5ee99bc98dc475512e549b252b23a6e7e0997
+97c5ee99bc98dc475512e549b252b23a6e7e0997
+# Use builtin generics and PEP 604 for type annotations wherever possible (#13427)
+23ee1e7aff357e656e3102435ad0fe3b5074571e
+# Use variable annotations (#10723)
+f98f78216ba9d6ab68c8e69c19e9f3c7926c5efe

.github/workflows/build_wheels.yml

@@ -2,7 +2,7 @@ name: Trigger wheel build
 
 on:
   push:
-    branches: [master, 'release*']
+    branches: [main, master, 'release*']
     tags: ['*']
 
 jobs:

.github/workflows/docs.yml

@@ -3,7 +3,7 @@ name: Check documentation build
 on:
   workflow_dispatch:
   push:
-    branches: [master, 'release*']
+    branches: [main, master, 'release*']
     tags: ['*']
   pull_request:
     paths:

.github/workflows/mypy_primer_comment.yml

@@ -78,7 +78,7 @@ jobs:
             if (data.trim()) {
               body = 'Diff from [mypy_primer](https://github.com/hauntsaninja/mypy_primer), showing the effect of this PR on open source code:\n```diff\n' + data + '```'
             } else {
-              body = 'According to [mypy_primer](https://github.com/hauntsaninja/mypy_primer), this change has no effect on the checked open source code. 🤖🎉'
+              body = "According to [mypy_primer](https://github.com/hauntsaninja/mypy_primer), this change doesn't affect type check results on a corpus of open source code. ✅"
             }
             const prNumber = parseInt(fs.readFileSync("pr_number.txt", { encoding: "utf8" }))
             await github.rest.issues.createComment({

.github/workflows/test.yml

@@ -3,7 +3,7 @@ name: Tests
 on:
   workflow_dispatch:
   push:
-    branches: [master, 'release*']
+    branches: [main, master, 'release*']
     tags: ['*']
   pull_request:
     paths-ignore:
@@ -93,8 +93,11 @@ jobs:
           arch: x64
           os: windows-latest
           toxenv: type
+          # We also run these checks with pre-commit in CI,
+          # but it's useful to run them with tox too,
+          # to ensure the tox env works as expected
         - name: Formatting with Black + isort and code style with flake8
-          python: '3.7'
+          python: '3.10'
           arch: x64
           os: ubuntu-latest
           toxenv: lint
@@ -180,6 +183,7 @@ jobs:
           sudo dpkg --add-architecture i386 && \
           sudo apt-get update && sudo apt-get install -y \
             zlib1g-dev:i386 \
+            libgcc-s1:i386 \
             g++-i686-linux-gnu \
             gcc-i686-linux-gnu \
             libffi-dev:i386 \

.github/workflows/test_stubgenc.yml

@@ -3,7 +3,7 @@ name: Test stubgenc on pybind11-mypy-demo
 on:
   workflow_dispatch:
   push:
-    branches: [master, 'release*']
+    branches: [main, master, 'release*']
     tags: ['*']
   pull_request:
     paths:

.pre-commit-config.yaml

@@ -1,16 +1,26 @@
+exclude: '^(mypyc/external/)|(mypy/typeshed/)'  # Exclude all vendored code from lints
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0  # must match test-requirements.txt
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
   - repo: https://github.com/psf/black
     rev: 23.3.0  # must match test-requirements.txt
     hooks:
       - id: black
   - repo: https://github.com/pycqa/isort
-    rev: 5.11.5  # must match test-requirements.txt
+    rev: 5.12.0  # must match test-requirements.txt
     hooks:
       - id: isort
   - repo: https://github.com/pycqa/flake8
-    rev: 5.0.4  # must match test-requirements.txt
+    rev: 6.0.0  # must match test-requirements.txt
     hooks:
       - id: flake8
         additional_dependencies:
-          - flake8-bugbear==22.12.6  # must match test-requirements.txt
-          - flake8-noqa==1.3.0       # must match test-requirements.txt
+          - flake8-bugbear==23.3.23  # must match test-requirements.txt
+          - flake8-noqa==1.3.1       # must match test-requirements.txt
+
+ci:
+  # We run flake8 as part of our GitHub Actions suite in CI
+  skip: [flake8]

CONTRIBUTING.md

@@ -12,32 +12,42 @@ issue tracker, pull requests, and chat, is expected to treat
 other people with respect and more generally to follow the guidelines
 articulated in the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
 
-
 ## Getting started with development
 
 ### Setup
 
-#### (1) Clone the mypy repository and enter into it
-```
-git clone https://github.com/python/mypy.git
+#### (1) Fork the mypy repository
+
+Within Github, navigate to <https://github.com/python/mypy> and fork the repository.
+
+#### (2) Clone the mypy repository and enter into it
+
+```bash
+git clone [email protected]:<your_username>/mypy.git
 cd mypy
 ```
 
-#### (2) Create then activate a virtual environment
-```
+#### (3) Create then activate a virtual environment
+
+```bash
 # On Windows, the commands may be slightly different. For more details, see
 # https://docs.python.org/3/library/venv.html#creating-virtual-environments
 python3 -m venv venv
 source venv/bin/activate
 ```
 
-#### (3) Install the test requirements and the project
-```
+#### (4) Install the test requirements and the project
+
+```bash
 python3 -m pip install -r test-requirements.txt
 python3 -m pip install -e .
 hash -r  # This resets shell PATH cache, not necessary on Windows
 ```
 
+> **Note**
+> You'll need Python 3.8 or higher to install all requirements listed in
+> test-requirements.txt
+
 ### Running tests
 
 Running the full test suite can take a while, and usually isn't necessary when
@@ -47,12 +57,14 @@ your PR.
 
 However, if you wish to do so, you can run the full test suite
 like this:
-```
+
+```bash
 python3 runtests.py
 ```
 
 You can also use `tox` to run tests (`tox` handles setting up the test environment for you):
-```
+
+```bash
 tox run -e py
 
 # Or some specific python version:
@@ -63,6 +75,7 @@ tox run -e lint
 ```
 
 Some useful commands for running specific tests include:
+
 ```bash
 # Use mypy to check mypy's own code
 python3 runtests.py self
@@ -90,6 +103,7 @@ see [the README in the test-data directory](test-data/unit/README.md).
 If you're looking for things to help with, browse our [issue tracker](https://github.com/python/mypy/issues)!
 
 In particular, look for:
+
 - [good first issues](https://github.com/python/mypy/labels/good-first-issue)
 - [good second issues](https://github.com/python/mypy/labels/good-second-issue)
 - [documentation issues](https://github.com/python/mypy/labels/documentation)
@@ -151,28 +165,27 @@ You may also find other pages in the
 [Mypy developer guide](https://github.com/python/mypy/wiki/Developer-Guides)
 helpful in developing your change.
 
-
 ## Core developer guidelines
 
 Core developers should follow these rules when processing pull requests:
 
-* Always wait for tests to pass before merging PRs.
-* Use "[Squash and merge](https://github.com/blog/2141-squash-your-commits)"
+- Always wait for tests to pass before merging PRs.
+- Use "[Squash and merge](https://github.com/blog/2141-squash-your-commits)"
   to merge PRs.
-* Delete branches for merged PRs (by core devs pushing to the main repo).
-* Edit the final commit message before merging to conform to the following
+- Delete branches for merged PRs (by core devs pushing to the main repo).
+- Edit the final commit message before merging to conform to the following
   style (we wish to have a clean `git log` output):
-  * When merging a multi-commit PR make sure that the commit message doesn't
+  - When merging a multi-commit PR make sure that the commit message doesn't
     contain the local history from the committer and the review history from
     the PR. Edit the message to only describe the end state of the PR.
-  * Make sure there is a *single* newline at the end of the commit message.
+  - Make sure there is a *single* newline at the end of the commit message.
     This way there is a single empty line between commits in `git log`
     output.
-  * Split lines as needed so that the maximum line length of the commit
+  - Split lines as needed so that the maximum line length of the commit
     message is under 80 characters, including the subject line.
-  * Capitalize the subject and each paragraph.
-  * Make sure that the subject of the commit message has no trailing dot.
-  * Use the imperative mood in the subject line (e.g. "Fix typo in README").
-  * If the PR fixes an issue, make sure something like "Fixes #xxx." occurs
+  - Capitalize the subject and each paragraph.
+  - Make sure that the subject of the commit message has no trailing dot.
+  - Use the imperative mood in the subject line (e.g. "Fix typo in README").
+  - If the PR fixes an issue, make sure something like "Fixes #xxx." occurs
     in the body of the message (not in the subject).
-  * Use Markdown for formatting.
+  - Use Markdown for formatting.

README.md

@@ -40,10 +40,10 @@ To report a bug or request an enhancement:
   tracker for that library
 
 To discuss a new type system feature:
+
 - discuss at [typing-sig mailing list](https://mail.python.org/archives/list/[email protected]/)
 - there is also some historical discussion [here](https://github.com/python/typing/issues)
 
-
 What is mypy?
 -------------
 
@@ -82,6 +82,7 @@ See [the documentation](https://mypy.readthedocs.io/en/stable/index.html) for
 more examples and information.
 
 In particular, see:
+
 - [type hints cheat sheet](https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html)
 - [getting started](https://mypy.readthedocs.io/en/stable/getting_started.html)
 - [list of error codes](https://mypy.readthedocs.io/en/stable/error_code_list.html)
@@ -91,67 +92,75 @@ Quick start
 
 Mypy can be installed using pip:
 
-    python3 -m pip install -U mypy
+```bash
+python3 -m pip install -U mypy
+```
 
 If you want to run the latest version of the code, you can install from the
 repo directly:
 
-    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
+```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:
 
-    mypy PROGRAM
+```bash
+mypy PROGRAM
+```
 
 You can always use the Python interpreter to run your statically typed
 programs, even if mypy reports type errors:
 
-    python3 PROGRAM
+```bash
+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
 [daemon mode], that will give much faster (often sub-second) incremental updates:
 
-    dmypy run -- PROGRAM
+```bash
+dmypy run -- PROGRAM
+```
 
 [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
 
-
 Integrations
 ------------
 
 Mypy can be integrated into popular IDEs:
 
-* Vim:
-  * Using [Syntastic](https://github.com/vim-syntastic/syntastic): in `~/.vimrc` add
+- 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,
+  - 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
+- 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).
+- 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).
 
 Web site and documentation
 --------------------------
 
 Additional information is available at the web site:
 
-  https://www.mypy-lang.org/
+  <https://www.mypy-lang.org/>
 
 Jump straight to the documentation:
 
-  https://mypy.readthedocs.io/
+  <https://mypy.readthedocs.io/>
 
 Follow along our changelog at:
 
-  https://mypy-lang.blogspot.com/
-
+  <https://mypy-lang.blogspot.com/>
 
 Contributing
 ------------
@@ -164,7 +173,6 @@ 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
 ----------------------------------
 
@@ -174,10 +182,12 @@ mypy approximately 4 times faster than if interpreted!
 
 To install an interpreted mypy instead, use:
 
-    python3 -m pip install --no-binary mypy -U mypy
+```bash
+python3 -m pip install --no-binary mypy -U mypy
+```
 
 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.
+<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 <https://github.com/mypyc/mypyc>