qdrant-client icon indicating copy to clipboard operation
qdrant-client copied to clipboard

Rest & grpc client generation fix

Open I8dNLo opened this issue 8 months ago • 2 comments

Now: Rest client should not break environment by downgrading pydentic to version 1.10 GRPC client generation should execute in a separate python environment of python3.10 and should not also break environment

I8dNLo avatar Mar 26 '25 17:03 I8dNLo

Deploy Preview for poetic-froyo-8baba7 ready!

Name Link
Latest commit 4182b01043dd7ba906f4fe94dbb27e121934f5e1
Latest deploy log https://app.netlify.com/sites/poetic-froyo-8baba7/deploys/67ee62372458cd0008751464
Deploy Preview https://deploy-preview-938--poetic-froyo-8baba7.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Mar 26 '25 17:03 netlify[bot]

📝 Walkthrough

Walkthrough

The generate_rest_client.sh script has been significantly updated to enhance its error handling and overall structure. It now employs set -euo pipefail, improving error detection by exiting on errors, unset variables, or failed commands in a pipeline. Temporary directories are created using mktemp -d, with dedicated variables for each directory. The script checks for a suitable Python version (3.10.10) and sets the PYTHON_BIN variable accordingly, exiting if the version is not found. A cleanup step using trap ensures that temporary directories are removed upon exit. The installation of Poetry is now conditional, and the script changes to PROJECT_ROOT before running poetry install. The cloning of the Qdrant repository occurs after changing to the QDRANT_PATH, and the existence check for the OPENAPI_PATH has been updated for clarity. The script also includes a cleanup step that deactivates the virtual environment and removes the temporary environment directory at the end of execution. No changes were made to the declarations of exported or public entities.

Walkthrough

The generate_grpc_client.sh script has been updated to improve error handling and enhance the setup process for the Python virtual environment. It now uses set -euo pipefail to ensure the script exits on errors, uninitialized variables, or failed commands. The method for determining PROJECT_ROOT has been modified for accuracy. A temporary directory is created for the virtual environment, and the script explicitly creates and activates a Python virtual environment using the detected Python version. The installation of grpcio and grpcio-tools occurs after upgrading pip. The Qdrant repository is cloned using a sparse checkout to minimize data retrieval, and proto files are copied to the client directory, with specific internal service proto files removed. The filtering of the qdrant.proto file has been streamlined. The command to compile proto files uses the Python interpreter from the created virtual environment, and a cleanup step has been added to deactivate the virtual environment and remove the temporary directory. No changes were made to the declarations of exported or public entities.

Possibly related PRs

  • qdrant/qdrant-client#941: The changes in this PR are related as they involve modifications to the generate_grpc_client.sh script, specifically enhancing error handling and the management of Python versions and temporary directories.
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot] avatar Mar 26 '25 18:03 coderabbitai[bot]