Set up typechecking in this repo. (#22)

benjyw · web-flow · commit 44d3a05ae473 · 2023-09-05T23:00:51.000-04:00
diff --git a/.github/workflows/pants.yaml b/.github/workflows/pants.yaml
@@ -58,9 +58,9 @@ jobs:
         pants --version
     - name: Check BUILD files
       run: pants tailor --check update-build-files --check '::'
-    - name: Lint and test
+    - name: Lint, typecheck and test
       run: |
-        pants lint test ::
+        pants lint check test ::
     - name: Upload Pants log
       uses: actions/upload-artifact@v3
       with:
diff --git a/3rdparty/python/default.lock b/3rdparty/python/default.lock
@@ -4,14 +4,19 @@
 //
 // --- BEGIN PANTS LOCKFILE METADATA: DO NOT EDIT OR REMOVE ---
 // {
-//   "version": 2,
+//   "version": 3,
 //   "valid_for_interpreter_constraints": [
 //     "CPython<3.11,>=3.8"
 //   ],
 //   "generated_with_requirements": [
 //     "protobuf==3.20.1",
-//     "thrift==0.15.0"
-//   ]
+//     "thrift==0.15.0",
+//     "types-protobuf==3.20.1"
+//   ],
+//   "manylinux": "manylinux2014",
+//   "requirement_constraints": [],
+//   "only_binary": [],
+//   "no_binary": []
 // }
 // --- END PANTS LOCKFILE METADATA ---
 
@@ -31,11 +36,6 @@
               "hash": "adfc6cf69c7f8c50fd24c793964eef18f0ac321315439d94945820612849c388",
               "url": "https://files.pythonhosted.org/packages/ef/c8/2e7f7feaf804b7206e6cc8fa3f0f49834a78f7cb127813d2c45e42d5f7bf/protobuf-3.20.1-py2.py3-none-any.whl"
             },
-            {
-              "algorithm": "sha256",
-              "hash": "7e371f10abe57cee5021797126c93479f59fccc9693dafd6bd5633ab67808a91",
-              "url": "https://files.pythonhosted.org/packages/00/f6/061b2d6ae57c458dbd37df4edb667872f65001a124a7023cd7bced76c09a/protobuf-3.20.1-cp39-cp39-win_amd64.whl"
-            },
             {
               "algorithm": "sha256",
               "hash": "6f50601512a3d23625d8a85b1638d914a0970f17920ff39cec63aaef80a93fb7",
@@ -46,11 +46,6 @@
               "hash": "adc31566d027f45efe3f44eeb5b1f329da43891634d61c75a5944e9be6dd42c9",
               "url": "https://files.pythonhosted.org/packages/19/96/1283259c25bc48a6df98fa096f66fc568b40137b93806ef5ff66a2d166b1/protobuf-3.20.1.tar.gz"
             },
-            {
-              "algorithm": "sha256",
-              "hash": "dd5789b2948ca702c17027c84c2accb552fc30f4622a98ab5c51fcfe8c50d3e7",
-              "url": "https://files.pythonhosted.org/packages/3c/59/b0ac614cdb5e73d3a7171e3de8d9cf933cc76068305b13ac9351c9985835/protobuf-3.20.1-cp38-cp38-win32.whl"
-            },
             {
               "algorithm": "sha256",
               "hash": "cd68be2559e2a3b84f517fb029ee611546f7812b1fdd0aa2ecc9bc6ec0e4fdde",
@@ -66,16 +61,6 @@
               "hash": "cb29edb9eab15742d791e1025dd7b6a8f6fcb53802ad2f6e3adcb102051063ab",
               "url": "https://files.pythonhosted.org/packages/7b/4b/12c4959e2065a567acb6c632cfbf97cd12e0e5a48d3d267cb034249588bb/protobuf-3.20.1-cp38-cp38-manylinux2014_aarch64.whl"
             },
-            {
-              "algorithm": "sha256",
-              "hash": "9016d01c91e8e625141d24ec1b20fed584703e527d28512aa8c8707f105a683c",
-              "url": "https://files.pythonhosted.org/packages/89/1a/b4d72e1d7134ffac2156d1dfc3b9ddb21d1664ff392e1e5fe2882a117f81/protobuf-3.20.1-cp310-cp310-win32.whl"
-            },
-            {
-              "algorithm": "sha256",
-              "hash": "db977c4ca738dd9ce508557d4fce0f5aebd105e158c725beec86feb1f6bc20d8",
-              "url": "https://files.pythonhosted.org/packages/8f/cd/d2a90e55397acae08363e26db3a1bbd6674c16a891ab8ee033b44e59af09/protobuf-3.20.1-cp39-cp39-win32.whl"
-            },
             {
               "algorithm": "sha256",
               "hash": "7403941f6d0992d40161aa8bb23e12575637008a5a02283a930addc0508982f9",
@@ -96,20 +81,10 @@
               "hash": "06059eb6953ff01e56a25cd02cca1a9649a75a7e65397b5b9b4e929ed71d10cf",
               "url": "https://files.pythonhosted.org/packages/bf/2a/8924d1fbdf6cec34e9e58ee84b2a8bbdb2b58730c4cfab5a29934977ea6d/protobuf-3.20.1-cp38-cp38-macosx_10_9_x86_64.whl"
             },
-            {
-              "algorithm": "sha256",
-              "hash": "32ca378605b41fd180dfe4e14d3226386d8d1b002ab31c969c366549e66a2bb7",
-              "url": "https://files.pythonhosted.org/packages/c0/9c/bb88091287418ae1cf8af2bb9ed9710748a562b9abc227e4884d687a8650/protobuf-3.20.1-cp310-cp310-win_amd64.whl"
-            },
             {
               "algorithm": "sha256",
               "hash": "69ccfdf3657ba59569c64295b7d51325f91af586f8d5793b734260dfe2e94e2c",
               "url": "https://files.pythonhosted.org/packages/c1/4d/1d46234fbdff4ee05cb7ec6cb6ea9282769fa9fefd72d93de4b85fd3d8c4/protobuf-3.20.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl"
-            },
-            {
-              "algorithm": "sha256",
-              "hash": "77053d28427a29987ca9caf7b72ccafee011257561259faba8dd308fda9a8739",
-              "url": "https://files.pythonhosted.org/packages/e4/5e/381d134b6c9484d6d80dcace24dd3e0cc165d89b800b162fc52b4ac6941a/protobuf-3.20.1-cp38-cp38-win_amd64.whl"
             }
           ],
           "project_name": "protobuf",
@@ -133,7 +108,7 @@
           "project_name": "six",
           "requires_dists": [],
           "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7",
-          "version": "1.16"
+          "version": "1.16.0"
         },
         {
           "artifacts": [
@@ -152,28 +127,48 @@
             "twisted; extra == \"twisted\""
           ],
           "requires_python": null,
-          "version": "0.15"
+          "version": "0.15.0"
+        },
+        {
+          "artifacts": [
+            {
+              "algorithm": "sha256",
+              "hash": "b0bc0ffde2a339ee25c4b47e9dd515010153ad80c21d16fb57a2429987579801",
+              "url": "https://files.pythonhosted.org/packages/94/0f/bc26638706bfc4b3a7b6a0aa0357b66d30ff332cc6c378b8ddc85bc41f9a/types_protobuf-3.20.1-py3-none-any.whl"
+            },
+            {
+              "algorithm": "sha256",
+              "hash": "36e3426476e373da6f2bb8a81a1194478cd1f33813a4e254849146d28c450e00",
+              "url": "https://files.pythonhosted.org/packages/7d/3c/d22e8e1767d1525366970f3013ab1b614ca203d6e5ecfea977b0cf0952e3/types-protobuf-3.20.1.tar.gz"
+            }
+          ],
+          "project_name": "types-protobuf",
+          "requires_dists": [],
+          "requires_python": null,
+          "version": "3.20.1"
         }
       ],
-      "platform_tag": [
-        "cp39",
-        "cp39",
-        "macosx_12_0_arm64"
-      ]
+      "platform_tag": null
     }
   ],
   "path_mappings": {},
-  "pex_version": "2.1.90",
+  "pex_version": "2.1.134",
+  "pip_version": "20.3.4-patched",
   "prefer_older_binary": false,
   "requirements": [
     "protobuf==3.20.1",
-    "thrift==0.15.0"
+    "thrift==0.15.0",
+    "types-protobuf==3.20.1"
   ],
   "requires_python": [
     "<3.11,>=3.8"
   ],
   "resolver_version": "pip-2020-resolver",
   "style": "universal",
+  "target_systems": [
+    "linux",
+    "mac"
+  ],
   "transitive": true,
   "use_pep517": null
 }
diff --git a/3rdparty/python/requirements.txt b/3rdparty/python/requirements.txt
@@ -1,2 +1,3 @@
 protobuf==3.20.1
 thrift==0.15.0
+types-protobuf==3.20.1
diff --git a/mypy.ini b/mypy.ini
@@ -0,0 +1,12 @@
+[mypy]
+
+# The `gen` identifies thrift-generated files, which we don't want to typecheck.
+# Unfortunately this means that mypy may be missing sime type information for the
+# generated Python files, which may cause it to falsely ignore errors in code that
+# uses the generated code.
+#
+# But until Thrift supports mypy in a way similar to protobuf (generating stubs for
+# your code at codegen time, and providing type stubs for the thrift library)
+# this is the best we can do.
+[mypy-*.gen.*]
+ignore_errors = True
diff --git a/pants.toml b/pants.toml
@@ -7,6 +7,7 @@ backend_packages = [
   "pants.backend.experimental.codegen.protobuf.go",
   "pants.backend.experimental.go",
   "pants.backend.python",
+  "pants.backend.python.typecheck.mypy",
 ]
 
 # GOLANG: Remove this line for Go to work. You will also need to have Go installed locally and may
@@ -28,3 +29,6 @@ interpreter_constraints = ["CPython>=3.8,<3.11"]
  # `generate-lockfiles` goal for Pants to generate the lockfile for you, although in some
  # situations you may need to manually generate it, as explained in the docs.
 enable_resolves = true
+
+[python-protobuf]
+mypy_plugin = true
diff --git a/src/protobuf/simple_example/v1/BUILD b/src/protobuf/simple_example/v1/BUILD
@@ -3,4 +3,6 @@ protobuf_sources(
     # so that we do not need to add `__init__.py` files to `src/protobuf`. See
     # https://www.pantsbuild.org/docs/protobuf-python#protobuf-and-source-roots
     python_source_root="src/python",
+    # TODO: Infer this. See https://github.com/pantsbuild/pants/issues/19766.
+    dependencies=["3rdparty/python#types-protobuf"],
 )

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`protobuf==3.20.1`
`2`	`2`	`thrift==0.15.0`
	`3`	`+types-protobuf==3.20.1`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,6 @@ protobuf_sources(`
`3`	`3`	# so that we do not need to add `__init__.py` files to `src/protobuf`. See
`4`	`4`	`# https://www.pantsbuild.org/docs/protobuf-python#protobuf-and-source-roots`
`5`	`5`	`python_source_root="src/python",`
	`6`	`+ # TODO: Infer this. See https://github.com/pantsbuild/pants/issues/19766.`
	`7`	`+ dependencies=["3rdparty/python#types-protobuf"],`
`6`	`8`	`)`