Tweag case study: From adopting Pants, to generalizing our CI to multiple Python versions
At Tweag we have a lot of experience with Bazel, as we maintain the Haskell rules. However, I had feedback that Bazel's Python support was not ideal. In contrast, Python is Pants' strong point. My client's fear of boilerplate also made Bazel unappealing. Whereas, Pants reduces boilerplate…
I’m a principal engineer at Tweag, a consultancy company offering expertise in robust build systems, functional programming, and data science. In Spring 2022 I was put in charge of setting up the monorepo of a healthcare startup: kaiko.ai. Kaiko was dedicated to starting its development with a monorepo from nearly day 0, as the CTO wanted to spread best practices and great CI support to all projects and developers. This project culminated in adopting Pants in our setup. In this post I want to detail our journey:
- How we came to choose Pants as our scalable build tool for this monorepo,
- How we proceeded to adopt Pants smoothly, and
- How we generalized our existing Pants CI to support multiple Python versions.
Motivating Pants in a healthcare startup
Kaiko’s monorepo is hosted on GitHub. To deliver a working repository as fast as possible, I initially made its CI modular by using GitHub Actions paths triggers. Concretely, a library living in
libs/A had a
paths trigger of the form
libs/A/** in its CI pipeline. While this was an easy way to start, it did not scale very well: everytime a library was added, its trigger needed to be written manually. Even worse, as the dependency graph between libraries was complexifying, the triggers had to be adapted accordingly: if
libs/B depends on
libs/A, the trigger of
B’s CI must be both
So, a few months after the monorepo’s initial version, people started to worry about the CI’s level of boilerplate. In addition, a number of triggers had been erroneous a number of times already: we had evidence manual maintenance was too error prone to be sustainable in the long term.
At this point I did a quick tour of the build tools available for monorepos:
1. At Tweag we have had a lot of experience with Bazel, as we maintain the Haskell rules and work for various clients in other languages. However I had feedback that the Python support with Bazel was not ideal. In contrast, Python is Pants' strong point.
2. Kaiko’s fear of boilerplate did not make Bazel appealing. Whereas the reduced boilerplate offered by Pants was very attractive.
3. Kaiko already had a developer internally advocating for Pants.
Pants was the strongest candidate for the monorepo.
Initial adoption of Pants
At this point, I listed the tools in use in Kaiko’s monorepo. It was pretty standard: black, flake8, isort, shellcheck, bandit, etc. All these tools were supported already in Pants, but two weren’t: yamllint and Microsoft’s pyright Python typechecker. Pants’ not supporting pyright was a potential blocker for Kaiko, as it was used in their regular CI already, and also locally by developers. Pyright’s ability to report errors as you type was a big plus over mypy, so we didn’t want to switch. This is how I first came in touch with Pants’ community: I opened an issue on Pant’s GitHub to ask whether pyright support could be added.
In a matter of hours, I was blown away by the responsiveness of the community as the issue’s comments show, as well as the discussions on Pant’s Slack. Suresh Joshi rolled out a proof of concept of pyright integration within Pants in a matter of days and he then iterated to improve it, based on feedback from me trying his code on our production use case. This caused a streak of issues to be created (here is one, here is another) and this fast feedback loop contributed to Kaiko committing to using Pants, even if, at this point, pyright support is not yet mature enough to support our production use case. But we are confident it will be the case soon!
The second tool that we needed support for in Pants is yamllint. At Tweag, we seized this occasion to evaluate how easy it was to write plugins in Pants and created our pants-yamllint-poc repository. While there is a bit of boilerplate when writing plugins, we deemed it acceptable, and we could get away by taking inspiration from shellcheck’s plugin. After having validated our proof of concept in production, we opened a PR to have yamllint support merged into Pants. We received helpful feedback on the PR to move it forward.
To adopt Pants serenely, I proposed internally that we bring our new Pants CI on par with the features of our regular CI. One nice feature of our regular CI is that it was parameterized with a matrix to use multiple versions of Python. In the rest of this post, I will describe how I brought this feature to our Pants CI.
Using multiple Python versions
One strong argument for using Pants was the quality of the documentation. However, when looking at the documentation for using multiple interpreters in Python, I was at first puzzled that the doc indicated how to declare multiple interpreters but not how the multiple interpreters are actually used to (spoiler alert: the doc is getting updated regarding this)! This is why, after having added
interpreter_constraints=parametrize(py38=["==3.8.*"], py39=["==3.9.*"]) to one
python_sources declaration, I tried to reproduce my regular CI setup with Pants, using a matrix with one Python version available in each instance of the matrix, and restricting targets to the running interpreter with
What a fool I was! After having asked for helped on Pants’ #general Slack channel, I realized that the interpreter used to run Pants is independent from the interpreters that Pants uses for executing targets. This simplified the CI setup, because I could get rid of the matrix and simply install all required Python versions in a single job, which is straightforward because the GitHub
setup-python action can be used multiple times in a single job.
Pants’ documentation gives its
interpreter_constraints example on a
python_sources declaration, which is the first thing I tried. However, having multiple Python versions in
python_sources is contaminating, because many targets depend on
python_sources. For example
python_distribution depends on
python_distribution doesn’t support multiple interpreters: it requires specifying an exact version. Generalizing
python_sources hence proved creating noise in
BUILD files, for little advantages.
A simpler way to proceed was to put
python_tests declarations. This is less intrusive because
python_tests declarations typically do not have other targets depending on them. Tests are also the first thing you usually want to generalize, because they are obviously sensitive to different Python versions. Typechecking is another such target, but I wasn’t able to try generalizing it yet, since we are waiting for pyright support to be production ready, as explained above.
Finally, to support multiple Python versions, you need to generalize the
interpreter_constraints declaration in the top-level
pants.toml file. When you change this declaration, you typically need to regenerate lockfiles with
./pants generate-lockfiles, because lockfiles are affected by the possible Python version. While doing so, I encountered two issues which were quickly solved by discussing on Pants’ Slack:
- Despite having regenerated its lockfile, black was failing with:
InvalidLockfileError: You are using the lockfile at pants-utils/3rdparty/python/black_lockfile.lock to install the tool black, but it is not compatible with your configuration.This proved to be caused by Pants sometimes picking up a default
interpreter_constraintsinstead of the global one declared in pants.toml. Copying the
interpreter_constraintsdeclaration of the
[python]section to the
[black]section solved the problem.
- When generalizing to use both Python 3.8 and Python 3.9, I had written
interpreter_constraintsin the form
["==3.8.*", "==3.9.*"]. However I was facing error messages of the form
Expected a single interpreter constraint for libs/kaiko:kaiko-lib-dist, got: CPython!=3.9.*,==3.8.* OR CPython!=3.9.*,==3.9.*.At this point I was puzzled since the conjunction to the right is unsatisfiable and I expected it would be eliminated automatically. However, it turned out that my
interpreter_constraintswas better written
[">=3.8,<3.10"]. Albeit equivalent to the previous one, this one is better supported. My initial
["==3.8.*", "==3.9.*"]constraint uses a historical disjunction that dates back to Pants v1 and is now legacy. Better avoid it.
My overall impression of introducing Pants to my client is very positive. Because day-to-day developers were sensitive to limiting boilerplate, Pants was easily accepted. For authors and maintainers of the CI, Pants greatly simplified the existing pipelines, by avoiding the need for matrices, and by avoiding manual triggers for scaling (we use Pants’
–changed-since feature for having the CI scale).
The fast feedback loop with Pants’ developers as well as helpful support on Slack also made for a great journey. Thanks everyone for your support! ❤️