Google Git
Sign in
fuchsia / third_party / github.com / google / subpar / 051d7f66f2f78b0b7d7c929946d371a085caa996
commit051d7f66f2f78b0b7d7c929946d371a085caa996[log] [tgz]
authorDouglas Greiman <dgreiman@google.com>Wed Nov 08 22:37:43 2017 -0800
committerGitHub <noreply@github.com>Wed Nov 08 22:37:43 2017 -0800
treebb74285306c131500357fb11dd17e2da8bf5ab36
parent556adf36b11273385d06e7081e8f14aa988978ed [diff]
Expose package metadata from wheels in .par files (#49)

* Expose package metadata from wheels in .par files

* Update pkg_resources's default distribution metadata object.

`pkg_resources` creates a default WorkingSet as soon as it is
imported, so even though we add hooks for it to find the .dist-info
metadata inside .par files, it is too late.  So we manually update the
default WorkingSet, trying not to disturb existing entries.

* Cut down unnecessary test data.

* Fix lint errors
16 files changed
tree: bb74285306c131500357fb11dd17e2da8bf5ab36
  1. compiler/
  2. docs/
  3. runtime/
  4. scripts/
  5. test_dir_shadowing/
  6. tests/
  7. third_party/
  8. .flake8
  9. .gitignore
  10. .travis.yml
  11. __init__.py
  12. BUILD
  13. CONTRIBUTING.md
  14. debug.bzl
  15. LICENSE
  16. nox.py
  17. README.md
  18. run_tests.sh
  19. subpar.bzl
  20. update_docs.sh
  21. 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.