HomeDocs
DocsCommunityTestimonialsUsersGitHubTwitterBlogJobsTermsPrivacyCookies
TermsPrivacyCookies
Hey! These docs are for version 2.14, which is no longer officially supported. Click here for the latest version, 2.18!

pyoxidizer

The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html).

Used with the pyoxidizer_binary target.

Backend: pants.backend.experimental.python.packaging.pyoxidizer
Config section: [pyoxidizer]

Basic options

args

--pyoxidizer-args="[<shell_str>, <shell_str>, ...]"

PANTS_PYOXIDIZER_ARGS

default: []

Arguments to pass directly to PyOxidizer, e.g. --pyoxidizer-args='--release'.


Advanced options

version

--pyoxidizer-version=<str>

PANTS_PYOXIDIZER_VERSION

default: pyoxidizer==0.18.0

Requirement string for the tool.


extra_requirements

--pyoxidizer-extra-requirements="['<str>', '<str>', ...]"

PANTS_PYOXIDIZER_EXTRA_REQUIREMENTS

default: []

Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.


interpreter_constraints

--pyoxidizer-interpreter-constraints="['<str>', '<str>', ...]"

PANTS_PYOXIDIZER_INTERPRETER_CONSTRAINTS

default:
[
  "CPython>=3.8,<4"
]

Python interpreter constraints for this tool.


lockfile

--pyoxidizer-lockfile=<str>

PANTS_PYOXIDIZER_LOCKFILE

default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version and --extra-requirements options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior). See https://github.com/pantsbuild/pants/blob/release_2.14.2rc2/src/python/pants/backend/python/packaging/pyoxidizer/pyoxidizer.lock for the default lockfile contents.

Set to the string <none> to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds and supply-chain security.

To use a custom lockfile, set this option to a file path relative to the build root, then run ./pants generate-lockfiles --resolve=pyoxidizer.

Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.


console_script

--pyoxidizer-console-script=<str>

PANTS_PYOXIDIZER_CONSOLE_SCRIPT

default: pyoxidizer

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.


entry_point

--pyoxidizer-entry-point=<str>

PANTS_PYOXIDIZER_ENTRY_POINT

default: None

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.


Deprecated options

None