Merge pull request #1 from python/master

Sync Fork from Upstream Repo

Author: sthagen

.gitignore

@@ -43,3 +43,12 @@ include/
 
 .tox
 pip-wheel-metadata
+
+
+test_capi
+*.o
+*.a
+test_capi
+/.mypyc-flake8-cache.json
+/mypyc/lib-rt/build/
+/mypyc/lib-rt/*.so

.travis.yml

@@ -4,13 +4,22 @@ if: tag IS present OR type = pull_request OR ((branch = master OR branch =~ rele
 language: python
 # cache package wheels (1 cache per python version)
 cache: pip
+# also cache the directories where we set up our custom pythons in some builds
+cache:
+  directories:
+    - $HOME/python-debug
+    # I ran into some issues with this but will investigate again later.
+    # - $HOME/.pyenv/versions
+    - $HOME/Library/Caches/pip
+
 # newer python versions are available only on xenial (while some older only on trusty) Ubuntu distribution
 dist: xenial
 
 env:
   TOXENV=py
   EXTRA_ARGS="-n 12"
   TEST_MYPYC=0
+  PYTHON_DEBUG_BUILD=0
 
 jobs:
   include:
@@ -22,14 +31,28 @@ jobs:
     python: 3.6    # 3.6.3  pip  9.0.1
   - name: "run test suite with python 3.7"
     python: 3.7    # 3.7.0  pip 10.0.1
+  - name: "run test suite with python 3.8"
+    python: 3.8
+  - name: "run mypyc runtime tests with python 3.6 debug build"
+    language: generic
+    env:
+      - TOXENV=py36
+      - PYTHONVERSION=3.6.8
+      - PYTHON_DEBUG_BUILD=1
+      - EXTRA_ARGS="-n 12 mypyc/test/test_run.py mypyc/test/test_external.py"
+  - name: "run mypyc runtime tests with python 3.6 on OS X"
+    os: osx
+    osx_image: xcode8.3
+    language: generic
+    env:
+      - PYTHONVERSION=3.6.3
+      - EXTRA_ARGS="-n 12 mypyc/test/test_run.py mypyc/test/test_external.py"
   - name: "run test suite with python 3.7 (compiled with mypyc)"
     python: 3.7
     env:
     - TOXENV=py
     - EXTRA_ARGS="-n 12"
     - TEST_MYPYC=1
-  # - name: "run test suite with python 3.8-dev"
-  #   python: 3.8-dev
   - name: "type check our own code"
     python: 3.7
     env:
@@ -58,11 +81,33 @@ install:
 - pip install -U pip setuptools
 - pip install -U tox==3.9.0
 - tox --notest
+
 # This is a big hack and only works because the layout of our directories
 # means that tox picks up the mypy from the source directories instead of
 # the version it installed into a venv. This is also *why* we need to do this,
 # since if we arranged for tox to build with mypyc, pytest wouldn't use it.
-- if [[ $TEST_MYPYC == 1 ]]; then pip install -r mypyc-requirements.txt; CC=clang MYPYC_OPT_LEVEL=0 python3 setup.py --use-mypyc build_ext --inplace; fi
+- if [[ $TEST_MYPYC == 1 ]]; then pip install -r mypy-requirements.txt; CC=clang MYPYC_OPT_LEVEL=0 python3 setup.py --use-mypyc build_ext --inplace; fi
 
 script:
 - tox -- $EXTRA_ARGS
+
+# Getting our hands on a debug build or the right OS X build is
+# annoying, unfortunately.
+before_install: |
+  set -e
+  if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
+    if [[ $PYTHON_DEBUG_BUILD == 1 ]]; then
+      PYTHONDIR=~/python-debug/python-$PYTHONVERSION
+      VENV=$PYTHONDIR/env
+      misc/build-debug-python.sh $PYTHONVERSION $PYTHONDIR $VENV
+      source $VENV/bin/activate
+    fi
+  elif [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
+    # Attempt to install, skipping if version already exists.
+    pyenv install $PYTHONVERSION -s
+    # Regenerate shims
+    pyenv rehash
+    # Manually set pyenv variables per https://pythonhosted.org/CodeChat/.travis.yml.html
+    export PYENV_VERSION=$PYTHONVERSION
+    export PATH="/Users/travis/.pyenv/shims:${PATH}"
+  fi

LICENSE

@@ -1,10 +1,10 @@
-Mypy is licensed under the terms of the MIT license, reproduced below.
+Mypy (and mypyc) are licensed under the terms of the MIT license, reproduced below.
 
 = = = = =
 
 The MIT License
 
-Copyright (c) 2015-2016 Jukka Lehtosalo and contributors
+Copyright (c) 2015-2019 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"),
@@ -26,8 +26,10 @@ DEALINGS IN THE SOFTWARE.
 
 = = = = =
 
-Portions of mypy are licensed under different licenses.  The files
-under stdlib-samples are licensed under the PSF 2 License, reproduced below.
+Portions of mypy and mypyc are licensed under different licenses.  The
+files under stdlib-samples as well as the files
+mypyc/lib-rt/pythonsupport.h and mypyc/lib-rt/getargs.c are licensed
+under the PSF 2 License, reproduced below.
 
 = = = = =
 
@@ -223,5 +225,3 @@ FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-= = = = =

MANIFEST.in

@@ -4,6 +4,7 @@ recursive-include extensions *
 recursive-include docs *
 recursive-include mypy/typeshed *.py *.pyi
 recursive-include mypy/xml *.xsd *.xslt *.css
+recursive-include mypyc/lib-rt *.c *.h *.tmpl
 include mypy_bootstrap.ini
 include mypy_self_check.ini
 include LICENSE

README.md

@@ -110,11 +110,16 @@ IDE, Linter Integrations, and Pre-commit
 
 Mypy can be integrated into popular IDEs:
 
-* Vim: [syntastic](https://github.com/vim-syntastic/syntastic) in `.vimrc` add `let g:syntastic_python_checkers=['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/) and [Flycheck-mypy](https://github.com/lbolla/emacs-flycheck-mypy)
 * 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 of PEP 484](https://www.jetbrains.com/help/pycharm/type-hinting-in-product.html))
+* PyCharm: [mypy plugin](https://github.com/dropbox/mypy-PyCharm-plugin) (PyCharm integrates
+  [its own implementation of PEP 484](https://www.jetbrains.com/help/pycharm/type-hinting-in-product.html))
 * VS Code: provides [basic integration](https://code.visualstudio.com/docs/python/linting#_mypy) with mypy.
 
 Mypy can also be integrated into [Flake8] using [flake8-mypy], or
@@ -216,7 +221,7 @@ This submodule contains types for the Python standard library.
 
 Due to the way git submodules work, you'll have to do
 ```
-  git submodule update typeshed
+  git submodule update mypy/typeshed
 ```
 whenever you change branches, merge, rebase, or pull.
 
@@ -264,10 +269,11 @@ in the typing gitter instead: https://gitter.im/python/typing
 Compiled version of mypy
 ------------------------
 
-We have built an compiled version of mypy using the [mypyc
-compiler](https://github.com/mypyc/mypyc) for mypy-annotated Python
-code. It is approximately 4 times faster than interpreted mypy and is
-available (and the default) for 64-bit Windows, macOS, and Linux.
+We have built a compiled version of mypy using the [mypyc
+compiler](https://github.com/python/mypy/tree/master/mypyc) for
+mypy-annotated Python code. It is approximately 4 times faster than
+interpreted mypy and is available (and the default) for 64-bit
+Windows, macOS, and Linux.
 
 To install an interpreted mypy instead, use:
 

appveyor.yml

@@ -3,10 +3,14 @@ cache:
 
 environment:
   matrix:
-
     - PYTHON: "C:\\Python37-x64"
       PYTHON_VERSION: "3.7.x"
       PYTHON_ARCH: "64"
+      EXTRA_ARGS:
+    - PYTHON: "C:\\Python37"
+      PYTHON_VERSION: "3.7.x"
+      PYTHON_ARCH: "32"
+      EXTRA_ARGS: "mypyc/test/test_run.py mypyc/test/test_external.py"
 
 install:
     - "git submodule update --init mypy/typeshed"
@@ -16,7 +20,7 @@ install:
 build: off
 
 test_script:
-    - "%PYTHON%\\python.exe -m tox -e py37"
+    - "%PYTHON%\\python.exe -m tox -e py37 %EXTRA_ARGS%"
 
 skip_commits:
   files:

conftest.py

@@ -9,3 +9,10 @@ def pytest_configure(config):
     mypy_source_root = os.path.dirname(os.path.abspath(__file__))
     if os.getcwd() != mypy_source_root:
         os.chdir(mypy_source_root)
+
+
+# This function name is special to pytest.  See
+# http://doc.pytest.org/en/latest/writing_plugins.html#initialization-command-line-and-configuration-hooks
+def pytest_addoption(parser) -> None:
+    parser.addoption('--bench', action='store_true', default=False,
+                     help='Enable the benchmark test runs')

docs/source/additional_features.rst

@@ -9,9 +9,10 @@ of the previous sections.
 Dataclasses
 ***********
 
-In Python 3.7, a new ``dataclasses`` module has been added to the standard library.
+In Python 3.7, a new :py:mod:`dataclasses` module has been added to the standard library.
 This module allows defining and customizing simple boilerplate-free classes.
-They can be defined using the ``@dataclasses.dataclass`` decorator:
+They can be defined using the :py:func:`@dataclasses.dataclass
+<python:dataclasses.dataclass>` decorator:
 
 .. code-block:: python
 
@@ -25,7 +26,7 @@ They can be defined using the ``@dataclasses.dataclass`` decorator:
     test = Application("Testing...")  # OK
     bad = Application("Testing...", "with plugin")  # Error: List[str] expected
 
-Mypy will detect special methods (such as ``__lt__``) depending on the flags used to
+Mypy will detect special methods (such as :py:meth:`__lt__ <object.__lt__>`) depending on the flags used to
 define dataclasses. For example:
 
 .. code-block:: python
@@ -65,16 +66,16 @@ class can be used:
 
     val = unbox(BoxedData(42, "<important>"))  # OK, inferred type is int
 
-For more information see `official docs <https://docs.python.org/3/library/dataclasses.html>`_
-and `PEP 557 <https://www.python.org/dev/peps/pep-0557/>`_.
+For more information see :doc:`official docs <python:library/dataclasses>`
+and :pep:`557`.
 
 Caveats/Known Issues
 ====================
 
-Some functions in the ``dataclasses`` module, such as ``replace()`` and ``asdict()``,
+Some functions in the :py:mod:`dataclasses` module, such as :py:func:`~dataclasses.replace` and :py:func:`~dataclasses.asdict`,
 have imprecise (too permissive) types. This will be fixed in future releases.
 
-Mypy does not yet recognize aliases of ``dataclasses.dataclass``, and will
+Mypy does not yet recognize aliases of :py:func:`dataclasses.dataclass <dataclasses.dataclass>`, and will
 probably never recognize dynamically computed decorators. The following examples
 do **not** work:
 
@@ -110,7 +111,7 @@ do **not** work:
 The attrs package
 *****************
 
-`attrs <http://www.attrs.org/en/stable>`_ is a package that lets you define
+:doc:`attrs <attrs:index>` is a package that lets you define
 classes without writing boilerplate code. Mypy can detect uses of the
 package and will generate the necessary method definitions for decorated
 classes using the type annotations it finds.
@@ -139,7 +140,7 @@ If you're using ``auto_attribs=True`` you must use variable annotations.
         three: int = attr.ib(8)
 
 Typeshed has a couple of "white lie" annotations to make type checking
-easier. ``attr.ib`` and ``attr.Factory`` actually return objects, but the
+easier. :py:func:`attr.ib` and :py:class:`attr.Factory` actually return objects, but the
 annotation says these return the types that they expect to be assigned to.
 That enables this to work:
 
@@ -174,9 +175,9 @@ Caveats/Known Issues
 
 * Currently, ``converter`` only supports named functions.  If mypy finds something else it
   will complain about not understanding the argument and the type annotation in
-  ``__init__`` will be replaced by ``Any``.
+  :py:meth:`__init__ <object.__init__>` will be replaced by ``Any``.
 
-* `Validator decorators <http://www.attrs.org/en/stable/examples.html#validators>`_
+* :ref:`Validator decorators <attrs:examples_validators>`
   and `default decorators <http://www.attrs.org/en/stable/examples.html#defaults>`_
   are not type-checked against the attribute they are setting/validating.
 
@@ -285,7 +286,7 @@ run after starting or restarting the daemon.
 
 The mypy daemon requires extra fine-grained dependency data in
 the cache files which aren't included by default. To use caching with
-the mypy daemon, use the ``--cache-fine-grained`` option in your CI
+the mypy daemon, use the :option:`--cache-fine-grained <mypy --cache-fine-grained>` option in your CI
 build::
 
     $ mypy --cache-fine-grained <args...>
@@ -325,7 +326,7 @@ at least if your codebase is hundreds of thousands of lines or more:
   network), the script can still fall back to a normal incremental build.
 
 * You can have multiple local cache directories for different local branches
-  using the ``--cache-dir`` option. If the user switches to an existing
+  using the :option:`--cache-dir <mypy --cache-dir>` option. If the user switches to an existing
   branch where downloaded cache data is already available, you can continue
   to use the existing cache data instead of redownloading the data.
 
@@ -347,16 +348,16 @@ Extended Callable types
    This feature is deprecated.  You can use
    :ref:`callback protocols <callback_protocols>` as a replacement.
 
-As an experimental mypy extension, you can specify ``Callable`` types
+As an experimental mypy extension, you can specify :py:data:`~typing.Callable` types
 that support keyword arguments, optional arguments, and more.  When
-you specify the arguments of a Callable, you can choose to supply just
+you specify the arguments of a :py:data:`~typing.Callable`, you can choose to supply just
 the type of a nameless positional argument, or an "argument specifier"
 representing a more complicated form of argument.  This allows one to
 more closely emulate the full range of possibilities given by the
 ``def`` statement in Python.
 
 As an example, here's a complicated function definition and the
-corresponding ``Callable``:
+corresponding :py:data:`~typing.Callable`:
 
 .. code-block:: python
 
@@ -433,7 +434,7 @@ purpose:
 In all cases, the ``type`` argument defaults to ``Any``, and if the
 ``name`` argument is omitted the argument has no name (the name is
 required for ``NamedArg`` and ``DefaultNamedArg``).  A basic
-``Callable`` such as
+:py:data:`~typing.Callable` such as
 
 .. code-block:: python
 
@@ -445,7 +446,7 @@ is equivalent to the following:
 
    MyFunc = Callable[[Arg(int), Arg(str), Arg(int)], float]
 
-A ``Callable`` with unspecified argument types, such as
+A :py:data:`~typing.Callable` with unspecified argument types, such as
 
 .. code-block:: python
 

docs/source/builtin_types.rst

@@ -23,7 +23,7 @@ Type                   Description
 ====================== ===============================
 
 The type ``Any`` and type constructors such as ``List``, ``Dict``,
-``Iterable`` and ``Sequence`` are defined in the ``typing`` module.
+``Iterable`` and ``Sequence`` are defined in the :py:mod:`typing` module.
 
 The type ``Dict`` is a *generic* class, signified by type arguments within
 ``[...]``. For example, ``Dict[int, str]`` is a dictionary from integers to
@@ -35,6 +35,6 @@ strings and ``Dict[Any, Any]`` is a dictionary of dynamically typed
 correspond to Python protocols. For example, a ``str`` object or a
 ``List[str]`` object is valid
 when ``Iterable[str]`` or ``Sequence[str]`` is expected. Note that even though
-they are similar to abstract base classes defined in ``collections.abc``
+they are similar to abstract base classes defined in :py:mod:`collections.abc`
 (formerly ``collections``), they are not identical, since the built-in
 collection type objects do not support indexing.

docs/source/casts.rst

@@ -6,7 +6,7 @@ Casts and type assertions
 Mypy supports type casts that are usually used to coerce a statically
 typed value to a subtype. Unlike languages such as Java or C#,
 however, mypy casts are only used as hints for the type checker, and they
-don't perform a runtime type check. Use the function ``cast`` to perform a
+don't perform a runtime type check. Use the function :py:func:`~typing.cast` to perform a
 cast:
 
 .. code-block:: python

docs/source/cheat_sheet.rst

@@ -3,8 +3,7 @@
 Type hints cheat sheet (Python 2)
 =================================
 
-This document is a quick cheat sheet showing how the
-`PEP 484 <https://www.python.org/dev/peps/pep-0484/>`_ type
+This document is a quick cheat sheet showing how the :pep:`484` type
 language represents various common types in Python 2.
 
 .. note::