pex_binary
A Python target that can be converted into an executable PEX file.
PEX files are self-contained executable files that contain a complete Python environment capable of running the target. For more information, see https://www.pantsbuild.org/docs/pex-files.
Backend: ``
always_write_cache
bool | NoneFalseWhether PEX should always write the .deps cache of the .pex file to disk or not. This can use less memory in RAM constrained environments.
dependencies
Iterable[str] | NoneNoneAddresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib']. Alternatively, you may include file names. Pants will find which target owns that file, and create a new target from that which only includes the file in its sources field. For files relative to the current BUILD file, prefix with ./; otherwise, put the full path, e.g. ['./sibling.txt', 'resources/demo.json']. You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.
description
str | NoneNoneA human-readable description of the target. Use ./pants list --documented :: to see all targets with descriptions.
emit_warnings
bool | NoneNoneWhether or not to emit PEX warnings at runtime. The default is determined by the option emit_warnings in the [pex-binary-defaults] scope.
entry_point
str | NoneNoneThe entry point for the binary. If omitted, Pants will use the module name from the sources field, e.g. project/app.py will become the entry point project.app .
ignore_errors
bool | NoneFalseShould we ignore when PEX cannot resolve dependencies?
inherit_path
'fallback' | 'false' | 'prefer' | NoneNoneWhether to inherit the sys.path of the environment that the binary runs in. Use false to not inherit sys.path; use fallback to inherit sys.path after packaged dependencies; and use prefer to inherit sys.path before packaged dependencies.
interpreter_constraints
Iterable[str] | NoneNoneThe Python interpreters this code is compatible with. Each element should be written in pip-style format, e.g. 'CPython==2.7._' or 'CPython>=3.6,<4'. You can leave off CPython as a shorthand, e.g. '>=2.7' will be expanded to 'CPython>=2.7'. Specify more than one element to OR the constraints, e.g. ['PyPy==3.7._', 'CPython==3.7.\*']means either PyPy 3.7 or CPython 3.7. If the field is not set, it will default to the option[python-setup].interpreter_constraints]. See https://www.pantsbuild.org/docs/python-interpreter-compatibility.
output_path
str | NoneNoneWhere the built asset should be located. If undefined, this will use the path to the the BUILD, followed by the target name. For example, src/python/project:app would be src.python.project/app.ext. When running ./pants package, this path will be prefixed by --distdir (e.g. dist/). Warning: setting this value risks naming collisions with other package targets you may have.
platforms
Iterable[str] | NoneNoneThe platforms the built PEX should be compatible with. This defaults to the current platform, but can be overridden to different platforms. You can give a list of multiple platforms to create a multiplatform PEX. To use wheels for specific interpreter/platform tags, you can append them to the platform with hyphens like: PLATFORM-IMPL-PYVER-ABI (e.g. "linux_x86_64-cp-27-cp27mu", "macosx_10.12_x86_64-cp-36-cp36m"). PLATFORM is the host platform e.g. "linux-x86_64", "macosx-10.12-x86_64", etc". IMPL is the Python implementation abbreviation (e.g. "cp", "pp", "jp"). PYVER is a two-digit string representing the python version (e.g. "27", "36"). ABI is the ABI tag (e.g. "cp36m", "cp27mu", "abi3", "none").
shebang
str | NoneNoneSet the generated PEX to use this shebang, rather than the default of PEX choosing a shebang based on the interpreter constraints. This influences the behavior of running ./result.pex. You can ignore the shebang by instead running /path/to/python_interpreter ./result.pex.
sources
Iterable[str] | NoneNoneA single file containing the executable, such as ['app.py']. You can leave this off if you include the executable file in one of this target's dependencies and explicitly set this target's entry_point. This must have 0 or 1 files, but no more. If you depend on more files, put them in a python_library target and include that target in the dependencies field.
tags
Iterable[str] | NoneNoneArbitrary strings that you can use to describe a target. For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tags='integration_test' test :: to only run on targets with that tag.
zip_safe
bool | NoneTrueWhether or not this binary is safe to run in compacted (zip-file) form. If the PEX is not zip safe, it will be written to disk prior to execution. You may need to mark zip_safe=False if you're having issues loading your code.