xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-zulip-api/tools/run-mypy

177 lines
8 KiB
Plaintext
Raw Normal View History

Finish the remaining migration of shebang to python3.
2020-04-03 05:11:02 -04:00
#!/usr/bin/env python3
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
from __future__ import absolute_import
from __future__ import print_function
import os
import sys
import argparse
import subprocess
mypy: Run mypy for each package separately.
2017-09-26 13:34:11 -04:00
from collections import OrderedDict
from pathlib import PurePath
lint: Use zulint's methods for `lister` and printing errors. Remove lister, printer and README files from server_lib.
2019-08-02 09:44:11 -04:00
from zulint import lister
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
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))
run-mypy: Document why certain files are not mypy-checked.
2017-10-27 02:02:52 -04:00
exclude = [
# Excluded because it's third-party code.
"zulip/integrations/perforce/git_p4.py",
# Excluded because we don't want to require bot authors to
# fully annotate their bots.
"zulip_bots/zulip_bots/bots",
zulip_bots: Add directory for unmaintained bots.
2017-11-02 09:47:28 -04:00
"zulip_bots/zulip_bots/bots_unmaintained",
Create terminal.py to run bots in the terminal. This program replaces zulip_bot_output.py, which had gotten a little out of date. It should be able to simulate a terminal conversation for all of our bots, including those that use "advanced" features: third party config files: tested with giphy message updates: tested with incrementor storage: tested with virtual_fs and others
2017-11-28 11:44:39 -05:00
# Excluded out of laziness:
"zulip_bots/zulip_bots/terminal.py",
"zulip_bots/zulip_bots/simple_lib.py",
bot lib tests: Move tests of bot library to tests/. This makes it clearer which files are for writing bot tests vs tests of the infrastructure.
2018-05-30 17:53:10 -04:00
"zulip_bots/zulip_bots/tests/test_lib.py",
integrations/trello: Make the zulip_trello script self-contained. A few users have complained about how hard it is to find the Trello script on their systems after installing the `zulip` package. Rishi and I decided that we should instead just ask the users to download the script directly and run it without having to install the `zulip` package. This commit also ensures that the script can be run on both py2 and py3.
2018-09-14 16:31:13 -04:00
# Excluded because this is a self-contained script
# we ask our users to download and run directly and
# py2 and py3 compatibility is required.
"zulip/integrations/trello/zulip_trello.py",
mypy: Support files without extensions for scripts in /tools. This assumes that files passed in force_include without any extension are meant to be run with mypy, and thus assumed to be python scripts. Also, we ignore the most of the tools dir, except for the tools/deploy script for which #349 adds type annotations.
2018-03-22 21:37:49 -04:00
"tools",
run-mypy: Document why certain files are not mypy-checked.
2017-10-27 02:02:52 -04:00
]
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
tools: Allow force including files for mypy.
2017-12-04 04:54:56 -05:00
# These files will be included even if excluded by a rule above.
force_include = [
# Include bots that we migrate to mypy.
"zulip_bots/zulip_bots/bots/helloworld/helloworld.py",
tests: Add test_helloworld to run-mypy list.
2017-12-08 04:09:38 -05:00
"zulip_bots/zulip_bots/bots/helloworld/test_helloworld.py",
bots/followup: Use Python 3 type mypy annotations.
2017-12-06 19:58:46 -05:00
"zulip_bots/zulip_bots/bots/followup/followup.py",
"zulip_bots/zulip_bots/bots/followup/test_followup.py",
bots/giphy: Use Python 3 type mypy annotations.
2017-12-06 20:03:53 -05:00
"zulip_bots/zulip_bots/bots/giphy/giphy.py",
"zulip_bots/zulip_bots/bots/giphy/test_giphy.py",
mypy: Add annotations for github_detail.
2017-12-07 14:25:28 -05:00
"zulip_bots/zulip_bots/bots/github_detail/github_detail.py",
"zulip_bots/zulip_bots/bots/github_detail/test_github_detail.py",
add _ to googletranslate and googlesearch
2017-12-11 13:26:31 -05:00
"zulip_bots/zulip_bots/bots/google_search/google_search.py",
"zulip_bots/zulip_bots/bots/google_search/test_google_search.py",
mypy: Add annotations for help.
2017-12-07 14:44:42 -05:00
"zulip_bots/zulip_bots/bots/help/help.py",
"zulip_bots/zulip_bots/bots/help/test_help.py",
incrementor: Clean up type annotation/conversion. This adds mypy annotations, and we also make the type conversions in `handle_message` be a little more clear. (@showell helped clean up this commit a bit)
2017-12-09 16:55:55 -05:00
"zulip_bots/zulip_bots/bots/incrementor/incrementor.py",
"zulip_bots/zulip_bots/bots/incrementor/test_incrementor.py",
mypy: Add annotations for Link Shortener Bot. Based on work started by @skunkmb.
2017-12-09 17:00:33 -05:00
"zulip_bots/zulip_bots/bots/link_shortener/link_shortener.py",
"zulip_bots/zulip_bots/bots/link_shortener/test_link_shortener.py",
mypy: Add annotations for virtual_fs.
2017-12-08 06:14:55 -05:00
"zulip_bots/zulip_bots/bots/virtual_fs/virtual_fs.py",
"zulip_bots/zulip_bots/bots/virtual_fs/test_virtual_fs.py",
mypy: Add annotations for weather.
2017-12-08 07:31:42 -05:00
"zulip_bots/zulip_bots/bots/weather/test_weather.py",
"zulip_bots/zulip_bots/bots/weather/weather.py",
bots: Add mypy to youtube bot
2017-12-09 05:03:45 -05:00
"zulip_bots/zulip_bots/bots/youtube/youtube.py",
"zulip_bots/zulip_bots/bots/youtube/test_youtube.py",
mypy: Add annotations for converter.
2017-12-07 18:53:29 -05:00
"zulip_bots/zulip_bots/bots/converter/converter.py",
"zulip_bots/zulip_bots/bots/converter/test_converter.py",
"zulip_bots/zulip_bots/bots/define/define.py",
"zulip_bots/zulip_bots/bots/define/test_define.py",
"zulip_bots/zulip_bots/bots/encrypt/encrypt.py",
"zulip_bots/zulip_bots/bots/encrypt/test_encrypt.py",
mypy: Fix paths to chessbot files.
2018-05-28 06:45:28 -04:00
"zulip_bots/zulip_bots/bots/chessbot/chessbot.py",
"zulip_bots/zulip_bots/bots/chessbot/test_chessbot.py",
mypy: Add annotations for xkcd Bot.
2017-12-09 15:35:16 -05:00
"zulip_bots/zulip_bots/bots/xkcd/xkcd.py",
"zulip_bots/zulip_bots/bots/xkcd/test_xkcd.py",
bots: Create Wit.ai Bot. Wit.ai Bot communicates with the Wit.ai API. It can be configured with any Wit.ai token and allows for setting up a custom handler function to handle Wit.ai responses.
2017-12-17 21:23:22 -05:00
"zulip_bots/zulip_bots/bots/witai/witai.py",
"zulip_bots/zulip_bots/bots/witai/test_witai.py",
mypy: Add annotations for Wikipedia Bot.
2017-12-09 15:44:11 -05:00
"zulip_bots/zulip_bots/bots/wikipedia/wikipedia.py",
"zulip_bots/zulip_bots/bots/wikipedia/test_wikipedia.py",
mypy: Add annotations for Yoda Bot.
2017-12-09 15:55:41 -05:00
"zulip_bots/zulip_bots/bots/yoda/yoda.py",
"zulip_bots/zulip_bots/bots/yoda/test_yoda.py",
interactive bots: Create DialogFlow bot.
2017-12-09 15:11:18 -05:00
"zulip_bots/zulip_bots/bots/dialogflow/dialogflow.py",
interactive bots: Create Mention bot.
2017-12-24 07:08:45 -05:00
"zulip_bots/zulip_bots/bots/dialogflow/test_dialogflow.py",
"zulip_bots/zulip_bots/bots/mention/mention.py",
update run-mypy: Add Baremetrics bot files.
2017-12-29 08:22:27 -05:00
"zulip_bots/zulip_bots/bots/mention/test_mention.py",
"zulip_bots/zulip_bots/bots/baremetrics/baremetrics.py",
interactive bots: Create Salesforce bot.
2017-12-31 12:26:13 -05:00
"zulip_bots/zulip_bots/bots/baremetrics/test_baremetrics.py",
"zulip_bots/zulip_bots/bots/salesforce/salesforce.py",
interactive bots: Create idonethis bot.
2018-01-05 06:09:21 -05:00
"zulip_bots/zulip_bots/bots/salesforce/test_salesforce.py",
"zulip_bots/zulip_bots/bots/idonethis/idonethis.py",
zulip_bots: Migrate connect_four bot to new game_handler.
2018-01-19 10:55:42 -05:00
"zulip_bots/zulip_bots/bots/idonethis/test_idonethis.py",
"zulip_bots/zulip_bots/bots/connect_four/connect_four.py",
"zulip_bots/zulip_bots/bots/connect_four/test_connect_four.py",
"zulip_bots/zulip_bots/bots/tictactoe/tictactoe.py",
"zulip_bots/zulip_bots/bots/tictactoe/test_tictactoe.py",
bots: Add type annotations for trivia_quiz bot.
2018-06-11 10:01:02 -04:00
"zulip_bots/zulip_bots/bots/trivia_quiz/trivia_quiz.py",
"zulip_bots/zulip_bots/bots/trivia_quiz/test_trivia_quiz.py",
zulip_bots: Migrate connect_four bot to new game_handler.
2018-01-19 10:55:42 -05:00
"zulip_bots/zulip_bots/bots/game_handler_bot/game_handler_bot.py",
"zulip_bots/zulip_bots/bots/game_handler_bot/test_game_handler_bot.py",
interactive bots: Add Trello Interactive Bot.
2018-01-23 12:29:26 -05:00
"zulip_bots/zulip_bots/bots/trello/trello.py",
Susi AI Bot: Create a susi ai bot. This bot uses SUSI_SERVER API to get response.
2018-02-22 00:49:52 -05:00
"zulip_bots/zulip_bots/bots/trello/test_trello.py",
"zulip_bots/zulip_bots/bots/susi/susi.py",
"zulip_bots/zulip_bots/bots/susi/test_susi.py",
interactive bots: Create Front bot.
2018-03-02 18:27:35 -05:00
"zulip_bots/zulip_bots/bots/front/front.py",
mypy: Support files without extensions for scripts in /tools. This assumes that files passed in force_include without any extension are meant to be run with mypy, and thus assumed to be python scripts. Also, we ignore the most of the tools dir, except for the tools/deploy script for which #349 adds type annotations.
2018-03-22 21:37:49 -04:00
"zulip_bots/zulip_bots/bots/front/test_front.py",
"tools/deploy"
tools: Allow force including files for mypy.
2017-12-04 04:54:56 -05:00
]
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
parser = argparse.ArgumentParser(description="Run mypy on files tracked by git.")
mypy: Run mypy for each package separately.
2017-09-26 13:34:11 -04:00
parser.add_argument('targets', nargs='*', default=[],
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
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('--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('--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""")
args = parser.parse_args()
if args.all:
exclude = []
# 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))
tools: Allow force including files for mypy.
2017-12-04 04:54:56 -05:00
for inpath in force_include:
mypy: Support files without extensions for scripts in /tools. This assumes that files passed in force_include without any extension are meant to be run with mypy, and thus assumed to be python scripts. Also, we ignore the most of the tools dir, except for the tools/deploy script for which #349 adds type annotations.
2018-03-22 21:37:49 -04:00
try:
ext = os.path.splitext(inpath)[1].split('.')[1]
except IndexError:
ext = 'py' # type: str
tools: Allow force including files for mypy.
2017-12-04 04:54:56 -05:00
files_dict[ext].append(inpath)
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
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]
mypy: Support files without extensions for scripts in /tools. This assumes that files passed in force_include without any extension are meant to be run with mypy, and thus assumed to be python scripts. Also, we ignore the most of the tools dir, except for the tools/deploy script for which #349 adds type annotations.
2018-03-22 21:37:49 -04:00
repo_python_files = OrderedDict([('zulip', []), ('zulip_bots', []), ('zulip_botserver', []), ('tools', [])])
mypy: Run mypy for each package separately.
2017-09-26 13:34:11 -04:00
for file_path in python_files:
repo = PurePath(file_path).parts[0]
if repo in repo_python_files:
repo_python_files[repo].append(file_path)
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
mypy_command = "mypy"
tools: Migrate core run-mypy options to mypy.ini. Add traceback option, as used in core Zulip run-mypy.
2018-03-31 02:00:35 -04:00
extra_args = ["--follow-imports=silent"]
tools: Add mypy runner. Unless otherwise specified, `tools/run-mypy` will right now only check annotations in core files of the `zulip` package.
2017-09-15 07:24:20 -04:00
if args.disallow_untyped_defs:
extra_args.append("--disallow-untyped-defs")
if args.warn_unused_ignores:
extra_args.append("--warn-unused-ignores")
if args.ignore_missing_imports:
extra_args.append("--ignore-missing-imports")
if args.quick:
extra_args.append("--quick")
# run mypy
mypy: Run mypy for each package separately.
2017-09-26 13:34:11 -04:00
status = 0
for repo, python_files in repo_python_files.items():
tools: Enhance output of run-mypy. This removes the excessively verbose lists of files to be tested, and flushes the output after every print to update the user on the current status in real time.
2017-10-20 07:06:47 -04:00
print("Running mypy for `{}`.".format(repo), flush=True)
mypy: Run mypy for each package separately.
2017-09-26 13:34:11 -04:00
if python_files:
result = subprocess.call([mypy_command] + extra_args + python_files)
if result != 0:
status = result
else:
print("There are no files to run mypy on.")
sys.exit(status)
Reference in a new issue Copy permalink