zuul-jobs/roles/ensure-python/README.rst
Clark Boylan 52e84220e5 Make note of python_version being a string value
The type of the python_version variable matters when we interpret it
after yaml deserialization. If it is interpreted as a float then 3.1 ==
3.10 and those python versions are very different. Instead make note
that it should be a string and then update all of the tox jobs to set
this variable as a string.

Change-Id: I55bbc70526a13e6bd4c3c32da8590ad2af76fe7c
2022-05-16 09:16:35 -07:00

46 lines
1.4 KiB
ReStructuredText

Ensure specified python interpreter and development files are installed
There are three ways to install the python interpreter:
1. Using distribution packages: This is the default (``python_use_pyenv`` and
``python_use_stow`` are both ``false``).
2. Install using ``pyenv``.
3. Install using ``stow``.
.. note:: You cannot use both ``pyenv`` and ``stow`` method for the same job.
That means that ``python_use_pyenv`` and ``python_use_stow``
cannot be set both to ``True`` at the same time.
**Role Variables**
.. zuul:rolevar:: python_version
:type: str
Optional version of python interpreter to install, such as ``3.7``.
Note that you should use a string value for this variable rather than
a float. This avoids problems with 3.10 being evaluated as 3.1.
.. zuul:rolevar:: python_use_pyenv
:type: bool
:default: False
Whether to optionally use ``pyenv`` to install python instead of distro
packages.
.. zuul:rolevar:: python_use_stow
:type: bool
:default: False
In case you have image with already prepared python versions, for example used the
python-stow-versions element, you can activate them with stow utility
by setting this variable to ``true``.
.. zuul:rolevar:: python_stow_dir
:type: str
:default: /usr/local/stow
Sets the target directory for stow. This should be the path to the
directory where prepared python packages are located.