Skip to content

build(clp-package): Increase minimum Python version from 3.8 to 3.9 as Python 3.8 has reached end-of-life.#1076

Merged
kirkrodrigues merged 9 commits into
y-scope:mainfrom
quinntaylormitchell:docs-python-update
Jul 10, 2025
Merged

build(clp-package): Increase minimum Python version from 3.8 to 3.9 as Python 3.8 has reached end-of-life.#1076
kirkrodrigues merged 9 commits into
y-scope:mainfrom
quinntaylormitchell:docs-python-update

Conversation

@quinntaylormitchell

@quinntaylormitchell quinntaylormitchell commented Jul 7, 2025

Copy link
Copy Markdown
Collaborator

Description

Currently, the CLP docs state that the minimum version of Python needed to run CLP is 3.8. But Debian 11 uses 3.9.2, and RHEL 8, Arch Linux and other flavors still use Python 3.9. In addition, Python 3.8 reached its end of life in October 2024. Therefore, all pyproject.toml files have been updated to require at least 3.9, and all references in CLP docs to Python 3.8 have been changed to Python 3.9.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Built and served the docs to test .md files; built and ran package to test .toml files.

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Updated documentation and system requirements to reflect Python 3.9 as the new minimum required version for building, linting, multi-node deployment, and running the application. Clarified that the python3-venv dependency must match the installed Python version. No other documentation changes were made.

@coderabbitai

coderabbitai Bot commented Jul 7, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The documentation and package configuration files were updated to increase the minimum required Python version from 3.8 to 3.9 across build, linting, multi-node deployment, quick-start instructions, and project metadata. No other requirements, instructions, or public entities were modified.

Changes

Files Change Summary
docs/src/dev-guide/building-package.md, docs/src/dev-guide/contributing-linting.md Updated minimum Python version requirement from 3.8 to 3.9; clarified python3-venv dependency note.
docs/src/user-guide/guides-multi-node.md, docs/src/user-guide/quick-start/index.md Updated minimum Python version requirement from 3.8 to 3.9.
components/clp-package-utils/pyproject.toml, components/clp-py-utils/pyproject.toml, components/job-orchestration/pyproject.toml Increased minimum Python version from 3.8 to 3.9 in project metadata and poetry dependencies.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@quinntaylormitchell

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 7, 2025

Copy link
Copy Markdown
Contributor
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@quinntaylormitchell quinntaylormitchell marked this pull request as ready for review July 7, 2025 19:06
@quinntaylormitchell quinntaylormitchell requested a review from a team as a code owner July 7, 2025 19:06

@kirkrodrigues kirkrodrigues left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, we should also update our pyproject.toml files to support Python 3.10+ rather than Python 3.8. Can you make the change?

Something like this:

-requires-python = ">= 3.8"
+requires-python = ">=3.8"

-python = "^3.8 || ^3.10"
+python = ">=3.10"

For the PR title, how about:

build(clp-package): Increase minimum Python version from 3.8 to 3.10 as Python 3.8 has reached end-of-life.

@jackluo923

jackluo923 commented Jul 9, 2025

Copy link
Copy Markdown
Member

Can we stay on Python 3.9 since Debian 11 uses 3.9.2 which only reaches EOL on Aug 2026. Similarily, RHEL 8, arch linux and other flavors still uses Python 3.9.

@kirkrodrigues

Copy link
Copy Markdown
Member

Can we stay on Python 3.9 since Debian 11 uses 3.9.2 which only reaches EOL on Aug 2026. Similarily, RHEL 8, arch linux and other flavors still uses Python 3.9.

Sure. @quinntaylormitchell, can you do that?

@jackluo923 jackluo923 self-requested a review July 9, 2025 15:49
@quinntaylormitchell quinntaylormitchell changed the title docs: Update all references to Python 3.8 to Python 3.10 build(clp-package): Increase minimum Python version from 3.8 to 3.10 as Python 3.8 has reached end-of-life. Jul 9, 2025
@quinntaylormitchell quinntaylormitchell changed the title build(clp-package): Increase minimum Python version from 3.8 to 3.10 as Python 3.8 has reached end-of-life. build(clp-package): Increase minimum Python version from 3.8 to 3.9 as Python 3.8 has reached end-of-life. Jul 9, 2025

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7049dd1 and a0e593d.

📒 Files selected for processing (7)
  • components/clp-package-utils/pyproject.toml (2 hunks)
  • components/clp-py-utils/pyproject.toml (2 hunks)
  • components/job-orchestration/pyproject.toml (2 hunks)
  • docs/src/dev-guide/building-package.md (1 hunks)
  • docs/src/dev-guide/contributing-linting.md (1 hunks)
  • docs/src/user-guide/guides-multi-node.md (1 hunks)
  • docs/src/user-guide/quick-start/index.md (1 hunks)
🧰 Additional context used
🧠 Learnings (5)
docs/src/dev-guide/contributing-linting.md (1)
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
docs/src/user-guide/guides-multi-node.md (1)
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
components/clp-package-utils/pyproject.toml (2)
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
docs/src/user-guide/quick-start/index.md (3)
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
components/clp-py-utils/pyproject.toml (2)
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: lint-check (macos-latest)
  • GitHub Check: lint-check (ubuntu-latest)
  • GitHub Check: build (macos-latest)
