Adds python3.9 and proper MYPYPATH handling (#44)

* Adds python3.9 and proper MYPYPATH handling

* Now using Github Actions

* Now using Github Actions

* Fixes mypy

Author: sobolevn

.github/workflows/misspell.yml

@@ -0,0 +1,19 @@
+name: misspell
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: sobolevn/[email protected]
+    - uses: peter-evans/[email protected]
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        commit-message: 'Fixes by misspell-fixer'
+        title: 'Typos fix by misspell-fixer'

.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: test
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install -U pip setuptools wheel
+        pip install -r dev-requirements.txt
+    - name: Run tests
+      run: pytest
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        pip install -U pip setuptools wheel
+        pip install -r dev-requirements.txt
+    - name: Run linters
+      run: |
+        mypy .
+        black --check pytest_mypy_plugins setup.py
+        isort --check --diff .

.travis.yml

@@ -0,0 +1,20 @@
+# Version history
+
+## Version 1.6.0
+
+### Features
+
+- Adds `python3.9` support
+- Bumps required version of `pytest` to `>=6.0`
+- Bumps required version of `mypy` to `>=0.790`
+
+### Misc
+
+- Moves from Travis to Github Actions
+
+
+## Version 1.5.0
+
+### Features
+
+- Adds `PYTHONPATH` and `MYPYPATH` special handling

CHANGELOG.md

@@ -33,6 +33,19 @@ where relative paths such as `PYTHONPATH=./my_plugin` do not reference the direc
 If you encounter this, consider invoking `pytest` with `--mypy-same-process` or make your paths absolute,
 e.g. `PYTHONPATH=$(pwd)/my_plugin pytest`.
 
+You can also specify `PYTHONPATH`, `MYPYPATH`, or any other environment variable in `env:` section of `yml` spec:
+
+```yml
+- case: mypy_path_from_env
+  main: |
+    from pair import Pair
+
+    instance: Pair
+    reveal_type(instance)  # N: Revealed type is 'pair.Pair'
+  env:
+    - MYPYPATH=./pytest_mypy_plugins/tests/fixtures
+```
+
 
 ### What is a test case?
 

README.md

@@ -5,16 +5,29 @@
 import tempfile
 from configparser import ConfigParser
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Tuple
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Callable,
+    Dict,
+    List,
+    Optional,
+    Tuple,
+    Union,
+)
 
+import py
 import pytest
 from _pytest._code import ExceptionInfo
-from _pytest._code.code import ReprEntry, ReprFileLocation
+from _pytest._code.code import ReprEntry, ReprFileLocation, TerminalRepr
+from _pytest._io import TerminalWriter
 from _pytest.config import Config
 from mypy import build
 from mypy.fscache import FileSystemCache
 from mypy.main import process_options
-from py._io.terminalwriter import TerminalWriter
+
+if TYPE_CHECKING:
+    from _pytest._code.code import _TracebackStyle
 
 from pytest_mypy_plugins import utils
 from pytest_mypy_plugins.collect import File, YamlTestFile
@@ -28,6 +41,9 @@
 
 class TraceLastReprEntry(ReprEntry):
     def toterminal(self, tw: TerminalWriter) -> None:
+        if not self.reprfileloc:
+            return
+
         self.reprfileloc.toterminal(tw)
         for line in self.lines:
             red = line.startswith("E   ")
@@ -56,6 +72,12 @@ def replace_fpath_with_module_name(line: str, rootdir: Path) -> str:
     return line.strip().replace(".py:", ":")
 
 
+def maybe_to_abspath(rel_or_abs: str, rootdir: Optional[Path]) -> str:
+    if rootdir is None or os.path.isabs(rel_or_abs):
+        return rel_or_abs
+    return str(rootdir / rel_or_abs)
+
+
 class ReturnCodes:
     SUCCESS = 0
     FAIL = 1
