zulip/tools/run-mypy

#!/usr/bin/env python3

from __future__ import absolute_import
from __future__ import print_function

import os
import sys
import argparse
import subprocess
import six

import lister
from typing import cast, Dict, List

TOOLS_DIR = os.path.dirname(os.path.abspath(__file__))
os.chdir(os.path.dirname(TOOLS_DIR))

sys.path.append(os.path.dirname(TOOLS_DIR))
from lib.test_script import get_provisioning_status

exclude_common = """
zproject/settings.py
zproject/test_settings.py
""".split()

exclude_py2 = []  # type: List[str]

exclude_py3 = """
""".split()

parser = argparse.ArgumentParser(description="Run mypy on files tracked by git.")
parser.add_argument('targets', nargs='*', default=[],
                    help="""files and directories to include in the result.
                    If this is not specified, the current directory is used""")
parser.add_argument('-m', '--modified', action='store_true', default=False, help='list only modified files')
parser.add_argument('-a', '--all', dest='all', action='store_true', default=False,
                    help="""run mypy on all python files, ignoring the exclude list.
                    This is useful if you have to find out which files fail mypy check.""")
parser.add_argument('--linecoverage-report', dest='linecoverage_report', action='store_true', default=False,
                    help="""run the linecoverage report to see annotation coverage""")
parser.add_argument('--no-disallow-untyped-defs', dest='disallow_untyped_defs', action='store_false', default=True,
                    help="""Don't throw errors when functions are not annotated""")
parser.add_argument('--scripts-only', dest='scripts_only', action='store_true', default=False,
                    help="""Only type check extensionless python scripts""")
parser.add_argument('--strict-optional', dest='strict_optional', action='store_true', default=False,
                    help="""Use the --strict-optional flag with mypy""")
parser.add_argument('--warn-unused-ignores', dest='warn_unused_ignores', action='store_true', default=False,
                    help="""Use the --warn-unused-ignores flag with mypy""")
parser.add_argument('--no-ignore-missing-imports', dest='ignore_missing_imports', action='store_false', default=True,
                    help="""Don't use the --ignore-missing-imports flag with mypy""")
parser.add_argument('--quick', action='store_true', default=False,
                    help="""Use the --quick flag with mypy""")
parser.add_argument('--force', default=False,
                    action="store_true",
                    help='Run tests despite possible provisioning problems.')

group = parser.add_mutually_exclusive_group()
group.add_argument('--py2', default=False, action='store_true', help="Use Python 2 mode")
group.add_argument('--py3', default=False, action='store_true', help="Use Python 3 mode")
args = parser.parse_args()

if not args.force:
    ok, msg = get_provisioning_status()
    if not ok:
        print(msg)
        print('If you really know what you are doing, use --force to run anyway.')
        sys.exit(1)

if args.py2:
    py_version = 2
elif args.py3:
    py_version = 3
else:
    py_version = 2

if args.all:
    exclude = []  # type: List[str]
if py_version == 2:
    exclude = exclude_common + exclude_py2
else:
    exclude = exclude_common + exclude_py3

# find all non-excluded files in current directory
files_dict = cast(Dict[str, List[str]],
                  lister.list_files(targets=args.targets, ftypes=['py', 'pyi'],
                                    use_shebang=True, modified_only=args.modified,
                                    exclude = exclude + ['stubs'], group_by_ftype=True,
                                    extless_only=args.scripts_only))
pyi_files = set(files_dict['pyi'])
python_files = [fpath for fpath in files_dict['py']
                if not fpath.endswith('.py') or fpath + 'i' not in pyi_files]

# Use zulip-py3-venv's mypy if it's available and we're on python 2
PY3_VENV_DIR = "/srv/zulip-py3-venv"
MYPY_VENV_PATH = os.path.join(PY3_VENV_DIR, "bin", "mypy")
if six.PY2 and os.path.exists(MYPY_VENV_PATH):
    mypy_command = MYPY_VENV_PATH
    print("Using mypy from", mypy_command)
else:
    mypy_command = "mypy"

extra_args = ["--check-untyped-defs",
              "--follow-imports=silent",
              "--scripts-are-modules",
              "-i", "--cache-dir=var/mypy-cache"]
if py_version == 2:
    extra_args.append("--py2")
if args.linecoverage_report:
    extra_args.append("--linecoverage-report")
    extra_args.append("var/linecoverage-report")
if args.disallow_untyped_defs:
    extra_args.append("--disallow-untyped-defs")
if args.warn_unused_ignores:
    extra_args.append("--warn-unused-ignores")
if args.strict_optional:
    extra_args.append("--strict-optional")
if args.ignore_missing_imports:
    extra_args.append("--ignore-missing-imports")
if args.quick:
    extra_args.append("--quick")


# run mypy
if python_files:
    rc = subprocess.call([mypy_command] + extra_args + python_files)
    if args.linecoverage_report:
        # Move the coverage report to where codecov will look for it.
        try:
            os.rename('var/linecoverage-report/coverage.txt', 'var/.coverage')
        except OSError:
            # maybe mypy crashed; exit with its error code
            pass
    sys.exit(rc)
else:
    print("There are no files to run mypy on.")