feat: ability to add client_metadata directly in folder.create_data_group - BOT-516

[arthur-encord]

Introduction and Explanation

• rename DataGroupList to DataGroupCarousel
• add client_metadata to folder.create_data_group

[gemini-code-assist]

Summary of Changes

Hello @arthur-encord, I'm Gemini Code Assist¹! 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 primarily enhances the data group creation process by allowing users to attach arbitrary client_metadata to data groups, which can be useful for custom tracking or categorization. It also refines the API by renaming DataGroupList to DataGroupCarousel to better reflect its purpose, while ensuring backward compatibility through deprecation. Furthermore, the underlying @deprecated decorator has been made more robust to handle class deprecations, improving code maintainability and guiding users towards updated APIs.

Highlights

• Client Metadata for Data Groups: Introduced the capability to add custom client_metadata directly when creating data groups via folder.create_data_group.
• DataGroupList Renamed to DataGroupCarousel: The DataGroupList class has been renamed to DataGroupCarousel for improved clarity, with DataGroupList now marked as deprecated and inheriting from DataGroupCarousel.
• Enhanced @deprecated Decorator: The @deprecated decorator now supports deprecating entire classes in addition to functions, providing more flexible deprecation warnings.

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 👍 and 👎 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.

Footnotes

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

[github-actions]

Unit test report (Python 3.9.24, Pydantic 2.12.3)

269 tests   269 ✅  9s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit 3b1252e.

♻️ This comment has been updated with latest results.

[github-actions]

Unit test report (Python 3.9.24, Pydantic 1.10.22)

269 tests   269 ✅  8s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit 3b1252e.

♻️ This comment has been updated with latest results.

[gemini-code-assist]

Code Review

This pull request introduces two main changes: it adds the ability to include client_metadata when creating a data group, and it renames DataGroupList to DataGroupCarousel for clarity. The implementation is solid, with a nice enhancement to the @deprecated decorator to support class deprecation, ensuring backward compatibility for the renamed class. The addition of tests for the decorator is also a valuable improvement. Overall, the changes are well-executed and improve the SDK's functionality and clarity.

[github-actions]

SDK integration test report

285 tests  ±0   275 ✅  - 2   14m 47s ⏱️ - 3m 25s
  1 suites ±0     4 💤 ±0 
  1 files   ±0     6 ❌ +2 

For more details on these failures, see this check.

Results for commit 3b1252e. ± Comparison against base commit dbabc87.

♻️ This comment has been updated with latest results.