Merge upstream/main and regenerate lockfiles with tensorflow-docs

Author: rosspeili

.github/workflows/ci.yaml

@@ -223,7 +223,7 @@ jobs:
       - name: Run pytest
         run: |
           echo '::add-matcher::.github/problem-matchers/pytest.json'
-          check/pytest -m "not slow"
+          check/pytest -n auto -m "not slow"
 
   pytest-extra:
     if: needs.changes.outputs.python == 'true'
@@ -258,7 +258,7 @@ jobs:
       - name: Run pytest
         run: |
           echo '::add-matcher::.github/problem-matchers/pytest.json'
-          check/pytest -m "not slow" src/openfermion/resource_estimates
+          check/pytest -n auto -m "not slow" src/openfermion/resource_estimates
 
   pytest-compat:
     if: needs.changes.outputs.python == 'true'
@@ -287,7 +287,7 @@ jobs:
       - name: Run pytest
         run: |
           echo '::add-matcher::.github/problem-matchers/pytest.json'
-          check/pytest -m "not slow"
+          check/pytest -n auto -m "not slow"
 
   coverage:
     if: needs.changes.outputs.python == 'true'

.github/workflows/scorecard-scanner.yaml

@@ -70,7 +70,7 @@ jobs:
 
       - name: Upload results to code-scanning dashboard
         # yamllint disable rule:line-length
-        uses: github/codeql-action/upload-sarif@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4.35.2
+        uses: github/codeql-action/upload-sarif@e46ed2cbd01164d986452f91f178727624ae40d7 # v4.35.3
         with:
           sarif_file: scorecard-results.sarif
 

dev_tools/conf/.pylintrc .pylintrcdev_tools/conf/.pylintrc renamed to .pylintrc

@@ -19,9 +19,7 @@
 
 [MAIN]
 
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
+# Analyse import fallback blocks.
 analyse-fallback-blocks=no
 
 # Clear in-memory caches upon conclusion of linting. Useful if running pylint
@@ -1027,4 +1025,4 @@ init-import=yes
 
 # List of qualified module names which can have objects that can redefine
 # builtins.
-redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
+redefining-builtins-modules=builtins,io

CONTRIBUTING.md

@@ -74,8 +74,6 @@ This project follows Google coding conventions, with a few changes that are most
 configuration files at the top level of the source tree and in `dev_tools/conf/`. The following
 files configure various tools to the project conventions:
 
-*   `dev_tools/conf/.pylintrc`: Python code
-
 *   `.editorconfig`: basic code editor configuration
 
 *   `.hadolint.yaml`: Dockerfiles
@@ -84,6 +82,10 @@ files configure various tools to the project conventions:
 
 *   `.markdownlintrc`: Markdown files
 
+*   `.pylintrc`: Python file lint
+
+*   `.pyproject.toml`: Python tools other than Pylint
+
 *   `.yamllint.yaml`: YAML files
 
 #### Code comment conventions
@@ -210,16 +212,6 @@ pre-commit run --all-files
 
 After that, the hooks will run automatically when triggered by the corresponding git operations.
 
