Merge branch 'main' into mh-revised-fix-481

Author: mhucka

.gitignore

@@ -67,6 +67,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
+*,cover
 .hypothesis/
 
 # Sphinx documentation

check/all

@@ -0,0 +1,116 @@
+#!/usr/bin/env bash
+#
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script is modeled in part on Cirq's check/all script.
+
+declare -r usage="\
+Usage: ${0##*/} [--help] [--only-changed-files] [--apply-format-changes] [BASE_REV]
+
+If the first argument given on the command line is the option --help or -h,
+this program prints usage information and then exits.
+
+With no arguments, this runs multiple checks on the code base. These tests
+are based on the programs in the checks/ subdirectory.
+
+If --apply-format-changes is specified, the flag --apply will be passed to
+check/format-incremental to apply the format changes suggested by the
+formatter.
+
+You can specify a base git revision to compare against (i.e., to use when
+determining whether or not a file is considered to have changed). If given,
+the argument BASE_REV is passed on to tests that can use it, such as
+check/pytest-and-incremental-coverage."
+
+set -eo pipefail -o errtrace
+shopt -s inherit_errexit
+
+# Get the working directory to the repo root.
+thisdir=$(dirname "${BASH_SOURCE[0]:?}")
+repo_dir=$(git -C "${thisdir}" rev-parse --show-toplevel)
+cd "${repo_dir}"
+
+function error() {
+    echo >&2 "ERROR: ${*}"
+}
+
+# ~~~~ Parse the CLI arguments and gather some data ~~~~
+
+declare -a rev=()
+declare -a apply_arg=()
+declare only_changed=""
+for arg in "$@"; do
+    case "${arg}" in
+        -h | --help)
+            echo "${usage}"
+            exit 0
+            ;;
+        --apply-format-changes)
+            apply_arg=( "--apply" )
+            shift
+            ;;
+        --only-changed-files)
+            only_changed="true"
+            shift
+            ;;
+        -*)
+            error "Invalid option '${arg}'"
+            error "See '$0 --help' for the list of supported options."
+            exit 1
+            ;;
+        *)
+            if ! rev=( "$(git rev-parse --verify --end-of-options "${arg}^{commit}")" ); then
+                error "No revision '${arg}'"
+                exit 1
+            fi
+            ;;
+    esac
+done
+
+# ~~~~ Run the tests ~~~~
+
+declare -a errors=()
+
+function run() {
+    echo "Running $* ..."
+    "$@" || errors+=( "$* failed" )
+    echo
+}
+
+if [[ -n "${only_changed}" ]]; then
+    run check/format-incremental "${rev[@]}" "${apply_arg[@]}"
+    run check/pylint-changed-files "${rev[@]}"
+else
+    run check/format-incremental "${rev[@]}" "${apply_arg[@]}" --all
+    run check/pylint "${rev[@]}"
+fi
+run check/mypy
+run check/pytest-and-incremental-coverage "${rev[@]}"
+run check/shellcheck
+
+# ~~~~ Summarize the results and exit with a status code ~~~~
+
+declare exit_code=0
+echo
+echo "Done."
+if [[ "${#errors[@]}" == 0 ]]; then
+    echo "All checks passed."
+else
+    error "Some checks failed."
+    printf "  %s\n" "${errors[@]}"
+    exit_code=1
+fi
+
+exit "${exit_code}"

check/shellcheck

