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

feature/pyproject-support #625

Merged
merged 1 commit into from
Oct 25, 2024
Merged

feature/pyproject-support #625

merged 1 commit into from
Oct 25, 2024

Conversation

dylanpulver
Copy link
Collaborator

@dylanpulver dylanpulver commented Oct 25, 2024

This PR adds support for pyproject.toml files into the safety CLI repo.

Summary by CodeRabbit

  • New Features

    • Enhanced dependency retrieval to support PYPROJECT_TOML files in addition to existing file types.
  • Style

    • Minor formatting update with the addition of a newline at the end of the file.

Copy link

coderabbitai bot commented Oct 25, 2024

Walkthrough

The changes in this pull request modify the get_dependencies function in the safety/scan/ecosystems/python/dependencies.py file to include support for the FileType.PYPROJECT_TOML in its conditional checks. This allows the function to process PYPROJECT_TOML files when retrieving dependencies, alongside the previously supported file types. Additionally, a minor formatting change was made by adding a newline character after the last return statement. No other logic or error handling changes were introduced.

Changes

File Path Change Summary
safety/scan/ecosystems/python/dependencies.py Updated get_dependencies to include FileType.PYPROJECT_TOML in the conditional check; added newline at end.

Possibly related PRs

  • chore/update-safety-schemas-version #624: The changes in this PR update the version of the safety_schemas dependency to ensure compatibility with the new support for pyproject.toml, which is directly related to the modifications made in the get_dependencies function to include FileType.PYPROJECT_TOML.

Suggested reviewers

  • yeisonvargasf
  • SafetyQuincyF
  • jakub-safetycli
  • codemakerai-dev

Poem

🐇 In the code where rabbits play,
New types of files join the fray.
With pyproject.toml now in sight,
Dependencies gather, oh what a delight!
A newline added, neat and bright,
Hopping forward, all feels right! 🌼


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 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.

@dylanpulver dylanpulver mentioned this pull request Oct 25, 2024
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: 1

🧹 Outside diff range and nitpick comments (1)
safety/scan/ecosystems/python/dependencies.py (1)

288-294: Consider adding test coverage for pyproject.toml parsing

The changes look good, but we should ensure proper test coverage for the new file type support.

Would you like me to help create test cases for pyproject.toml parsing? This should include:

  1. Basic dependency parsing from pyproject.toml
  2. Error handling for malformed pyproject.toml files
  3. Integration tests with the safety CLI
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8d610ff and b75ff90.

📒 Files selected for processing (1)
  • safety/scan/ecosystems/python/dependencies.py (1 hunks)
🔇 Additional comments (1)
safety/scan/ecosystems/python/dependencies.py (1)

294-294: LGTM: Added newline at end of file

Adding a newline at the end of the file follows the standard convention.

safety/scan/ecosystems/python/dependencies.py Show resolved Hide resolved
Copy link
Member

@yeisonvargasf yeisonvargasf left a comment

Choose a reason for hiding this comment

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

LGTM

@dylanpulver dylanpulver merged commit d8095a7 into main Oct 25, 2024
12 checks passed
@dylanpulver dylanpulver deleted the feature/pyproject-support branch October 25, 2024 19:41
SafetyQuincyF pushed a commit that referenced this pull request Oct 31, 2024
SafetyQuincyF pushed a commit that referenced this pull request Oct 31, 2024
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.

2 participants