-
Notifications
You must be signed in to change notification settings - Fork 37
Document cross-project Python support policy #200
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
booxter
wants to merge
1
commit into
instructlab:main
Choose a base branch
from
booxter:python-version-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -125,6 +125,7 @@ LLMs | |
llms | ||
LLVM | ||
lora | ||
LTS | ||
Makefiles | ||
Markdownlint | ||
Martinoli | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Python Version Support | ||
|
||
This document describes the project Python version support policy. | ||
|
||
## Goals | ||
|
||
1. Ensure that the project is compatible with latest Python releases. | ||
2. Ensure that the project is compatible with the latest Python LTS releases. | ||
3. Ensure reasonable choice of Python versions for users to choose from. | ||
4. Ensure that CI and engineering resources are not wasted on supporting | ||
outdated Python versions. | ||
|
||
## Approach | ||
|
||
### Minimal Python version | ||
|
||
The minimal Python version to support in all projects is determined based on | ||
the availability of Python versions in popular operating systems (Fedora, | ||
Debian, MacOS) and products built on top of the packages (RHEL AI). | ||
|
||
At the moment of writing, the minimal Python version that all projects should | ||
support is 3.11. | ||
|
||
### Support multiple Python versions | ||
|
||
To accommodate users that are not willing to upgrade to the latest Python | ||
version, projects should strive to support several (upstream Python | ||
versions)[https://devguide.python.org/versions/] in some capacity. At the very | ||
least, all projects should run lightweight tests (unit, functional) against all | ||
versions from the minimal supported version up to the latest version. | ||
|
||
At the moment of writing, the versions to support are: 3.11, 3.12, 3.13. | ||
|
||
### Dominant Python version | ||
|
||
To concentrate resources on the most used Python version, the project should | ||
pick one Python version that will be used to run all CI jobs. Other Python | ||
versions may be supported in a more limited capacity (e.g. only running unit | ||
tests). | ||
|
||
In general, there's a single dominant Python version at any given time. During | ||
adoption of a new dominant version, the project may have to temporarily support | ||
two dominant versions at the same time. This is a temporary situation and plans | ||
should be made to get back to the single dominant version as soon as possible, | ||
to avoid wasting resources. | ||
|
||
At the moment of writing, the dominant Python version is 3.11. | ||
|
||
### Drop support for old Python versions | ||
|
||
To avoid wasting resources on supporting outdated Python versions, projects | ||
should proactively drop support for old versions below the minimal Python | ||
version indicated above. | ||
|
||
To drop support for a Python version, projects should remove all tests that are | ||
specific to this version. They should also update `pyproject.yaml` metadata to | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have found https://pypi.org/project/check-python-versions/ to be helpful for listing this sort of thing to ensure packaging data and test jobs are consistent. |
||
specify the minimal Python version equal to the one indicated above. | ||
Documentation should be updated to reflect the new minimal version, if needed. | ||
|
||
At the moment of writing, the versions to drop support for are: 3.10 or | ||
earlier. | ||
|
||
## Links | ||
|
||
- [Upstream status of Python versions](https://devguide.python.org/versions/) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can merge this this way, but we're going to want to very quickly make it 3.12.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was the plan and I wanted to split concerns - documentation of general approach using status quo and bumping versions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That definitely makes sense. 👍🏼