Skip to content

fix: remove unsupported report variables argument#61

Closed
AlexButeau wants to merge 1 commit intomainfrom
alex/sdk-57-clean-up-report-variables-arg
Closed

fix: remove unsupported report variables argument#61
AlexButeau wants to merge 1 commit intomainfrom
alex/sdk-57-clean-up-report-variables-arg

Conversation

@AlexButeau
Copy link
Copy Markdown
Contributor

@AlexButeau AlexButeau commented Mar 18, 2025

Summary by CodeRabbit

  • Refactor
    • Streamlined the public interface for initiating runs by removing a legacy reporting configuration option.
    • The setup now accepts an optional list of attachments instead of the previous reporting variables.
    • This change simplifies the process of preparing and submitting reports.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 18, 2025

Walkthrough

The changes remove the report_variables parameter and its related handling from key methods in both the client and plugin modules. In tofupilot/client.py, the create_run method has been updated to no longer accept or process report_variables, simplifying its interface and payload. Similarly, in tofupilot/plugin.py, the Conf class removes the report_variables attribute and parameter from its set method, and the pytest_sessionfinish method now omits it from the call to client.create_run.

Changes

File(s) Change Summary
tofupilot/client.py Removed report_variables from the create_run method signature, docstring, and payload construction. The method now accepts an optional attachments list instead.
tofupilot/plugin.py Eliminated report_variables attribute and parameter from the Conf class initialization and its set method. Updated pytest_sessionfinish to exclude report_variables when calling client.create_run.

Sequence Diagram(s)

sequenceDiagram
    participant Plugin
    participant Client
    participant API

    Plugin->>Client: create_run(attachments)
    Client->>API: POST run payload (without report_variables)
    API-->>Client: Response
    Client-->>Plugin: Return run result
Loading

Poem

Hopping through the code with glee,
I bid farewell to report_variables, set free.
Attachments now join the run, light as air,
A simpler path for our data to share.
Hop along, dear coder, with joy everywhere! 🐇🌟

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d1aa208 and 5aadf8c.

📒 Files selected for processing (2)
  • tofupilot/client.py (0 hunks)
  • tofupilot/plugin.py (0 hunks)
💤 Files with no reviewable changes (2)
  • tofupilot/client.py
  • tofupilot/plugin.py
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test (windows-latest)
  • GitHub Check: test (ubuntu-latest)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@AlexButeau AlexButeau requested a review from upview March 18, 2025 10:10
@Sporarum
Copy link
Copy Markdown
Contributor

Sporarum commented Aug 8, 2025

Implemented independently

@Sporarum Sporarum closed this Aug 8, 2025
@upview upview deleted the alex/sdk-57-clean-up-report-variables-arg branch August 11, 2025 15:07
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