forked from Qiskit/qiskit
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add incremental pylint make target (Qiskit#6597)
* Add incremental pylint make target * add tox.ini and fetch/compare to origin/HEAD * commands * opportunistic caching * Add small tool to avoid shell utils * import pylint not sub-process. clean examples * blacken few extra files * just pylint * update contributing.md * tweak error msg, tox.ini * fixup makefile, tox.ini * command line tweaks * add tools to lint-incr target * Update tox.ini * Revert "Update tox.ini" Tox doesn't support globbing so this change wasn't valid that line was commented on purpose. This reverts the previous tox.ini update and adds a comment about the commented line to explain the intent. This reverts commit c33c274. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Matthew Treinish <[email protected]>
- Loading branch information
3 people
authored
Jul 23, 2021
1 parent
fbf389f
commit 105cba3
Showing
4 changed files
with
143 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # This code is part of Qiskit. | ||
| # | ||
| # (C) Copyright IBM 2017, 2018. | ||
| # | ||
| # This code is licensed under the Apache License, Version 2.0. You may | ||
| # obtain a copy of this license in the LICENSE.txt file in the root directory | ||
| # of this source tree or at http://www.apache.org/licenses/LICENSE-2.0. | ||
| # | ||
| # Any modifications or derivative works of this code must retain this | ||
| # copyright notice, and modified files need to carry a notice indicating | ||
| # that they have been altered from the originals. | ||
|
|
||
| """Run pylint incrementally on only changed files""" | ||
|
|
||
| import subprocess | ||
| import argparse | ||
| import os | ||
| import sys | ||
|
|
||
| from pylint import lint | ||
|
|
||
| ROOT_DIR = os.path.dirname(os.path.abspath(__file__)) | ||
|
|
||
|
|
||
| def _minimal_ext_cmd(cmd): | ||
| # construct minimal environment | ||
| env = {} | ||
| for k in ["SYSTEMROOT", "PATH"]: | ||
| v = os.environ.get(k) | ||
| if v is not None: | ||
| env[k] = v | ||
| # LANGUAGE is used on win32 | ||
| env["LANGUAGE"] = "C" | ||
| env["LANG"] = "C" | ||
| env["LC_ALL"] = "C" | ||
| with subprocess.Popen( | ||
| cmd, | ||
| stdout=subprocess.PIPE, | ||
| stderr=subprocess.PIPE, | ||
| env=env, | ||
| cwd=os.path.join(os.path.dirname(ROOT_DIR)), | ||
| ) as proc: | ||
| stdout, stderr = proc.communicate() | ||
| return proc.returncode, stdout, stderr | ||
|
|
||
|
|
||
| def _run_pylint(ref, paths, pylint_args): | ||
| code, stdout, stderr = _minimal_ext_cmd( | ||
| [ | ||
| "git", | ||
| "diff-index", | ||
| "--name-only", | ||
| "--diff-filter=d", | ||
| "--merge-base", | ||
| "-z", | ||
| ref, | ||
| "--", | ||
| *paths, | ||
| ] | ||
| ) | ||
| if code != 0: | ||
| print( | ||
| f"{__file__}: unable to get list of changed files. Git returncode: {code}\n" | ||
| f"Git must be installed, and you need to be in a git tree with a ref `{ref}`\n" | ||
| f"{stderr.strip().decode('ascii')}" | ||
| ) | ||
| sys.exit(128) | ||
| changed_paths = [path.decode("ascii") for path in stdout.split(b"\x00") if len(path) > 0] | ||
| if len(changed_paths) == 0: | ||
| print(f"No changed files in {' '.join(paths)}") | ||
| sys.exit(0) | ||
| changed_paths_pretty = "\n ".join(changed_paths) | ||
| print(f"Running pylint on {len(changed_paths)} changed files:\n {changed_paths_pretty}") | ||
| lint.Run([*pylint_args, "--", *changed_paths]) | ||
|
|
||
|
|
||
| def _main(): | ||
| parser = argparse.ArgumentParser( | ||
| description="Incremental pylint.", | ||
| epilog="Unknown arguments passed through to pylint", | ||
| allow_abbrev=False, | ||
| ) | ||
| parser.add_argument( | ||
| "--paths", | ||
| required=True, | ||
| type=str, | ||
| nargs="+", | ||
| help="Git <pathspec>s to resolve (and pass any changed files to pylint)", | ||
| ) | ||
| args, pylint_args = parser.parse_known_args() | ||
| _run_pylint("lint_incr_latest", args.paths, pylint_args) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| _main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters