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: unpin pybedlite dependency #98

Merged
merged 2 commits into from
Dec 13, 2024
Merged

chore: unpin pybedlite dependency #98

merged 2 commits into from
Dec 13, 2024

Conversation

msto
Copy link
Collaborator

@msto msto commented Dec 5, 2024

Similar to #97 , this PR unpins the dependency on pybedlite.

I am opening two separate PRs in case there is an argument for one dependency to be pinned but not the other.

@msto msto requested review from nh13 and tfenne as code owners December 5, 2024 16:55
Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

The changes in the pull request primarily involve updates to the pyproject.toml file for the prymer project. The project version has been updated to "2.2.0". The dependency for pybedlite has been modified from a fixed version "1.0.0" to a caret version "^1.0.0", which allows for minor version updates while ensuring compatibility.

No new dependencies have been added or removed, and the existing development dependencies remain unchanged. The overall structure and formatting of the pyproject.toml file have been preserved. The tool.poetry.urls section continues to include a link to the bug tracker without any modifications.

The build system requirements specify that poetry-core must be at least version "1.6". Additionally, the configurations for changelog management under tool.git-cliff.changelog, commit parsing rules under tool.git-cliff.git, type checking settings under tool.mypy, and pytest options under tool.pytest.ini_options have all remained intact. The primary focus of the changes is on versioning updates.


📜 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 93658a0 and 27c5d4c.

⛔ Files ignored due to path filters (1)
  • poetry.lock is excluded by !**/*.lock
📒 Files selected for processing (1)
  • pyproject.toml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pyproject.toml

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

@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

🧹 Outside diff range and nitpick comments (1)
pyproject.toml (1)

Line range hint 38-45: Consider consistent dependency pinning strategy.

Other dependencies mix pinned (fgpyo=0.7.1) and unpinned (^0.22.1, ^4.1.0) versions. Establish consistent policy.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f62c4b5 and a2d9a7c.

📒 Files selected for processing (1)
  • pyproject.toml (1 hunks)
🔇 Additional comments (2)
pyproject.toml (2)

Line range hint 3-3: Version bump looks appropriate.

2.2.0 version increment aligns with dependency changes.


38-38: Verify pybedlite compatibility across minor versions.

Unpinning to ^1.0.0 allows minor updates. Need to ensure backward compatibility.

✅ Verification successful

Unpinning pybedlite to ^1.0.0 is safe.

Limited usage shows only stable Interval and OverlapDetector imports. Version history shows steady progression (0.0.1 -> 1.0.0) with recent 1.0.0 release, indicating API stability.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check available pybedlite versions and their release dates
curl -s https://pypi.org/pypi/pybedlite/json | jq -r '.releases | keys[] as $k | "\($k)\t\(.[$k][0].upload_time)"' | sort -V

# Check for any breaking changes in pybedlite changelog
gh api repos/fulcrumgenomics/pybedlite/releases | jq -r '.[].body' | grep -i "break"

Length of output: 315


Script:

#!/bin/bash
# Check for usage of pybedlite in the codebase
rg "import.*pybedlite|from.*pybedlite" -l

# Check specific pybedlite function/class usage
rg "pybedlite\." -A 2

# Look for any test files related to pybedlite
fd "test.*\.py" --exec grep -l "pybedlite"

Length of output: 2349

@msto msto force-pushed the ms_unpin-pybedlite branch from a2d9a7c to 07e8083 Compare December 5, 2024 16:58
Copy link

codecov bot commented Dec 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@3c3ed80). Learn more about missing BASE report.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #98   +/-   ##
=======================================
  Coverage        ?   96.66%           
=======================================
  Files           ?       26           
  Lines           ?     1708           
  Branches        ?      189           
=======================================
  Hits            ?     1651           
  Misses          ?       31           
  Partials        ?       26           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@clintval
Copy link
Member

clintval commented Dec 5, 2024

For post-v1 dependencies that strictly follow SemVer, I go one step further and caret pin to the minor version. So for pybedlite, I'd do ~1.0. This doesn't work for pre-v1 dependencies since their API can change between minor or patch versions.

Copy link
Member

@nh13 nh13 left a comment

Choose a reason for hiding this comment

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

lgtm

msto and others added 2 commits December 13, 2024 10:46
Similar to #97 , this PR unpins the dependency on pybedlite.

I am opening two separate PRs in case there is an argument for one dependency to be pinned but not the other.
@tfenne tfenne force-pushed the ms_unpin-pybedlite branch from 93658a0 to 27c5d4c Compare December 13, 2024 17:48
@tfenne tfenne merged commit fbd1aa1 into main Dec 13, 2024
7 checks passed
@tfenne tfenne deleted the ms_unpin-pybedlite branch December 13, 2024 17:54
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.

4 participants