Add CI checks for mypy and pylint

.github/workflows/mypy.yml

@@ -0,0 +1,19 @@
+name: Type Check
+
+on: [push, pull_request]
+
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v1
+        with:
+          python-version: '3.8'
+          architecture: 'x64'
+      - name: Install mypy
+        run: |
+          python -m pip install --upgrade pip
+          pip install mypy
+      - name: Type check
+        run: dev_tools/mypy || true

.github/workflows/pylint.yml

@@ -0,0 +1,19 @@
+name: Pylint
+
+on: [push, pull_request]
+
+jobs:
+  pylint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v1
+        with:
+          python-version: '3.8'
+          architecture: 'x64'
+      - name: Install Pylint
+        run: |
+          python -m pip install --upgrade pip
+          pip install pylint
+      - name: Pylint check
+        run: dev_tools/pylint

dev_tools/.pylintrc

@@ -0,0 +1,73 @@
+[MASTER]
+load-plugins=pylint.extensions.docstyle,pylint.extensions.docparams,pylint_copyright_checker
+max-line-length=100
+disable=all
+#ignore-paths=cirq-google/cirq_google/cloud/.*
+ignore-patterns=.*_pb2\.py
+output-format=colorized
+score=no
+reports=no
+enable=
+    anomalous-backslash-in-string,
+    assert-on-tuple,
+    bad-indentation,
+    bad-option-value,
+    bad-reversed-sequence,
+    bad-super-call,
+    consider-merging-isinstance,
+    continue-in-finally,
+    dangerous-default-value,
+    docstyle,
+    duplicate-argument-name,
+    expression-not-assigned,
+    function-redefined,
+    inconsistent-mro,
+    init-is-generator,
+    line-too-long,
+    lost-exception,
+    missing-kwoa,
+    missing-param-doc,
+    missing-raises-doc,
+    mixed-line-endings,
+    no-value-for-parameter,
+    nonexistent-operator,
+    not-in-loop,
+    pointless-statement,
+    redefined-builtin,
+    return-arg-in-generator,
+    return-in-init,
+    return-outside-function,
+    simplifiable-if-statement,
+    singleton-comparison,
+    syntax-error,
+    too-many-function-args,
+    trailing-whitespace,
+    undefined-variable,
+    unexpected-keyword-arg,
+    unhashable-dict-key,
+    unnecessary-pass,
+    unreachable,
+    unrecognized-inline-option,
+    unused-import,
+    unnecessary-semicolon,
+    unused-variable,
+    unused-wildcard-import,
+    wildcard-import,
+    wrong-import-order,
+    wrong-import-position,
+    yield-outside-function
+
+# Ignore long lines containing urls or pylint directives.
+ignore-long-lines=^(.*#\w*pylint: disable.*|\s*(# )?[<\[\(]?https?://\S+[>\]\)]?)$
+
+[TYPECHECK]
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=numpy.*
+
+
+#[IMPORTS]
+# Force import order to recognize a module as part of a third party library.
+#known-third-party=cirq,cirq_google,cirq_aqt,cirq_ionq

dev_tools/mypy

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+################################################################################
+# Runs mypy on the repository using a preconfigured mypy.ini file.
+#
+# Usage:
+#     check/mypy [--flags]
+################################################################################
+
+# Get the working directory to the repo root.
+cd "$(dirname "${BASH_SOURCE[0]}")"
+cd "$(git rev-parse --show-toplevel)"
+
+
+echo -e -n "\033[31m"
+mypy --config-file=dev_tools/mypy.ini "$@" .
+result=$?
+echo -e -n "\033[0m"
+
+exit ${result}

dev_tools/mypy.ini

@@ -0,0 +1,27 @@
+[mypy]
+show_error_codes = true
+
+[mypy-__main__]
+follow_imports = silent
+ignore_missing_imports = true
+
+# 3rd-party libs for which we don't have stubs
+[mypy-apiclient.*,freezegun.*,matplotlib.*,mpl_toolkits,multiprocessing.dummy,oauth2client.*,pandas.*,proto.*,pytest.*,scipy.*,sortedcontainers.*,setuptools.*,pylatex.*,networkx.*,qiskit.*,pypandoc.*,ply.*,_pytest.*,google.api.*,google.api_core.*,grpc.*,google.auth.*,google.oauth2.*,google.protobuf.text_format.*,quimb.*,pyquil.*,google.cloud.*,filelock.*,codeowners.*,tqdm.*,importlib_metadata.*,google.colab.*,IPython.*,astroid.*,pylint.*,cirq.*,flask.*,numpy.*,cirq_google.*]
+follow_imports = silent
+ignore_missing_imports = true
+
+# There was no type information before numpy 1.20, so there are numpy mypy issues in the codebase
+[mypy-numpy.*]
+follow_imports = skip
+follow_imports_for_stubs = true
+
+# Treat symbols imported from Google's protobuf library as type Any.
+# This supresses errors due to attributes not known to typeshed,
+# e.g. Descriptor._options.
+[mypy-google.protobuf.*]
+follow_imports = skip
+follow_imports_for_stubs = true
+
+# ruamel is a downstream dependency of cirq-rigetti through pyquil.
+[mypy-ruamel.*]
+ignore_missing_imports = true

dev_tools/pylint

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+################################################################################
+# Runs pylint on the repository using a preconfigured .pylintrc file.
+#
+# Usage:
+#     check/pylint [--flags for pylint]
+################################################################################
+
+# Get the working directory to the repo root.
+cd "$(dirname "${BASH_SOURCE[0]}")"
+cd "$(git rev-parse --show-toplevel)"
+
+# Add dev_tools to $PYTHONPATH so that pylint can find custom checkers
+env PYTHONPATH=dev_tools pylint --jobs=0 --rcfile=dev_tools/.pylintrc "$@" .

requirements.txt

@@ -4,5 +4,12 @@ cirq-google>=0.14.0
 
 seaborn
 sphinx
+
+# dev tools
 ipython
 black
+mypy
+pylint
+pytest
+pytest-cov
+coverage<=6.2