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

Format with Ruff 0.9.0 #425

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Format with Ruff 0.9.0 #425

merged 1 commit into from
Jan 10, 2025

Conversation

alekszievr
Copy link
Contributor

@alekszievr alekszievr commented Jan 10, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Minor formatting improvements in various test files to enhance readability
    • Refined string formatting in retrieval and search-related modules
  • Tests

    • Updated assertion formatting across multiple test files for improved clarity
    • Consolidated multi-line assertions into single-line statements in unit and integration tests
  • Refactor

    • Improved code formatting in retrieval and document processing modules
    • Simplified string construction in some functions

Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Walkthrough

This pull request encompasses a series of minor formatting changes across multiple files in the CodeRabbit project. The modifications primarily focus on improving code readability by reformatting assertion statements in test files and making minor adjustments to string formatting in some source code files. The changes do not introduce new functionality or alter the underlying logic of the existing code, but instead aim to enhance code clarity and consistency.

Changes

File Path Change Summary
cognee/infrastructure/databases/graph/neo4j_driver/adapter.py Modified string quote formatting in get_filtered_graph_data method
cognee/modules/retrieval/brute_force_triplet_search.py Removed line breaks in format_triplets function
cognee/modules/retrieval/description_to_codepart_search.py Improved text input string construction
cognee/tests/integration/documents/*_test.py (AudioDocument, ImageDocument, PdfDocument, TextDocument, UnstructuredDocument) Reformatted assertion statements to single-line format
cognee/tests/test_deduplication.py Condensed assertion formatting
cognee/tests/test_falkordb.py Simplified assertion statement
cognee/tests/test_library.py Consolidated database path assertion
cognee/tests/test_pgvector.py Reformatted assertion statements
cognee/tests/unit/processing/chunks/*_test.py Simplified assertion formatting across chunk-related test files

Suggested Labels

run-checks

Possibly Related PRs

Poem

🐰 Formatting Hop, a Rabbit's Delight
Code lines now dance, crisp and tight
Single lines replace the sprawl
Readability answers the call
With each change, clarity takes flight! 🌟

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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)
cognee/tests/integration/documents/PdfDocument_test.py (1)

30-38: Simplify assertion formatting

The multi-line assertions with parentheses make the code more verbose without adding clarity. Since these are simple assertions with f-string error messages, they can be written more concisely on single lines.

-        assert ground_truth["word_count"] == paragraph_data.word_count, (
-            f'{ground_truth["word_count"] = } != {paragraph_data.word_count = }'
-        )
+        assert ground_truth["word_count"] == paragraph_data.word_count, f'{ground_truth["word_count"] = } != {paragraph_data.word_count = }'

-        assert ground_truth["len_text"] == len(paragraph_data.text), (
-            f'{ground_truth["len_text"] = } != {len(paragraph_data.text) = }'
-        )
+        assert ground_truth["len_text"] == len(paragraph_data.text), f'{ground_truth["len_text"] = } != {len(paragraph_data.text) = }'

-        assert ground_truth["cut_type"] == paragraph_data.cut_type, (
-            f'{ground_truth["cut_type"] = } != {paragraph_data.cut_type = }'
-        )
+        assert ground_truth["cut_type"] == paragraph_data.cut_type, f'{ground_truth["cut_type"] = } != {paragraph_data.cut_type = }'
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f694ca2 and 872bc89.

📒 Files selected for processing (16)
  • cognee/infrastructure/databases/graph/neo4j_driver/adapter.py (1 hunks)
  • cognee/modules/retrieval/brute_force_triplet_search.py (1 hunks)
  • cognee/modules/retrieval/description_to_codepart_search.py (1 hunks)
  • cognee/tests/integration/documents/AudioDocument_test.py (1 hunks)
  • cognee/tests/integration/documents/ImageDocument_test.py (1 hunks)
  • cognee/tests/integration/documents/PdfDocument_test.py (1 hunks)
  • cognee/tests/integration/documents/TextDocument_test.py (1 hunks)
  • cognee/tests/integration/documents/UnstructuredDocument_test.py (1 hunks)
  • cognee/tests/test_deduplication.py (2 hunks)
  • cognee/tests/test_falkordb.py (1 hunks)
  • cognee/tests/test_library.py (1 hunks)
  • cognee/tests/test_pgvector.py (2 hunks)
  • cognee/tests/unit/processing/chunks/chunk_by_paragraph_2_test.py (3 hunks)
  • cognee/tests/unit/processing/chunks/chunk_by_paragraph_test.py (1 hunks)
  • cognee/tests/unit/processing/chunks/chunk_by_sentence_test.py (2 hunks)
  • cognee/tests/unit/processing/chunks/chunk_by_word_test.py (1 hunks)
✅ Files skipped from review due to trivial changes (11)
  • cognee/tests/unit/processing/chunks/chunk_by_paragraph_test.py
  • cognee/tests/test_library.py
  • cognee/tests/test_pgvector.py
  • cognee/modules/retrieval/description_to_codepart_search.py
  • cognee/modules/retrieval/brute_force_triplet_search.py
  • cognee/infrastructure/databases/graph/neo4j_driver/adapter.py
  • cognee/tests/integration/documents/AudioDocument_test.py
  • cognee/tests/unit/processing/chunks/chunk_by_paragraph_2_test.py
  • cognee/tests/integration/documents/TextDocument_test.py
  • cognee/tests/test_falkordb.py
  • cognee/tests/test_deduplication.py
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: docker-compose-test
🔇 Additional comments (5)
cognee/tests/integration/documents/ImageDocument_test.py (1)

28-36: Same formatting issue as in PdfDocument_test.py

These assertions follow the same unnecessarily verbose pattern.

cognee/tests/integration/documents/UnstructuredDocument_test.py (1)

74-102: Review Ruff configuration for assertion formatting

The pattern of wrapping simple assertions in parentheses appears consistently across multiple test files. This suggests a possible Ruff configuration issue.

Consider checking your Ruff configuration:

#!/bin/bash
# Check for Ruff configuration files
find . -type f -name "ruff.toml" -o -name "pyproject.toml"

The assertions can be simplified similar to the previous files.

cognee/tests/unit/processing/chunks/chunk_by_word_test.py (1)

20-22: Same formatting pattern affecting test readability

The multi-line assertion pattern is consistent with other files but reduces readability.

-    assert reconstructed_text == input_text, (
-        f"texts are not identical: {len(input_text) = }, {len(reconstructed_text) = }"
-    )
+    assert reconstructed_text == input_text, f"texts are not identical: {len(input_text) = }, {len(reconstructed_text) = }"
cognee/tests/unit/processing/chunks/chunk_by_sentence_test.py (2)

19-21: LGTM! Clean formatting change.

The assertion formatting has been simplified while maintaining readability and the same functionality.


39-41: LGTM! Consistent formatting applied.

The assertion formatting matches the style applied throughout the PR, maintaining consistency and readability.

@Vasilije1990 Vasilije1990 merged commit b888597 into dev Jan 10, 2025
8 checks passed
@Vasilije1990 Vasilije1990 deleted the format_with_updated_ruff branch January 10, 2025 14:57
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