Google Git
Sign in
fuchsia / third_party / github.com / google / subpar / 35bb9f0092f71ea56b742a520602da9b3638a24f
commit35bb9f0092f71ea56b742a520602da9b3638a24f[log] [tgz]
authorJon Brandvein <brandjon@google.com>Tue May 14 15:59:21 2019 -0400
committerGitHub <noreply@github.com>Tue May 14 15:59:21 2019 -0400
tree310c6ed44ae1aa65fc69b161161712604259649b
parent5b0f501356b86f16da5aac25bc2069e25e74b67d [diff]
Add note on bazel version compatibility to WORKSPACE (#107)

This will be useful to keep up-to-date for documentation purposes, and so we
know when a release cut breaks compatibility with Bazel and therefore needs to
be a major release.
1 file changed
tree: 310c6ed44ae1aa65fc69b161161712604259649b
  1. .ci/
  2. compiler/
  3. docs/
  4. runtime/
  5. scripts/
  6. test_dir_shadowing/
  7. tests/
  8. third_party/
  9. .bazelrc
  10. .flake8
  11. .gitignore
  12. .travis.yml
  13. __init__.py
  14. BUILD
  15. CONTRIBUTING.md
  16. debug.bzl
  17. LICENSE
  18. nox.py
  19. README.md
  20. run_tests.sh
  21. subpar.bzl
  22. toolchain_test_hook.bzl
  23. update_docs.sh
  24. WORKSPACE
README.md

Subpar

Build Status

Subpar is a utility for creating self-contained python executables. It is designed to work well with Bazel.

Setup

  • Add the following to your WORKSPACE file:
git_repository(
    name = "subpar",
    remote = "https://github.com/google/subpar",
    tag = "1.0.0",
)
  • Add the following to the top of any BUILD files that declare par_binary() rules:
load("@subpar//:subpar.bzl", "par_binary")

Usage

par_binary() is a drop-in replacement for py_binary() in your BUILD files that also builds a self-contained, single-file executable for the application, with a .par file extension.

To build the .par file associated with a par_binary(name=myname) rule, do

bazel build //my/package:myname.par

The .par file is created alongside the python stub and .runfiles directories that py_binary() creates, but is independent of them. It can be copied to other directories or machines, and executed directly without needing the .runfiles directory. The body of the .par file contains all the srcs, deps, and data files listed.

Limitations:

  • C extension modules in ‘deps’ is not yet supported
  • Automatic re-extraction of ‘.runfiles’ is not yet supported
  • Does not include a copy of the Python interpreter (‘hermetic .par’)

Example

Given a BUILD file with the following:

load("@subpar//:subpar.bzl", "par_binary")

par_binary(
    name = 'foo',
    srcs = ['foo.py', 'bar.py'],
    deps = ['//baz:some_py_lib'],
    data = ['quux.dat'],
)

Run the following build command:

bazel build //package:foo.par

This results in the following files being created by bazel build:

bazel-bin/
    package/
        foo
        foo.par
        foo.runfiles/
            ...

The .par file can be copied, moved, or renamed, and still run like a compiled executable file:

$ scp bazel-bin/package/foo.par my-other-machine:foo.par
$ ssh my-other-machine ./foo.par

System Requirements

  • Python Versions: CPython versions 2.7.6+
  • Operating Systems: Debian-derived Linux, including Ubuntu and Goobuntu.

DISCLAIMER

This is not an official Google product, it is just code that happens to be owned by Google.