[#10109] fix(docs): update Python version requirements in build and usage documentation#10179
[#10109] fix(docs): update Python version requirements in build and usage documentation#10179yuqi1129 wants to merge 3 commits intoapache:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR is a documentation-only update to correct Python version requirements across two documentation files (docs/how-to-build.md and docs/how-to-use-gvfs.md), addressing issue #10109. It removes Python 3.9 from the supported build versions, sets 3.12 as the new default, and raises the minimum required Python version for GVFS to 3.12.
Changes:
- Remove Python 3.9 from supported build/use versions throughout the documentation
- Update the default Python build version to 3.12 and adjust the supported version list in
how-to-build.md - Raise the minimum required Python version for GVFS to 3.12 in
how-to-use-gvfs.md
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/how-to-build.md |
Removes Python 3.9, sets 3.12 as default, and updates the list of alternative versions |
docs/how-to-use-gvfs.md |
Updates the GVFS minimum Python version requirement from 3.9 to 3.12 |
docs/how-to-build.md
Outdated
| ``` | ||
|
|
||
| Or: | ||
| For the Python client, the `./gradlew build` command builds the Python client with Python 3.12 by default. If you want to use Python 3.10, 3.11, or 3.13 to build, please modify the property `pythonVersion` to 3.10, 3.11, or 3.13 in the `gradle.properties` file, or specify the version with `-P` like: |
There was a problem hiding this comment.
There is an inconsistency in the supported Python versions across this PR:
- Line 16 (Prerequisites section) lists "Python 3.10, 3.11, or 3.12" — Python 3.13 is missing here.
- Line 50 lists "Python 3.10, 3.11, or 3.13" — Python 3.12 appears to be incorrectly replaced with 3.13, since 3.12 is the default and is clearly tested (lines 64-66 show a
3.12example command, and the CI workflow tests 3.12 but not 3.13).
The shell command examples on lines 52–66 still show only 3.10, 3.11, and 3.12 (no 3.13 example), which is inconsistent with the text on line 50 that says 3.13 is an alternative.
Additionally, clients/client-python/setup.py classifiers only enumerate Python 3.10, 3.11, and 3.12 (no 3.13), and the CI workflow .github/workflows/python-integration-test.yml only tests against 3.10, 3.11, and 3.12 — neither source confirms that Python 3.13 is officially supported.
The text on line 50 should likely read "Python 3.10, 3.11, 3.12, or 3.13" (i.e., keep 3.12 and add 3.13 if it is truly supported), or drop the 3.13 reference entirely if it has not been verified. The Prerequisites on line 16 should also be updated to be consistent with whatever the final list is.
| For the Python client, the `./gradlew build` command builds the Python client with Python 3.12 by default. If you want to use Python 3.10, 3.11, or 3.13 to build, please modify the property `pythonVersion` to 3.10, 3.11, or 3.13 in the `gradle.properties` file, or specify the version with `-P` like: | |
| For the Python client, the `./gradlew build` command builds the Python client with Python 3.12 by default. If you want to use Python 3.10, 3.11, or 3.12 to build, please modify the property `pythonVersion` to 3.10, 3.11, or 3.12 in the `gradle.properties` file, or specify the version with `-P` like: |
Code Coverage Report
Files
|
docs/how-to-build.md
Outdated
| + Git | ||
| + A Java Development Kit, version 17, installed in your environment to launch Gradle | ||
| + Python 3.9, 3.10, 3.11, or 3.12 to build the Gravitino Python client | ||
| + Python 3.10, 3.11, 3.12, or 3.13 to build the Gravitino Python client |
There was a problem hiding this comment.
We don't support python 3.13 for now.
What changes were proposed in this pull request?
This pull request updates the documentation to reflect changes in the supported Python versions for building and using the Gravitino Python client and GVFS. The main changes involve raising the minimum required Python version and clarifying the default and supported versions for different components.
Python version requirements and build instructions:
docs/how-to-build.md.docs/how-to-build.md.docs/how-to-use-gvfs.md.Why are the changes needed?
Python 3.9 is not supported any more.
Fix: #10109
Does this PR introduce any user-facing change?
N/A
How was this patch tested?
It's docs.