voxel51 / fiftyone

The open-source tool for building high-quality datasets and computer vision models
https://fiftyone.ai
Apache License 2.0
7.86k stars 517 forks source link

add force option to open_panel operation #4494

Closed imanjra closed 2 weeks ago

imanjra commented 2 weeks ago

What changes are proposed in this pull request?

Add an option to force open a panel even if a panel by name is not yet registered. This is useful for launching panel which may be registered later

How is this patch tested? If it is not, please explain why.

Using an operator with on_startup set to true:

class AutoLaunchConfusionMatrices(foo.Operator):
    @property
    def config(self):
        return foo.OperatorConfig(
            name="python_panel_02_auto_launch_confusion_matrices",
            label="PythonPanel0.2: Auto Launch Confusion Matrices",
            unlisted=True,
            # on_dataset_open=True,
            on_startup=True,
        )

    def execute(self, ctx):
        ctx.ops.open_panel(
            "python_panel_02_confusion_matrices", layout="horizontal", force=True
        )
        return {}

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

See above

What areas of FiftyOne does this PR affect?

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes introduce a new force parameter across relevant methods in both built-in-operators.ts and operations.py. This parameter allows for forcing an action—like opening a panel—without performing the usual existence checks. The default value for force is false, maintaining current behavior unless explicitly overridden.

Changes

Files Change Summary
app/.../built-in-operators.ts Added a force input to OpenPanel class to bypass panel existence check in execute method.
fiftyone/.../operations.py Updated open_panel method to include a force parameter, enabling forced panel opening.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant OpenPanel
    participant PanelManager

    Client->>OpenPanel: execute({name, isActive, layout, force})
    OpenPanel->>PanelManager: checkPanelExists(name)
    alt force is false
        PanelManager-->>OpenPanel: panelExists
        alt panelExists
            OpenPanel-->>Client: Panel already exists
        else
            OpenPanel->>PanelManager: createPanel(name, isActive, layout)
            PanelManager-->>OpenPanel: panelCreated
            OpenPanel-->>Client: Panel opened
        end
    else force is true
        OpenPanel->>PanelManager: createPanel(name, isActive, layout)
        PanelManager-->>OpenPanel: panelCreated
        OpenPanel-->>Client: Panel opened (forced)
    end

Poem

In code's vast garden, a change so neat, A forceful push, no checks repeat. Panels spring open, at your command, A magic touch, your wish in hand. With false the norm, true the might, Open your panels, day or night! 🌙


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.