https://github.com/praw-dev/praw
Tip revision: 2a0db0557bd950c7abe940751d69c10c00af4349 authored by Bryce Boe on 03 February 2021, 21:03:48 UTC
Merge pull request #1639 from praw-dev/version
Merge pull request #1639 from praw-dev/version
Tip revision: 2a0db05
pre_push.py
#!/usr/bin/env python3
"""Run static analysis on the project."""
import argparse
import sys
from os import path
from shutil import rmtree
from subprocess import CalledProcessError, check_call
from tempfile import mkdtemp
current_directory = path.abspath(path.join(__file__, ".."))
def do_process(args, shell=False):
"""Run program provided by args.
Return True on success.
Output failed message on non-zero exit and return False.
Exit if command is not found.
"""
print(f"Running: {' '.join(args)}")
try:
check_call(args, shell=shell)
except CalledProcessError:
print(f"\nFailed: {' '.join(args)}")
return False
except Exception as exc:
sys.stderr.write(f"{str(exc)}\n")
sys.exit(1)
return True
def run_static():
"""Runs the static tests.
Returns a statuscode of 0 if everything ran correctly.
Otherwise, it will return statuscode 1
"""
success = True
# Formatters
success &= do_process(
[
sys.executable,
path.join(current_directory, "tools", "static_word_checks.py"),
"--replace",
]
)
success &= do_process(["flynt", "-q", "-tc", "-ll", "1000", "."])
# needs to be first because flynt is not black compliant
success &= do_process(["black", "."])
success &= do_process(["isort", "."])
# Linters
success &= do_process(
[
sys.executable,
path.join(current_directory, "tools", "check_documentation.py"),
]
)
success &= do_process(
[
sys.executable,
path.join(current_directory, "tools", "check_docstring.py"),
]
)
success &= do_process(["flake8", "--exclude=.eggs,build,docs,.venv"])
success &= do_process(["pydocstyle", "praw"])
# success &= do_process(["pylint", "--rcfile=.pylintrc", "praw"])
tmp_dir = mkdtemp()
try:
success &= do_process(["sphinx-build", "-W", "--keep-going", "docs", tmp_dir])
finally:
rmtree(tmp_dir)
return success
def run_unit():
"""Runs the unit-tests.
Follows the behavior of the static tests,
where any failed tests cause pre_push.py to fail.
"""
return do_process(["pytest"])
def main():
"""Runs the main function.
usage: pre_push.py [-h] [-n] [-u] [-a]
Run static and/or unit-tests
"""
parser = argparse.ArgumentParser(description="Run static and/or unit-tests")
parser.add_argument(
"-n",
"--unstatic",
action="store_true",
help="Do not run static tests (black/flake8/pydocstyle/sphinx-build)",
default=False,
)
parser.add_argument(
"-u",
"--unit-tests",
"--unit",
action="store_true",
default=False,
help="Run the unit tests",
)
parser.add_argument(
"-a",
"--all",
action="store_true",
default=False,
help="Run all of the tests (static and unit). Overrides the unstatic argument.",
)
args = parser.parse_args()
success = True
try:
if not args.unstatic or args.all:
success &= run_static()
if args.all or args.unit_tests:
success &= run_unit()
except KeyboardInterrupt:
return int(not False)
return int(not success)
if __name__ == "__main__":
exit_code = main()
print("\npre_push.py: Success!" if not exit_code else "\npre_push.py: Fail")
sys.exit(exit_code)