@@ -174,22 +196,11 @@ def typecheck_in_new_subprocess(
         mypy_executable = distutils.spawn.find_executable("mypy")
         assert mypy_executable is not None, "mypy executable is not found"
 
+        rootdir = getattr(getattr(self.parent, "config", None), "rootdir", None)
         # add current directory to path
-        self.environment_variables["PYTHONPATH"] = ":".join(
-            [
-                os.environ.get("PYTHONPATH", ""),
-                str(execution_path),
-            ]
-        )
-
+        self._collect_python_path(rootdir, execution_path)
         # adding proper MYPYPATH variable
-        mypy_path_parts = []
-        existing_mypy_path = os.environ.get("MYPYPATH", "")
-        if existing_mypy_path:
-            mypy_path_parts.append(existing_mypy_path)
-        if self.base_ini_fpath:
-            mypy_path_parts.append(os.path.dirname(self.base_ini_fpath))
-        self.environment_variables["MYPYPATH"] = ":".join(mypy_path_parts)
+        self._collect_mypy_path(rootdir)
 
         # Windows requires this to be set, otherwise the interpreter crashes
         if "SYSTEMROOT" in os.environ:
@@ -313,7 +324,9 @@ def prepare_mypy_cmd_options(self, execution_path: Path) -> List[str]:
 
         return mypy_cmd_options
 
-    def repr_failure(self, excinfo: ExceptionInfo) -> str:
+    def repr_failure(
+        self, excinfo: ExceptionInfo[BaseException], style: Optional["_TracebackStyle"] = None
+    ) -> Union[str, TerminalRepr]:
         if excinfo.errisinstance(SystemExit):
             # We assume that before doing exit() (which raises SystemExit) we've printed
             # enough context about what happened so that a stack trace is not useful.
@@ -323,9 +336,9 @@ def repr_failure(self, excinfo: ExceptionInfo) -> str:
         elif excinfo.errisinstance(TypecheckAssertionError):
             # with traceback removed
             exception_repr = excinfo.getrepr(style="short")
-            exception_repr.reprcrash.message = ""
+            exception_repr.reprcrash.message = ""  # type: ignore
             repr_file_location = ReprFileLocation(
-                path=self.fspath, lineno=self.starting_lineno + excinfo.value.lineno, message=""
+                path=self.fspath, lineno=self.starting_lineno + excinfo.value.lineno, message=""  # type: ignore
             )
             repr_tb_entry = TraceLastReprEntry(
                 exception_repr.reprtraceback.reprentries[-1].lines[1:], None, None, repr_file_location, "short"
@@ -335,5 +348,41 @@ def repr_failure(self, excinfo: ExceptionInfo) -> str:
         else:
             return super().repr_failure(excinfo, style="native")
 
-    def reportinfo(self) -> Tuple[str, Optional[str], str]:
+    def reportinfo(self) -> Tuple[Union[py.path.local, str], Optional[int], str]:
         return self.fspath, None, self.name
+
+    def _collect_python_path(
+        self,
+        rootdir: Optional[Path],
+        execution_path: Path,
+    ) -> None:
+        python_path_parts = []
+
+        existing_python_path = os.environ.get("PYTHONPATH")
+        if existing_python_path:
+            python_path_parts.append(existing_python_path)
+        if execution_path:
+            python_path_parts.append(str(execution_path))
+        python_path_key = self.environment_variables.get("PYTHONPATH")
+        if python_path_key:
+            python_path_parts.append(
+                maybe_to_abspath(python_path_key, rootdir),
+            )
+
+        self.environment_variables["PYTHONPATH"] = ":".join(python_path_parts)
+
+    def _collect_mypy_path(self, rootdir: Optional[Path]) -> None:
+        mypy_path_parts = []
+
+        existing_mypy_path = os.environ.get("MYPYPATH")
+        if existing_mypy_path:
+            mypy_path_parts.append(existing_mypy_path)
+        if self.base_ini_fpath:
+            mypy_path_parts.append(os.path.dirname(self.base_ini_fpath))
+        mypy_path_key = self.environment_variables.get("MYPYPATH")
+        if mypy_path_key:
+            mypy_path_parts.append(
+                maybe_to_abspath(mypy_path_key, rootdir),
+            )
+
+        self.environment_variables["MYPYPATH"] = ":".join(mypy_path_parts)

pytest_mypy_plugins/item.py

@@ -0,0 +1,2 @@
+class Pair(object):
+    """We only have this type to make sure that MYPYPATH works."""

pytest_mypy_plugins/tests/fixtures/pair.py

@@ -0,0 +1,17 @@
+-   case: mypy_path_from_env
+    main: |
+        from pair import Pair
+
+        a: Pair
+        reveal_type(a)  # N: Revealed type is 'pair.Pair'
+    env:
+        - MYPYPATH=./pytest_mypy_plugins/tests/fixtures
+
+
+-   case: mypy_path_from_env_with_error
+    main: |
+        from pair import Missing
+    out: |
+      main:1: error: Module 'pair' has no attribute 'Missing'
+    env:
+        - MYPYPATH=./pytest_mypy_plugins/tests/fixtures

pytest_mypy_plugins/tests/test-paths-from-env.yml

@@ -4,16 +4,16 @@
     readme = f.read()
 
 dependencies = [
-    "pytest>=5.4.0",
-    "mypy>=0.730",
+    "pytest>=6.0.0",
+    "mypy>=0.790",
     "decorator",
     "pyyaml",
     "pystache>=0.5.4",
 ]
 
 setup(
     name="pytest-mypy-plugins",
-    version="1.5.0",
+    version="1.6.0",
     description="pytest plugin for writing tests for mypy plugins",
     long_description=readme,
     long_description_content_type="text/markdown",
@@ -32,5 +32,6 @@
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
     ],
 )