Skip to content
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

Dropped support for Python 3.8 #73

Merged
merged 2 commits into from
Dec 16, 2024
Merged

Conversation

fschuch
Copy link
Owner

@fschuch fschuch commented Dec 16, 2024

Summary by CodeRabbit

  • New Features

    • Updated project compatibility to require Python version 3.9 or higher.
  • Bug Fixes

    • Adjusted CI workflow to exclude Python 3.8 from testing and scanning.
  • Chores

    • Modified import statements to align with updated Python type hinting practices.

Copy link
Contributor

coderabbitai bot commented Dec 16, 2024

Walkthrough

This pull request focuses on updating the project's Python version compatibility, removing support for Python 3.8 across multiple configuration files. The changes span the CI workflow, project configuration (pyproject.toml), and a minor import modification in the io.py file. The project is now targeting Python 3.9 and newer versions, with corresponding updates to testing matrices, classifiers, and import statements.

Changes

File Change Summary
.github/workflows/ci.yaml - Removed Python 3.8 from python-version matrix
- Updated SonarCloud scan parameter to exclude Python 3.8
pyproject.toml - Updated requires-python from >=3.8 to >=3.9
- Removed Python 3.8 from version matrix and classifiers
xcompact3d_toolbox/io.py - Changed Iterator import from typing to collections.abc

Possibly related PRs

  • Fix sonarcloud #39: CI workflow modifications related to SonarCloud scan parameters and Python version compatibility

Poem

🐰 Farewell, Python 3.8, you've served us well,
Hopping to newer versions, our code will excel!
From typing to collections, imports now shine bright,
Our toolbox evolves with computational might!
Onwards we leap, with versions anew! 🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 851de63 and 45dee17.

📒 Files selected for processing (1)
  • xcompact3d_toolbox/io.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • xcompact3d_toolbox/io.py

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
xcompact3d_toolbox/io.py (1)

10-10: Consider moving Iterator import to type-checking block

Since Iterator is only used for type hints, consider moving it to a type-checking block for better runtime performance:

-from collections.abc import Iterator
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator

This change:

  1. Improves runtime performance by avoiding unnecessary imports
  2. Follows type hinting best practices
  3. Addresses the static analysis suggestion
🧰 Tools
🪛 Ruff (0.8.2)

10-10: Move standard library import collections.abc.Iterator into a type-checking block

Move into type-checking block

(TC003)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc753af and 851de63.

📒 Files selected for processing (3)
  • .github/workflows/ci.yaml (2 hunks)
  • pyproject.toml (2 hunks)
  • xcompact3d_toolbox/io.py (1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
xcompact3d_toolbox/io.py

10-10: Move standard library import collections.abc.Iterator into a type-checking block

Move into type-checking block

(TC003)

🔇 Additional comments (4)
.github/workflows/ci.yaml (2)

29-29: LGTM: Python version matrix updated correctly

The test matrix has been updated to remove Python 3.8, now only including versions 3.9 through 3.12.


89-89: LGTM: SonarCloud scan parameters aligned with supported versions

The SonarCloud Python version parameter has been updated to match the supported versions (3.9-3.12).

pyproject.toml (2)

9-9: LGTM: Python version requirement updated

The requires-python field has been correctly updated to require Python 3.9 or newer.


148-148: LGTM: Test matrix versions aligned

The test matrix has been updated to match the new minimum Python version requirement.

@fschuch fschuch force-pushed the chore/droped-support-for-python-3.8 branch from 851de63 to 45dee17 Compare December 16, 2024 22:49
@fschuch fschuch merged commit 73cc3a8 into main Dec 16, 2024
24 checks passed
@fschuch fschuch deleted the chore/droped-support-for-python-3.8 branch December 16, 2024 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant