ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-03-22 13:19:13 +00:00
Code Activity

Format uv_python documentation using andebox

Browse source
This commit is contained in:
Mariam Ahhttouche 2026-03-06 14:44:11 +00:00
parent 22147bd913
commit 2475c57cbf
1 changed files with 19 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

45
plugins/modules/uv_python.py
View file

@ -5,7 +5,6 @@
DOCUMENTATION = r"""
---
module: uv_python
short_description: Manage Python versions and installations using uv Python package manager
description:
@ -27,37 +26,31 @@ options:
version:
description:
- Python version to manage.
- |
Not all canonical Python versions are supported in this release. Valid version numbers consist of two or three dot-separated numeric components,
with an optional 'pre-release' tag on the end such as V(3.12), V(3.12.3), V(3.15.0a5).
- "Not all canonical Python versions are supported in this release. Valid version numbers consist of two or three dot-separated
numeric components,\nwith an optional 'pre-release' tag at the end such as V(3.12), V(3.12.3), V(3.15.0a5)."
- Advanced uv selectors such as V(>=3.12,<3.13) or V(cpython@3.12) are not supported in this release.
- |
When you specify only a major.minor version, make sure the number is enclosed in quotes so that it gets parsed correctly.
Note that in this case behavior depends on the O(state) parameter.
- "When you specify only a major.minor version, make sure the number is enclosed in quotes so that it gets parsed correctly.\n\
Note that in case only a major.minor version are specified behavior depends on the O(state) parameter."
type: str
required: true
state:
description:
- Desired state of the specified Python version.
- |
V(present) ensures the specified version is installed.
If you specify a full patch version (for example O(version=3.12.3)), that exact version will be installed if not already present.
If you only specify a minor version (for example V(3.12)), the latest available patch version for that minor release is installed only
if no patch version for that minor release is currently installed (including patch versions not managed by C(uv)).
RV(python_versions) and RV(python_paths) lengths are always equal to one for this state.
- |
V(absent) ensures the specified version is removed.
If you specify a full patch version, only that exact patch version is removed.
If you only specify a minor version (for example V(3.12)), all installed patch versions for that minor release are removed.
If you specify a version that is not installed, no changes are made.
RV(python_versions) and RV(python_paths) lengths can be higher or equal to one in this state.
- |
V(latest) ensures the latest available patch version for the specified version is installed.
If you only specify a minor version (for example V(3.12)), the latest available patch version for that minor release is always installed.
If another patch version is already installed but is not the latest, the latest patch version is installed.
The latest patch version installed depends on the C(uv) version, since available Python versions are frozen per C(uv) release.
RV(python_versions) and RV(python_paths) lengths are always equal to one in this state.
This state does not use C(uv python upgrade).
- "V(present) ensures the specified version is installed.\nIf you specify a full patch version (for example O(version=3.12.3)),
that exact version is be installed if not already present.\nIf you only specify a minor version (for example V(3.12)),
the latest available patch version for that minor release is installed only\nif no patch version for that minor release
is currently installed (including patch versions not managed by C(uv)).\nRV(python_versions) and RV(python_paths)
lengths are always equal to one for this state."
- "V(absent) ensures the specified version is removed.\nIf you specify a full patch version, only that exact patch version
is removed.\nIf you only specify a minor version (for example V(3.12)), all installed patch versions for that minor
release are removed.\nIf you specify a version that is not installed, no changes are made.\nRV(python_versions) and
RV(python_paths) lengths can be higher or equal to one in this state."
- "V(latest) ensures the latest available patch version for the specified version is installed.\nIf you only specify
a minor version (for example V(3.12)), the latest available patch version for that minor release is always installed.\n\
If another patch version is already installed but is not the latest, the latest patch version is installed.\nThe latest
patch version installed depends on the C(uv) version, since available Python versions are frozen per C(uv) release.\n\
RV(python_versions) and RV(python_paths) lengths are always equal to one in this state.\nThis state does not use C(uv
python upgrade)."
type: str
choices: [present, absent, latest]
default: present