Add C++ builder pattern
Corresponding to https://github.com/kvcache-ai/Mooncake/issues/978 Based on existing create method: static std::optional<std::shared_ptr<Client>> Create( const std::string& local_hostname, const std::string& metadata_connstring, const std::string& protocol, const std::optionalstd::string& device_names = std::nullopt, const std::string& master_server_entry = kDefaultMasterAddress, const std::shared_ptr<TransferEngine>& transfer_engine = nullptr);
Added builder functions with std::move to reduce copy.
Summary of Changes
Hello @JasonZhang517, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a C++ builder pattern for the mooncake::Client class, enhancing the client creation process by offering a more structured, readable, and flexible API. The new MooncakeStoreBuilder allows for step-by-step configuration of client parameters, including validation for required fields, and optimizes string handling by leveraging std::move. This change aims to improve the maintainability and usability of client instantiation, moving away from a single, potentially complex Create method.
Highlights
-
New Builder Pattern: Introduced a
MooncakeStoreBuilderclass to provide a fluent, type-safe, and more readable way to configure and createmooncake::Clientinstances. -
Parameter Handling: The builder methods (
WithLocalHostname,WithMetadataConnectionString, etc.) utilizestd::movefor string parameters to reduce unnecessary copies during client configuration. -
Required Field Validation: The
Build()method withinMooncakeStoreBuildernow includes validation to ensure essential parameters likelocal_hostnameandmetadata_connstringare provided before attempting to create aClient. -
Deprecation Notice: The existing
PyClient::setupmethod has been marked as deprecated, encouraging future use of the newMooncakeStoreBuilderfor client initialization. -
Internal Refactoring: The internal
PyClient::setup_internalmethod has been updated to use the newMooncakeStoreBuilderfor constructingClientobjects, demonstrating its intended usage.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
Use clang-format to fix code format issue.