Please basics

If you're familiar with Blaze / Bazel, Buck or Pants you will probably find Please very familiar. Otherwise, don't worry, it's not very complicated...

BUILD files

Please targets are defined in files named BUILD. These are analogous to Makefiles in that they define buildable targets for that directory. Fortunately, they do so in a rather nicer syntax.
We refer to a directory containing a BUILD file as a package.

Build targets

Each BUILD file can contain a number of build targets. These are units of buildable code which can be reused by other build targets. An example is probably worth 1000 words at this point:


	  python_library(
	      name = 'my_library',
	      srcs = ['file1.py', 'file2.py'],
	  )

	  python_binary(
	      name = 'my_binary',
	      main = 'my_main.py',
	      deps = [':my_library'],
	  )

	  python_test(
	      name = 'my_library_test',
	      srcs = ['my_library_test.py'],
	      deps = [':my_library'],
	  )
      
This snippet defines three build rules:
  • my_library is simply a collection of file1.py and file2.py.
    For some languages these might be compiled, for Python of course they're simply made available for other rules.
  • my_binary creates a deployable Python binary with an entry point in my_main.py.
    It also defines a dependency on my_library since it will use it internally.
  • my_library_test defines a test on my_library. Tests are run by Please and their results are aggregated.
This illustrates the core points of Please; every rule clearly defines its inputs - its own sources and its dependencies - and since these are known Please can be aggressive about parallelising, caching and reusing build artifacts.

Okay, great, so how do I actually use them?

Let's assume the build rules given above are defined in a file in your repo named package/BUILD. You can do the following:

  • plz build //package:my_library builds the library. This isn't drastically useful on its own, of course...
  • plz build //package:my_binary builds the binary and all needed libraries that it depends on. That produces a single output file which you could copy to another machine.
  • plz run //package:my_binary builds and runs the binary immediately.
  • plz test //package:my_library_test builds and runs the test and shows you the results.

Build labels

That brings us to the topic of build labels, which are identifiers of build targets. As you've just seen, these are of the form //package:target, where package is the path from the repo root to that package, and target is the name of the target within that package.
This is the most common form to identify targets absolutely, but there is also a convenient shorthand where we omit the part before the colon (as you saw earlier as well) to refer to a target within the current package.

The convention is to use lower_case_with_underscores for both package names and target names.
This is not just for looks; in many languages (eg. Python) the file path appears within the source files, and so it's important to choose something that's a valid lexical identifier.

There are also some special pseudo-labels:

  • //mypackage:all refers to all targets in 'mypackage'.
  • //mypackage/... refers to all targets in 'mypackage' and anywhere beneath it in the filesystem.
Build targets can't use these as dependencies; these are primarily for using on the command line or in the visibility specification for a target.

What now?

Jump in and get started! See the please lexicon if you want to see the set of built-in build rules for other languages.

If that all sounds a bit easy so far, try the intermediate topics and start learning how to program the system and create your own build rules.