🔇 Additional comments (6)
docs/src/dev-guide/building-package.md (1)

13-13: Python version bump looks correct

The requirement now matches the broader project consensus. No further action needed in this file.

docs/src/user-guide/guides-multi-node.md (1)

10-10: Consistent with new minimum version – LGTM

The doc now correctly reflects the 3.9 baseline.

components/clp-py-utils/pyproject.toml (1)

2-3: No further Python 3.8 references to update
A search for Programming Language :: Python :: 3.8, CI/workflow python-version: 3.8, and FROM python:3.8 in Dockerfiles returned no matches. All remaining “3.8” occurrences live in lockfiles or npm package metadata and don’t require manual edits.

components/clp-package-utils/pyproject.toml (1)

2-3: Same follow-up as other pyproject files

Ensure trove classifiers & CI remove 3.8 and add 3.9 where applicable.

Also applies to: 12-13

components/job-orchestration/pyproject.toml (1)

2-3: Clean-up complete: no Python 3.8 references remain

Verified that after updating requires-python = ">= 3.9" there are no lingering 3.8 mentions in:

  • Packaging classifiers (pyproject.toml)
  • Dockerfiles (FROM python:3.8)
  • docker-compose definitions
  • GitHub Actions workflows (both python-version: 3.8 and generic python:3.8)

All checks passed—no further action needed.

docs/src/user-guide/quick-start/index.md (1)

43-45: Update looks good and aligns with project-wide change.

No further action needed.

Comment thread docs/src/dev-guide/contributing-linting.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (1)
docs/src/dev-guide/contributing-linting.md (1)

16-17: Add a concrete package-name example for clarity.

The parenthetical helps, but novices still search for an exact package string. Consider spelling it out (e.g., python3.9-venv on Debian 11, python3.10-venv on Ubuntu 22.04) so that copy-paste installs just work.

-* python3-venv (for the version of Python installed)
+* python3-venv (match your Python interpreter, e.g., `python3.9-venv` on Debian 11 or `python3.10-venv` on Ubuntu 22.04)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a0e593d and 49189d6.

📒 Files selected for processing (2)
  • docs/src/dev-guide/building-package.md (1 hunks)
  • docs/src/dev-guide/contributing-linting.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
docs/src/dev-guide/contributing-linting.md (1)
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
docs/src/dev-guide/building-package.md (1)
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.

Comment thread docs/src/dev-guide/building-package.md
Comment thread components/clp-package-utils/pyproject.toml Outdated
Comment thread components/clp-py-utils/pyproject.toml Outdated
Comment thread components/job-orchestration/pyproject.toml Outdated
quinntaylormitchell and others added 3 commits July 9, 2025 18:18
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (4)
components/clp-package-utils/pyproject.toml (2)

2-2: Same comment as earlier: version floor bumped to 3.9 – looks good

No issues; ensure CI / docs are consistent.


12-12: Redundant python spec

Identical observation: may be removed if desired.

components/job-orchestration/pyproject.toml (2)

2-2: 3.9 minimum acknowledged

Change is correct; parity with the other sub-projects maintained.


12-12: Optional cleanup

Same redundancy note as above.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 49189d6 and 58646ea.

📒 Files selected for processing (3)
  • components/clp-package-utils/pyproject.toml (2 hunks)
  • components/clp-py-utils/pyproject.toml (2 hunks)
  • components/job-orchestration/pyproject.toml (2 hunks)
🧰 Additional context used
🧠 Learnings (2)
components/clp-py-utils/pyproject.toml (2)
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
components/clp-package-utils/pyproject.toml (2)
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-07-03T13:33:27.460Z
Learning: In the CLP codebase, `from __future__ import annotations` imports are used to enable Python pipe notation for union types (e.g., `int | str`) in Python versions before 3.10, and should not be considered unused imports.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: lint-check (ubuntu-latest)
  • GitHub Check: build (ubuntu-latest)
🔇 Additional comments (1)
components/clp-py-utils/pyproject.toml (1)

2-2: Python 3.9 floor confirmed across repo & CI
All searches of pyproject.toml, Dockerfiles, and GitHub Actions workflows show no remaining 3.8 pins. Raising the minimum to >=3.9 is safe.


[tool.poetry.dependencies]
python = "^3.8 || ^3.10"
python = ">= 3.9"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Minor duplication – consider dropping the dependency-level spec

[project].requires-python already enforces >=3.9; keeping a second identical
constraint under [tool.poetry.dependencies] is harmless but redundant.
Feel free to leave it, or delete for brevity.

🤖 Prompt for AI Agents
In components/clp-py-utils/pyproject.toml at line 12, there is a redundant
Python version constraint under [tool.poetry.dependencies] since
[project].requires-python already enforces ">=3.9". To fix this, remove the
python = ">= 3.9" line from the dependencies section to avoid duplication and
keep the configuration concise.

@kirkrodrigues kirkrodrigues merged commit 033cc08 into y-scope:main Jul 10, 2025
7 checks passed
junhaoliao pushed a commit to junhaoliao/clp that referenced this pull request May 17, 2026
…s Python 3.8 has reached end-of-life. (y-scope#1076)

Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants