Gate Jenkins mypy on py.typed marker (#159)

Author: stevebachmeier

libs/build-utils/CHANGELOG.rst

@@ -1,3 +1,9 @@
+**4.1.0 - 06/29/26**
+
+- Run mypy in CI based on the presence of a ``py.typed`` marker under ``src/``
+- Centralize py.typed marker logic in a new ``mypy-if-typed`` Make target 
+- Deprecate the ``run_mypy`` ``reusable_pipeline`` argument; it is still accepted but ignored
+
 **4.0.2 - 06/24/26**
 
 - Add ``--runslow`` and ``--runweekly`` support to pytest calls so that Jenkins builds pass

libs/build-utils/resources/makefiles/base.mk

@@ -188,6 +188,14 @@ lint: # Check for formatting errors
 mypy: # Check for type hinting errors
 	mypy --config-file pyproject.toml .
 
+.PHONY: mypy-if-typed
+mypy-if-typed: # Run mypy only if a py.typed marker exists under src/
+	@if find src -name py.typed 2>/dev/null | grep -q .; then \
+		make mypy; \
+	else \
+		echo "No py.typed marker found under src/; skipping mypy."; \
+	fi
+
 # test: test targets are defined in test.mk
 
 .PHONY: build-docs
@@ -253,15 +261,9 @@ clean: # Clean build artifacts and temporary files
 .PHONY: check
 check: # Run development checks
 	make lint
-# 	Run mypy if any py.typed marker exists under src/
-# 	Use 'find' command rather than a hardcoded src/$(PACKAGE_NAME)/py.typed path so
-#	this works for both flat layouts (src/<pkg>/py.typed) and namespace layouts under
-#	monorepo (src/vivarium/<pkg>/py.typed).
-	@if find src -name py.typed 2>/dev/null | grep -q .; then \
-		echo; \
-		echo "Running mypy"; \
-		make mypy; \
-	fi
+# 	Run mypy if any py.typed marker exists under src/ (see mypy-if-typed)
+	@echo
+	make mypy-if-typed
 # 	Run all fast tests
 	@echo
 	@echo "Running fast tests"

libs/build-utils/vars/build_stages.groovy

@@ -118,14 +118,12 @@ def installPackage(String env_reqs = "") {
     }
 }
 
-def checkFormatting(Boolean run_mypy) {
+def checkFormatting() {
     stage("Check Formatting - Python ${PYTHON_VERSION}") {
         withWorkingDirectory {
             script {
                 sh "${ACTIVATE} && make lint"
-                if (run_mypy == true) {
-                    sh "${ACTIVATE} && make mypy"
-                }
+                sh "${ACTIVATE} && make mypy-if-typed"
             }
         }
     }

libs/build-utils/vars/reusable_pipeline.groovy

@@ -10,7 +10,9 @@ def call(Map config = [:]){
   requires_slurm: Whether the child tasks require the slurm scheduler.
   deployable: Whether the package can be deployed by Jenkins.
   skip_doc_build: Only skips the doc build.
-  run_mypy: Whether to run mypy on the package
+  run_mypy: DEPRECATED and ignored. mypy now runs automatically whenever a
+            py.typed marker exists under the package's src/ (matching `make check`
+            and GH Actions).
   env_reqs: The pyproject.toml extras to install with `make install` (e.g. "ci_jenkins").
             Empty/omitted leaves base.mk's default ("dev"), which is correct for standalone repos.
   github_credentials_id: Jenkins credential ID to use during the deploy stage when pushing
@@ -37,7 +39,12 @@ def call(Map config = [:]){
   def requires_slurm = config.requires_slurm ?: false
   def is_deployable = (config?.deployable == true)
   def skip_doc_build = (config?.skip_doc_build == true)
-  def run_mypy = (config.run_mypy != null) ? config.run_mypy : true
+  // DEPRECATED: run_mypy no longer controls anything. mypy runs in checkFormatting
+  // whenever a py.typed marker exists under src/. Accepted for backward compatibility.
+  if (config.run_mypy != null) {
+    echo "WARNING: 'run_mypy' is deprecated and ignored; mypy now runs automatically " +
+         "when a py.typed marker exists under src/."
+  }
   // Empty string leaves base.mk's default ("dev") in effect. installPackage in
   // build_stages.groovy only sets ENV_REQS=... when this is non-empty.
   def env_reqs = config.env_reqs ?: ""
@@ -59,7 +66,6 @@ def call(Map config = [:]){
   echo "  requires_slurm: ${requires_slurm}"
   echo "  is_deployable: ${is_deployable}"
   echo "  skip_doc_build: ${skip_doc_build}"
-  echo "  run_mypy: ${run_mypy}"
   echo "  env_reqs: ${env_reqs}"
 
   if (stagger_scheduled_builds && scheduled_branches.size() > 1) {
@@ -259,7 +265,7 @@ def call(Map config = [:]){
                         buildStages.runDebugInfo(skipEval)
                         buildStages.buildEnvironment()
                         buildStages.installPackage(env_reqs)
-                        buildStages.checkFormatting(run_mypy)
+                        buildStages.checkFormatting()
                         // Transform test type inputs to actual make test target names
                         tests = test_types.collect { "test-${it}" }
                         buildStages.runTests(tests, run_weekly)

libs/compat/Jenkinsfile

@@ -30,6 +30,5 @@ library("vivarium_build_utils@${get_vbu_version()}")
 reusable_pipeline(
     scheduled_branches: ['main'],
     skip_doc_build: true,
-    run_mypy: false,
     env_reqs: 'ci_jenkins',
 )

libs/gbd-mapping/Jenkinsfile

@@ -35,5 +35,4 @@ reusable_pipeline(
         "main"
     ],
     env_reqs: "ci_jenkins",
-    run_mypy: false,
 )

libs/gbd-mapping/pyproject.toml

@@ -66,12 +66,10 @@ git_describe_command = 'git describe --dirty --tags --long --match "vivarium-gbd
 fallback_version = "0.0.0+no-git-tag"
 
 # No [tool.mypy] section: this package is only partially typed and the
-# gbd_mapping module is largely auto-generated. CI's `make mypy` is skipped
-# when py.typed is absent (see .github/workflows/ci.yml); Jenkinsfile sets
-# `run_mypy: false` to match. When the codebase is fully annotated, add a
+# gbd_mapping module is largely auto-generated. CI skips mypy when no py.typed
+# marker exists under src/. When the codebase is fully annotated, add a
 # py.typed marker plus the standard [tool.mypy] block (see
-# libs/config-tree/pyproject.toml for the template) and flip Jenkins
-# `run_mypy` back to true.
+# libs/config-tree/pyproject.toml for the template) to enable mypy everywhere.
 
 [tool.black]
 line-length = 94

libs/profiling/Jenkinsfile

@@ -30,6 +30,5 @@ library("vivarium_build_utils@${get_vbu_version()}")
 reusable_pipeline(
     scheduled_branches: ["main"],
     skip_doc_build: true,
-    run_mypy: false,
     env_reqs: "ci_jenkins",
 )

libs/public-health/Jenkinsfile

@@ -34,6 +34,5 @@ reusable_pipeline(
         // for subsequent scheduled builds to run.
         "main",
     ],
-    run_mypy: false,
     env_reqs: "ci_jenkins",
 )

libs/risk-distributions/Jenkinsfile

@@ -35,5 +35,4 @@ reusable_pipeline(
         "main"
     ],
     env_reqs: "ci_jenkins",
-    run_mypy: false,
 )