-### Type annotation conventions
-
-Code should have [type annotations](https://www.python.org/dev/peps/pep-0484/). We use
-[mypy](http://mypy-lang.org/) to check that type annotations are correct, and the following script
-to run it:
-
-```shell
-check/mypy
-```
-
 ### Python setup
 
 1.  Create a Python virtual environment. To use Python's built-in `venv` package, run:
@@ -239,6 +231,20 @@ check/mypy
 Please refer to the section _Developer install_ of the [installation instructions](docs/install.md)
 for information about how to set up a local copy of the software for development.
 
+### Type annotation conventions
+
+Code should have [type annotations](https://www.python.org/dev/peps/pep-0484/). We use
+[mypy](http://mypy-lang.org/) to check that type annotations are correct, and the following script
+to run it:
+
+```shell
+check/mypy
+```
+
+If your computer has multiple processor cores, you can add the option `-j 0` to the command above to
+make Mypy run in parallel for a substantial speed increase.
+
+
 ### Linting and formatting
 
 Code should meet common style standards for Python and be free of error-prone constructs. We use
@@ -280,9 +286,11 @@ We use [pytest](https://docs.pytest.org) to run our tests and
 [pytest-cov](https://pytest-cov.readthedocs.io) to compute coverage.
 
 *   While developing, periodically check that changes do not break anything. For fast checks, use
-    `pytest -c dev_tools/conf/pytest.ini PATH`, where `PATH` is a directory or pytest file to test.
+    `pytest -m "not slow" PATH`, where `PATH` is a directory or pytest file to test.
 
-*   After finishing a task, run `check/pytest` to test all of the OpenFermion code.
+*   After finishing a task, run `check/pytest` to test all of the OpenFermion code. If your system
+    has multiple processor cores, you can add the option `-n auto` to make it run in parallel for a
+    substantial speed increase. (Beware, though, that this is resource-intensive.)
 
 We don't require 100% coverage, but coverage should be very high, and any uncovered code must be
 annotated with `# pragma: no cover`. To ignore coverage of a single line, place `# pragma: no cover`
@@ -294,9 +302,9 @@ cover` comment on its own line. Note, however, that these annotations should be
 After a task is finished, run each of the following to make sure everything passes all the tests:
 
 *   `check/format-incremental`
-*   `check/pylint`
+*   `check/pylint -j 0`
 *   `check/mypy`
-*   `check/pytest`
+*   `check/pytest -n auto`
 *   `check/pytest-and-incremental-coverage`
 
 ### Pull requests and code reviews

check/pylint

@@ -14,7 +14,7 @@
 # limitations under the License.
 
 ################################################################################
-# Runs pylint on the repository using a preconfigured .pylintrc file.
+# Runs pylint from the top level of the project.
 #
 # Usage:
 #     check/pylint [--flags]
@@ -24,4 +24,4 @@
 cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" || exit 1
 cd "$(git rev-parse --show-toplevel)" || exit 1
 
-pylint --rcfile=dev_tools/conf/.pylintrc "$@" src dev_tools
+pylint "$@" src dev_tools

check/pylint-changed-files

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Summary: run pylint on changed files using a preconfigured .pylintrc file.
+# Summary: run pylint on changed files from the top level of the project.
 #
 # Usage:
 #     check/pylint-changed-files [BASE_REVISION]
@@ -81,4 +81,4 @@ echo "Found ${num_changed} lintable files associated with changes." >&2
 if [ "${num_changed}" -eq 0 ]; then
     exit 0
 fi
-env PYTHONPATH=dev_tools pylint --jobs=0 --rcfile=dev_tools/conf/.pylintrc "${changed[@]}"
+env PYTHONPATH=dev_tools pylint --jobs=0 "${changed[@]}"

check/pytest

@@ -43,11 +43,10 @@ for arg in "$@"; do
 done
 
 if [ -z "${ACTUALLY_QUIET}" ]; then
-    pytest -c dev_tools/conf/pytest.ini --rootdir="$rootdir" "${PYTEST_ARGS[@]}"
+    pytest --rootdir="$rootdir" "${PYTEST_ARGS[@]}"
 else
     # Filter out lines like "...F....x...      [ 42%]", with coloring.
-    pytest -c dev_tools/conf/pytest.ini \
-           --rootdir="$rootdir" -q --color=yes "${PYTEST_ARGS[@]}" | \
+    pytest --rootdir="$rootdir" -q --color=yes "${PYTEST_ARGS[@]}" | \
         grep -Ev '^(\x1B\[0m)?[\.FEsx]+(\x1B\[36m)?[[:space:]]+\[[[:space:]]*[0-9]+%\](\x1B\[0m)?$'
     exit "${PIPESTATUS[0]}"
 fi

check/pytest-and-incremental-coverage

@@ -68,6 +68,7 @@ fi
 
 # Run tests while producing coverage files.
 check/pytest . \
+    -n auto \
     --actually-quiet \
     --cov \
     --cov-report=annotate

dev_tools/conf/pytest.ini

@@ -1,6 +1,7 @@
 pytest
 pytest-asyncio
 pytest-cov
+pytest-randomly
 pytest-retry
 pytest-xdist