Skip to main content
Version: 2.14 (deprecated)

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
pants.toml
[pyoxidizer]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

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

Advanced options​

console_script​

--pyoxidizer-console-script=<str>
PANTS_PYOXIDIZER_CONSOLE_SCRIPT
pants.toml
[pyoxidizer]
console_script = <str>
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
pants.toml
[pyoxidizer]
entry_point = <str>
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.

extra_requirements​

--pyoxidizer-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYOXIDIZER_EXTRA_REQUIREMENTS
pants.toml
[pyoxidizer]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
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
pants.toml
[pyoxidizer]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.8,<4"
]

Python interpreter constraints for this tool.

lockfile​

--pyoxidizer-lockfile=<str>
PANTS_PYOXIDIZER_LOCKFILE
pants.toml
[pyoxidizer]
lockfile = <str>
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.2/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 /home/josh/work/scie-pants/dist/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.

version​

--pyoxidizer-version=<str>
PANTS_PYOXIDIZER_VERSION
pants.toml
[pyoxidizer]
version = <str>
default: pyoxidizer==0.18.0

Requirement string for the tool.

Deprecated options​

None

None