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

chore: add missing poetry-core constraint (<2.0), tighten python version constraint (<3.12) #288

Merged
merged 2 commits into from
Jan 28, 2025

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Jan 28, 2025

We previously had the incorrect Python constraint (Pendulum doesn't work on Python 3.21) and we didn't constrain poetry-core to <2.0.

This fixes both issues.

Summary by CodeRabbit

  • Chores
    • Updated Python version compatibility range to support Python 3.10 and 3.11
    • Refined Poetry core dependency version constraints for improved stability

@github-actions github-actions bot added the chore label Jan 28, 2025
@aaronsteers
Copy link
Contributor Author

aaronsteers commented Jan 28, 2025

/poetry-lock

Poetry-Lock Job Info

This job attempts to re-lock dependencies using poetry lock command. If any changes
are made, those changes will be automatically committed and pushed back to the PR.

Note: This job can only be run by maintainers. On PRs from forks, this command requires
that the PR author has enabled the Allow edits from maintainers option.

poetry lock job started... Check job output.

poetry lock applied successfully.

@aaronsteers aaronsteers requested a review from bnchrch January 28, 2025 21:27
@aaronsteers aaronsteers marked this pull request as ready for review January 28, 2025 21:27
@aaronsteers aaronsteers enabled auto-merge (squash) January 28, 2025 21:28
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

📝 Walkthrough

Walkthrough

This pull request focuses on refining dependency management in the pyproject.toml file. The changes involve tightening version constraints for two key dependencies: poetry-core in the build system and python in the project dependencies. Specifically, the Python version range is narrowed from ^3.10,<3.13 to ^3.10,<3.12, and the poetry-core version is constrained to >=1.0.0,<2.0, providing more precise version control for the project.

Changes

File Change Summary
pyproject.toml - Updated Python version constraint from ^3.10,<3.13 to ^3.10,<3.12
- Modified poetry-core version constraint from >=1.0.0 to >=1.0.0,<2.0

Possibly related PRs

Suggested labels

dependencies

Suggested reviewers

  • aaronsteers

Hey there! I noticed you're refining the dependency constraints. Quick question: What drove the decision to narrow the Python version range specifically to <3.12? Wdyt about potentially explaining the rationale behind this specific version constraint? 🤔


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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)
pyproject.toml (1)

Line range hint 32-90: Consider pinning versions for critical dependencies.

I notice we have several dependencies using "*" (e.g., backoff, requests, python-dateutil). While this provides maximum flexibility, it could lead to unexpected behavior. Would you consider:

  1. Pinning versions for critical dependencies like backoff and requests?
  2. Adding at least major version constraints (e.g., ^2.0.0) to prevent major version bumps?

This would help ensure consistent behavior across environments, wdyt? 🤔

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d318618 and 19e8619.

⛔ Files ignored due to path filters (1)
  • poetry.lock is excluded by !**/*.lock
📒 Files selected for processing (1)
  • pyproject.toml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Check: 'source-pokeapi' (skip=false)
  • GitHub Check: Check: 'source-the-guardian-api' (skip=false)
  • GitHub Check: Check: 'source-shopify' (skip=false)
  • GitHub Check: Check: 'source-hardcoded-records' (skip=false)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: Pytest (Fast)
🔇 Additional comments (2)
pyproject.toml (2)

2-2: LGTM! The poetry-core constraint looks good.

Adding the upper bound constraint <2.0 is a good practice to prevent potential breaking changes from major version upgrades. It's also consistent with the existing constraint on poetry-dynamic-versioning.

Would you like me to verify if there are any known compatibility issues with poetry-core versions? Here's a script that can help:

✅ Verification successful

The poetry-core constraint <2.0 looks perfect! 👍

I checked PyPI and see that while poetry-core 2.x is out (latest 2.0.1), sticking to 1.x series (latest 1.9.1) is a solid choice for stability. The constraint will help avoid any potential breaking changes from the major version bump. WDYT?

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any known issues with poetry-core versions
curl -s https://pypi.org/pypi/poetry-core/json | jq -r '.releases | keys[]' | sort -V | tail -n 5

Length of output: 129


32-32: Question about Python version constraint rationale.

I notice we're tightening the Python version to <3.12. The PR mentions Pendulum compatibility with Python 3.21, but I think we should clarify a few things:

  1. The PR description mentions Python 3.21 - is this a typo? Should it be 3.12?
  2. Would you like me to verify Python 3.12 compatibility for our key dependencies?

Here's a script to check compatibility:

@aaronsteers aaronsteers merged commit 4f8e9d8 into main Jan 28, 2025
22 of 24 checks passed
@aaronsteers aaronsteers deleted the aj/chore/fix-version-constraints branch January 28, 2025 22:00
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