What are the plans for --build-option?

[lrq3000]

--build-option and --global-option are going to be removed in pip 23.3 and already deprecated as of pip 23.1. This is not surprising given pip is a frontend, and these are specific flags for setuptools.

But what are setuptools plans with these for the long term? Are they going to be kept or are they going to get deprecated at some point?

[abravalheri]

Hi @lrq3000, you should be able to have somewhat backwards compatible approach with pip's --config-settings or build's --config-setting (or simply -C).

Please note however that these "config settings" will be passed to all steps in the build process according to PEP 517 (which includes the sdist). If you want to pass wheel or sdist specific parameters, maybe you could consider using build. Please see an example below:

cd /tmp
mkdir -p myproj/src/mypkg
cd myproj
touch src/mypkg/__init__.py
touch src/mypkg/api.py
touch src/mypkg/cli.py
cat <<EOF >pyproject.toml
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"
EOF
python3 -m venv .venv
.venv/bin/python3 -m pip install -U pip build
.venv/bin/python -m build --wheel "-C--global-option=--verbose --no-user-cfg" "-C--build-option=--build-number 1b --compression deflated"
# ...
# Successfully built mypkg-0.0.0-1b-py3-none-any.whl
.venv/bin/python -m pip install dist/mypkg-0.0.0-1b-py3-none-any.whl
# ...
# Successfully installed mypkg-0.0.0