search

Standard-Labs / real-intent

Python SDK and abstracted interface for Real Intent operations.
https://realintent.co
0 stars 0 forks source link

Allow CSV renames on formatter instantiation #137

Closed preritdas closed 1 week ago

preritdas commented 1 week ago

Allow base CSV formatter to accept a renames: dict[str, str] | None = None and then apply this to _as_dataframe.

Same for insights CSV formatter, but this calls super()._as_dataframe(...) so implicitly implemented.

Summary by CodeRabbit

These updates improve the flexibility of CSV exports, allowing users to tailor column names according to their preferences.

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes involve updates to the CSVStringFormatter and CSVWithInsightsFormatter classes in the real_intent/deliver/csv.py and real_intent/deliver/csv_insights.py files, respectively. Both classes now include an optional renames parameter in their constructors, allowing users to specify a dictionary for renaming columns in the output DataFrame. The CSVStringFormatter class has been modified to include this renaming functionality in its _as_dataframe method, while the CSVWithInsightsFormatter class passes the renames parameter to its superclass.

Changes

File Path Change Summary
real_intent/deliver/csv.py Updated CSVStringFormatter constructor to include optional renames parameter; modified _as_dataframe to rename columns based on renames.
real_intent/deliver/csv_insights.py Updated CSVWithInsightsFormatter constructor to include optional renames parameter; passed renames to superclass constructor.
tests/test_format.py Added new test function test_csv_string_formatter_renames to validate renaming functionality in CSVStringFormatter.

Poem

In a field of data bright,
Columns dance in morning light.
With renames now, oh what a sight!
CSVs sing, their names take flight!
A rabbit hops with joy and cheer,
For flexible formats now appear! 🐇✨

🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.