Merge remote-tracking branch 'upstream/master' into conditional-overloads

Author: cdce8p

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*.{py,c,cpp,h,rst,md,yml,json}]
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+
+[*.{py,c,h,json}]
+indent_size = 4
+
+[*.yml]
+indent_size = 2

.gitattributes

@@ -1,2 +1,2 @@
 # We vendor typeshed from https://github.com/python/typeshed
-mypy/typeshed/ linguist-vendored
+mypy/typeshed/** linguist-vendored

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - about: "Please check the linked documentation page before filing new issues."
+    name: "Common issues and solutions"
+    url: "https://mypy.readthedocs.io/en/stable/common_issues.html"
+  - about: "Please ask and answer any questions on the mypy Gitter."
+    name: "Questions or Chat"
+    url: "https://gitter.im/python/typing"

.github/ISSUE_TEMPLATE/question.md

@@ -26,7 +26,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: "3.10"
       - name: Install dependencies
         run: |
           python -m pip install -U pip

.github/workflows/mypy_primer.yml

@@ -26,8 +26,8 @@ DEALINGS IN THE SOFTWARE.
 
 = = = = =
 
-Portions of mypy and mypyc are licensed under different licenses.  The
-files under stdlib-samples as well as the files
+Portions of mypy and mypyc are licensed under different licenses.
+The files
 mypyc/lib-rt/pythonsupport.h, mypyc/lib-rt/getargs.c and
 mypyc/lib-rt/getargsfast.c are licensed under the PSF 2 License, reproduced
 below.

LICENSE

@@ -41,7 +41,7 @@ include runtests.py
 include pytest.ini
 
 include LICENSE mypyc/README.md
-exclude .gitmodules CONTRIBUTING.md CREDITS ROADMAP.md tox.ini action.yml
+exclude .gitmodules CONTRIBUTING.md CREDITS ROADMAP.md tox.ini action.yml .editorconfig
 
 global-exclude *.py[cod]
 global-exclude .DS_Store

MANIFEST.in

@@ -320,8 +320,8 @@ Slots
 *****
 
 When a class has explicitly defined
-`__slots__ <https://docs.python.org/3/reference/datamodel.html#slots>`_
-mypy will check that all attributes assigned to are members of `__slots__`.
+`__slots__ <https://docs.python.org/3/reference/datamodel.html#slots>`_,
+mypy will check that all attributes assigned to are members of ``__slots__``:
 
 .. code-block:: python
 
@@ -331,13 +331,19 @@ mypy will check that all attributes assigned to are members of `__slots__`.
       def __init__(self, name: str, year: int) -> None:
          self.name = name
          self.year = year
-         self.released = True  # E: Trying to assign name "released" that is not in "__slots__" of type "Album"
+         # Error: Trying to assign name "released" that is not in "__slots__" of type "Album"
+         self.released = True
 
   my_album = Album('Songs about Python', 2021)
 
-Mypy will only check attribute assignments against `__slots__` when the following conditions hold:
+Mypy will only check attribute assignments against ``__slots__`` when
+the following conditions hold:
 
-1. All base classes (except builtin ones) must have explicit ``__slots__`` defined (mirrors CPython's behaviour)
-2. ``__slots__`` does not include ``__dict__``, since if ``__slots__`` includes ``__dict__``
-   it allows setting any attribute, similar to when ``__slots__`` is not defined (mirrors CPython's behaviour)
-3. All values in ``__slots__`` must be statically known. For example, no variables: only string literals.
+1. All base classes (except builtin ones) must have explicit
+   ``__slots__`` defined (this mirrors Python semantics).
+
+2. ``__slots__`` does not include ``__dict__``. If ``__slots__``
+   includes ``__dict__``, arbitrary attributes can be set, similar to
+   when ``__slots__`` is not defined (this mirrors Python semantics).
+
+3. All values in ``__slots__`` must be string literals.

docs/source/class_basics.rst

@@ -274,7 +274,7 @@ For more information on how to use these flags, see :ref:`version_and_platform_c
 Disallow dynamic typing
 ***********************
 
-The ``Any`` type is used represent a value that has a :ref:`dynamic type <dynamic-typing>`.
+The ``Any`` type is used to represent a value that has a :ref:`dynamic type <dynamic-typing>`.
 The ``--disallow-any`` family of flags will disallow various uses of the ``Any`` type in
 a module -- this lets us strategically disallow the use of dynamic typing in a controlled way.
 
@@ -312,8 +312,8 @@ The following options are available:
 .. option:: --disallow-any-generics
 
     This flag disallows usage of generic types that do not specify explicit
-    type parameters. For example you can't use a bare ``x: list``, you must say
-    ``x: list[int]``.
+    type parameters. For example, you can't use a bare ``x: list``. Instead, you
+    must always write something like ``x: list[int]``.
 
 .. option:: --disallow-subclassing-any
 
@@ -853,13 +853,17 @@ format into the specified directory.
 
     Causes mypy to generate a Cobertura XML type checking coverage report.
 
-    You must install the `lxml`_ library to generate this report.
+    To generate this report, you must either manually install the `lxml`_
+    library or specify mypy installation with the setuptools extra
+    ``mypy[reports]``.
 
 .. option:: --html-report / --xslt-html-report DIR
 
     Causes mypy to generate an HTML type checking coverage report.
 
-    You must install the `lxml`_ library to generate this report.
+    To generate this report, you must either manually install the `lxml`_
+    library or specify mypy installation with the setuptools extra
+    ``mypy[reports]``.
 
 .. option:: --linecount-report DIR
 
@@ -881,13 +885,17 @@ format into the specified directory.
 
     Causes mypy to generate a text file type checking coverage report.
 
-    You must install the `lxml`_ library to generate this report.
+    To generate this report, you must either manually install the `lxml`_
+    library or specify mypy installation with the setuptools extra
+    ``mypy[reports]``.
 
 .. option:: --xml-report DIR
 
     Causes mypy to generate an XML type checking coverage report.
 
-    You must install the `lxml`_ library to generate this report.
+    To generate this report, you must either manually install the `lxml`_
+    library or specify mypy installation with the setuptools extra
+    ``mypy[reports]``.
 
 Miscellaneous
 *************