@@ -54,10 +54,13 @@ IFS=$'\n' read -r -d "" -a our_shell_scripts < <(
 declare -a required_shell_scripts
 required_shell_scripts=(
     # items below must be sorted
+    check/all
     check/format-incremental
     check/mypy
     check/pylint
+    check/pylint-changed-files
     check/pytest
+    check/pytest-and-incremental-coverage
 )
 
 scripts_not_found=$(comm -13 \

dev_tools/env_tools.py

@@ -40,8 +40,9 @@ def get_unhidden_ungenerated_python_files(directory: str) -> Iterable[str]:
                 yield os.path.join(dirpath, filename)
 
 
-def create_virtual_env(venv_path: str, requirements_paths: Iterable[str],
-                       python_path: str, verbose: bool) -> None:
+def create_virtual_env(
+    venv_path: str, requirements_paths: Iterable[str], python_path: str, verbose: bool
+) -> None:
     """Creates a new virtual environment and then installs dependencies.
 
     Args:
@@ -50,30 +51,24 @@ def create_virtual_env(venv_path: str, requirements_paths: Iterable[str],
         python_path: The python binary to use.
         verbose: When set, more progress output is produced.
     """
-    shell_tools.run_cmd('virtualenv',
-                        None if verbose else '--quiet',
-                        '-p',
-                        python_path,
-                        venv_path,
-                        out=sys.stderr)
+    shell_tools.run_cmd(
+        'virtualenv', None if verbose else '--quiet', '-p', python_path, venv_path, out=sys.stderr
+    )
     pip_path = os.path.join(venv_path, 'bin', 'pip')
     for req_path in requirements_paths:
-        shell_tools.run_cmd(pip_path,
-                            'install',
-                            None if verbose else '--quiet',
-                            '-r',
-                            req_path,
-                            out=sys.stderr)
+        shell_tools.run_cmd(
+            pip_path, 'install', None if verbose else '--quiet', '-r', req_path, out=sys.stderr
+        )
 
 
 def prepare_temporary_test_environment(
-        destination_directory: str,
-        repository: GithubRepository,
-        pull_request_number: Optional[int],
-        verbose: bool,
-        env_name: str = '.test_virtualenv',
-        python_path: str = sys.executable,
-        commit_ids_known_callback: Callable[[PreparedEnv], None] = None
+    destination_directory: str,
+    repository: GithubRepository,
+    pull_request_number: Optional[int],
+    verbose: bool,
+    env_name: str = '.test_virtualenv',
+    python_path: str = sys.executable,
+    commit_ids_known_callback: Callable[[PreparedEnv], None] = None,
 ) -> PreparedEnv:
     """Prepares a temporary test environment at the (existing empty) directory.
 
@@ -101,10 +96,12 @@ def prepare_temporary_test_environment(
             destination_directory=destination_directory,
             repository=repository,
             pull_request_number=pull_request_number,
-            verbose=verbose)
+            verbose=verbose,
+        )
     else:
         env = git_env_tools.fetch_local_files(
-            destination_directory=destination_directory, verbose=verbose)
+            destination_directory=destination_directory, verbose=verbose
+        )
 
     if commit_ids_known_callback is not None:
         commit_ids_known_callback(env)
@@ -113,18 +110,19 @@ def prepare_temporary_test_environment(
     base_path = cast(str, env.destination_directory)
     env_path = os.path.join(base_path, env_name)
     req_path = os.path.join(base_path, 'tutorial-requirements.txt')
-    dev_req_path = os.path.join(base_path, 'dev_tools', 'conf',
-                                'pip-list-dev-tools.txt')
-    contrib_req_path = os.path.join(base_path, 'cirq', 'contrib',
-                                    'contrib-tutorial-requirements.txt')
+    dev_req_path = os.path.join(base_path, 'dev_tools', 'conf', 'pip-list-dev-tools.txt')
+    contrib_req_path = os.path.join(
+        base_path, 'cirq', 'contrib', 'contrib-tutorial-requirements.txt'
+    )
     rev_paths = [req_path, dev_req_path, contrib_req_path]
-    create_virtual_env(venv_path=env_path,
-                       python_path=python_path,
-                       requirements_paths=rev_paths,
-                       verbose=verbose)
-
-    return PreparedEnv(github_repo=env.repository,
-                       actual_commit_id=env.actual_commit_id,
-                       compare_commit_id=env.compare_commit_id,
-                       destination_directory=env.destination_directory,
-                       virtual_env_path=env_path)
+    create_virtual_env(
+        venv_path=env_path, python_path=python_path, requirements_paths=rev_paths, verbose=verbose
+    )
+
+    return PreparedEnv(
+        github_repo=env.repository,
+        actual_commit_id=env.actual_commit_id,
+        compare_commit_id=env.compare_commit_id,
+        destination_directory=env.destination_directory,
+        virtual_env_path=env_path,
+    )

dev_tools/github_repository.py

@@ -18,8 +18,7 @@
 class GithubRepository:
     """Details how to access a repository on github."""
 
-    def __init__(self, organization: str, name: str,
-                 access_token: Optional[str]) -> None:
+    def __init__(self, organization: str, name: str, access_token: Optional[str]) -> None:
         """
         Args:
             organization: The github organization the repository is under.