Launchpad pip integration¶
Launchpad uses the pip build system for managing Python packages (replacing zc.buildout, which we used for many years).
Developers who manage source dependencies probably should read the general information about Managing Dependencies and Scripts, but will also find detailed instructions to Add a Package, to Upgrade a Package, to Add a Script, and to Work with Unreleased or Forked Packages.
If you use the
rocketfuel-get script, run that, and you will be done.
If you don’t, you have just a bit more initial set up. I’ll assume you
maintain a pattern similar to what the
rocketfuel-* scripts use: you have a
local, pristine branch of trunk from which you make your other branches. You
manually update the trunk and rsync sourcecode when necessary. When you make
a branch, you use
Developers that take this approach should do the following, where
the trunk branch from which you make local branches.
git clone --depth=1 lp:lp-source-dependencies download-cache
make in the trunk.
See the Everyday Usage: Manual section for further instructions on how to
work without the
If you typically use
rocketfuel-get, and you don’t change source
dependencies, then you don’t need to know any more. Switching between
ordinary git branches will do the right thing; if you’re using worktrees,
then you can use
If you don’t use the rocketfuel scripts, you will still use
link-external-dependencies as before. When
pip complains that it
cannot find a version of a dependency, do the following, from within the
git -C download-cache pull
After this, retry your
That’s it for everyday usage.
Managing Dependencies and Scripts¶
What if you need to change or add dependencies or scripts? As you might expect, you need to know a bit more about what’s going on, although we can still keep this at a fairly high level.
First let’s talk a little about the anatomy of what we have set up. To be clear, much of this is based on our own decisions of what to do. If you see something problematic, bring it up with other Launchpad developers. Maybe together we can come up with another approach that meets our needs better.
These are the items in or near the top-level Launchpad directory associated with pip:
These are the files that use
distutils, extended by
setuptools, to specify direct dependencies, scripts, and other elements of the local source tree.
pip uses them, but the reverse is not true:
setup.cfgdo not know about pip.
Describing these files in full is well beyond the scope of this document. We will give recipes for modifying them for certain tasks below. For more information beyond these recipes, see the setuptools and distutils documentation.
This is a copy of the dependency versions file published by the Zope Toolkit. It is preprocessed into a pip-compatible form by
This is a requirements file used to upgrade pip itself to a reasonably recent version and install a few other packages that must be installed before installing anything else. We use this so that we aren’t confined to features of pip supported by the version supplied by the operating system.
This is a constraints file that specifies the precise versions of the dependencies we use, in addition to those specified in
requirements/setup.txt. This means that we can have several versions of a dependency available locally, but we only build the precise one we specify. We give an example of its use below.
envdirectory holds a virtualenv built from the downloaded distributions. You have one of these per branch (virtualenvs do not relocate especially well). This directory is local to your system–we do not manage it in a branch.
download-cachedirectory is a set of downloaded distributions–that is, exact copies of the items that would typically be obtained from the Python Package Index (“PyPI”), or another download source. We manage the download cache as a shared resource across all of our developers with a git branch in a Launchpad project called
We run pip with the
--find-linksoptions, which cause it to not use network access to find packages, but only look in the download cache. This has many advantages.
First, it helps us keep our deployment boxes from needing network access out to PyPI and other download sites.
Second, it makes the build much faster, because it does not have to look out on the net for every dependency.
Third, it makes the build more repeatable, because we are more insulated from outages at download sites such as PyPI, and poor release management.
Fourth, it makes our deployments more auditable, because we can tell exactly what we are deploying.
Fifth, it gives us a single obvious place to put custom package distributions, as we’ll discuss below.
The downside is that adding and upgrading packages takes a small additional step, as we’ll see below.
In addition to these directory entries, after you have run the Makefile, you will see an additional entry:
bindirectory has already been discussed many times. After running the build, it also holds many executables, including scripts to test Launchpad; to run it; to run Python or IPython with Launchpad’s sourcetree and dependencies available; to run harness or iharness (with IPython) with the sourcetree, dependencies, and database connections; or to perform several other tasks. For now, the Makefile provides aliases for many of these.
Now that you have an introduction to the pertinent files and directories, we’ll move on to trying to perform maintenance tasks. We’ll discuss adding a dependency, upgrading a dependency, adding a script, adding an arbitrary file, and working with unreleased packages.
Add a Package¶
Let’s suppose that we want to add the “lazr.foo” package as a dependency.
Add the new package to the
setup.cfgfile in the
Generally, our policy is to only set minimum version numbers in this file, or none at all. It doesn’t really matter for an application like Launchpad, but it’s a good rule for library packages, so we follow it for consistency. Therefore, we might simply add
'lazr.foo'to install_requires, or
'lazr.foo>=1.1'if we know that we are depending on features introduced in version 1.1 of lazr.foo.
[OPTIONAL] Add the desired package to the
You should only need to do this if the package is one that doesn’t exist on PyPI at all (which should be unusual). Otherwise, it’s less error-prone to fetch the desired package from PyPI along with any new dependencies it may have.
Run the following command (or your variation):
bin/pip install --no-binary :all: lazr.foo
This will either produce some errors which you’ll need to fix, or it will succeed and finish with a line such as this:
Successfully installed lazr-foo-1.1.2 z3c.shazam-2.0.1 zope.bar-3.6.1
You can use requirements specifiers on this command line, so, for instance, if you already know you want lazr.foo 1.1.2, you might run this command instead:
bin/pip install --no-binary :all: lazr.foo==1.1.2
Add the successfully-installed packages to the shared download cache for future use.
- bin/pip download -d download-cache/dist/ –no-deps
–no-binary :all: …
You’ll need to copy the list of packages from the “Successfully installed” line above, replacing the
-immediately before each version number with
==to turn each package/version pair into a requirements specifier. So, in the case above, you would run:
- bin/pip download -d download-cache/dist/ –no-deps
–no-binary :all: lazr-foo==1.1.2 z3c.shazam==2.0.1 zope.bar==3.6.1
This will normally be able to fetch package files that were saved to your
pipcache directory (
~/.cache/pip/by default) by
pip install, so it shouldn’t need to download them from PyPI again.
pip installhas already done the hard work of resolving dependencies and told us the result, and because
pip downloaddoesn’t consider what’s currently installed and so is liable to download too much otherwise.
Add the new versions to
requirements/launchpad.txt, still using the requirements specifier syntax:
lazr.foo==1.1.2 z3c.shazam==2.0.1 zope.bar==3.6.1
make. If it breaks, go back to step 3.
Check old versions in the download-cache. If you are sure that they are not in use any more, anywhere, then remove them to save checkout space. More explicitly, check with the LOSAs to see if they are in use in production and send an email to firstname.lastname@example.org before deleting anything if you are unsure. A rule of thumb is that it’s worth starting this investigation if the replacement has already been in use by the Launchpad tree for more than a month. You can approximate this information by using
git logon the newer (replacement) download-cache/dist file for the particular package.
Now you need to share your package changes with the rest of the team. You must do this before submitting your Launchpad branch to PQM or else your branch will not build properly anywhere else, including buildbot. Commit the changes (
cd download-cache, git add the needed files,
git commit -m 'Add lazr.foo 1.1.2 and dependencies') to the shared download cache when you are sure it is what you want.
Never modify a package in the download-cache. A change in code must mean a change in version number, or else very bad inconsistencies and confusion across build environments will happen.
Upgrade a Package¶
Sometimes you need to upgrade a dependency. This may require additional dependency additions or upgrades. In general, this works just like adding a new package, so follow the Add a Package instructions above.
If you know what version you want, specify it explicitly on the
If you don’t know what version you want, but just want to see what happens
when you upgrade to the most recent version, then omit the version and
--upgrade option to
pip install. Note that, when not
given an explicit version number, pip prefers final releases over alpha and
beta releases. If you want to temporarily override this behaviour, use the
--pre option to
Add a Script¶
We often need scripts that are run in a certain environment defined by Python dependencies, and sometimes even different Python executables. Several of the scripts we have are specified using setuptools.
For the common case, in
setup.cfg, add a string in the
console_scripts list under
[options.entry_points]. Here’s an example
'run = lp.scripts.runlaunchpad:start_launchpad'
This will create a script named
run in the
bin directory that calls the
start_launchpad function in the
Work with Unreleased or Forked Packages¶
Sometimes you need to work with unreleased or forked packages. Hopefully, these situations will be rare, but they do occur.
At the moment, our solution is to use the download-cache. Basically, make a custom source distribution with a unique suffix in the name, and use it (and its version name) for the normal process of adding or updating a package, as described above. Because the custom package is in the download-cache, it will be found and used.
In general, the suffix should comply with PEP 440; in the case of a
forked package, you should use
lp as a local version identifier. For
example, you might start by appending
+lp1, followed by
+lp2 and so
on for further revisions.
Developing a Dependent Library In Parallel¶
Sometimes you need to iterate on change to a library used by Launchpad that
is managed by pip. You could just edit what is in the
but it is harder to produce a patch while doing this. You could instead
grab a branch of the library and produce an sdist every time you make a
change and make pip use the new sdist, but this is slow.
Instead, we can use “editable mode” so that changes are picked up instantly without us having to create a distribution. For example:
bin/pip install -e /path/to/branch
Now any changes you make in that path will be picked up, and you are free to make the changes you need and test them in the Launchpad environment.
Once you are finished you can produce a distribution as above for inclusion in to Launchpad, as well as sending your patch upstream. At that point you are free to revert the configuration to only develop Launchpad. Make sure to test with the final distribution before submitting your branch.
Possible Future Goals¶
No longer use make.
Get rid of the sourcecode directory.