plotly / plotly/plotly.py

[BUG]: Plotly doesn't render properly when used in the Colab VS Code extension.

Ouverte
#5,471 3 commentaires 1 réaction 1 personne assignée Voir sur GitHub

@kevineger y travaille déjà.

Depuis le 21/1/2026.

bug
Langage dominant
Python
Étoiles
18.8k
Forks
2.8k
Merge moyen
16 h 26 min
PR mergées (30 j)
21

Description

Description

Hi there 👋, I'm the maintainer of the Colab VS Code extension which we recently launched:

One of our users reported https://github.com/googlecolab/colab-vscode/issues/339. Summarized, today Plotly doesn't render properly in VS Code when using the Colab extension. This requires users to manually configure the default renderer, instead of being able to lean on Plotly's detection.

Steps to reproduce
  • Install the Colab VS Code extension
  • Create a new Jupyter notebook file
  • Click Select Kernel
  • Select Colab
  • If prompted (first run), sign in to Google
  • Author a cell which renders a Plotly plot, e.g.:
    import plotly.express as px
    import pandas as pd
    import plotly.io as pio
    
    data = {'x': [1, 2, 3, 4, 5], 'y': [1, 2, 4, 8, 16], 'text': ['hello', 'world', '!', '!', '!']}
    df = pd.DataFrame(data)
    fig = px.scatter(df, x="x", y="y", text="text", title="Hello World Plotly Express")
    fig.update_traces(textposition='top center')
    fig.show()
    
  • Execute the cell

Expected behaviour: plot is rendered as it does if you set pio.renderers.default = "vscode" before showing the plot.

Actual behaviour: nothing is rendered. You can Copy cell output and see the HTML output that's returned instead. This works in web-based Colab.

Notes

As you'll see in my reply, this seems to be caused by this block in Plotly, where the default_renderer gets set to colab. If I set plotly.io.renderers.default to 'plotly_mimetype' or 'vscode', everything works as intended.

Unfortunately, VS Code doesn't set VSCODE_PID for these remote Colab kernels, so we can't simply re-order the default renderer checks. One possible solution is to extend the Colab check from only looking for import google.colab to also check for COLAB_NOTEBOOK_ID, which I believe (need to double check) is only set for web-based Colab. Feels a bit brittle. Open to suggestions, and happy to send a PR once we reach consensus!

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.