Skip to content

Drop the soft dependency on Jupyter #18073

Closed
Closed
Drop the soft dependency on Jupyter#18073
Assignees
luabud
Labels
area-data sciencefeature-requestRequest for new features or functionalityverification-neededVerification of issue is requestedverifiedVerification succeeded
Milestone
April 2023

Description

@brettcannon
Brett Cannon (brettcannon)
opened on Nov 23, 2021

Before we can consider this we have to investigate what this would look like for users.

  • What will no longer work in the extension (e.g. data viewer)?
  • How will users be recommended to install the Jupyter extension when they would need/want it (e.g. when they open a .ipynb file)?

Activity

  1. Brett Cannon (brettcannon)
    added
    feature-requestRequest for new features or functionality
    needs spikeLabel for issues that need investigation before they can be worked on.
    area-data science
    on Nov 23, 2021
  2. github-actions
    added
    triage-neededNeeds assignment to the proper sub-team
    on Nov 23, 2021

  3. brian-finisher commented on Nov 23, 2021

    @brian-finisher
    Brian Saghy (brian-finisher)
    on Nov 23, 2021

    I'll be very excited to see the soft dependency removed! I couldn't figure out why I had Jupyter extensions being installed in my remote docker devcontainers! While not a huge deal, it makes the container configuration a bit slower, and clutters up the extension view. While it can be uninstalled manually, I don't think that's really an option to automate with the .devcontainer.json config

  4. Kim-Adeline Miguel (kimadeline)
    removed
    triage-neededNeeds assignment to the proper sub-team
    on Nov 25, 2021

  5. luabud commented on Jan 22, 2022

    @luabud
    Luciana Abud (luabud)
    on Jan 22, 2022
    Member

    TL;DR:

    • Features that I believe will no longer be available on Python extension install:
      • IntelliSense support for Python notebooks
      • Selecting a kernel and running cells
      • Opening the data viewer when debugging
      • Opening the interactive window (through the command or from the code lenses for #%% blocks)
    • The Jupyter extension seems to be only recommended when kernel selection is triggered from a notebook (either from the "select kernel" command, or from the "run cell" commands).

    More info below.

    To investigate what would be the behavior if we no longer installed the Jupyter extension by default, I tested the scenarios below with the Python extension installed and the Jupyter extension not installed.

    Jupyter notebooks

    • Notebook gets rendered properly
    • All the "Notebook: ..." commands work properly
      • The ones that require kernel selection (e.g. "Select Kernel", "Run cells", etc.) trigger the prompt below, as expected, and users are then directed to the marketplace to install the Jupyter extension: image

    Python interactive window

    • There are no references to the interactive window from the Python extension itself. No code lenses show up either on files with cells defined by # %% :
      image

    Opening the data viewer when debugging

    • The option doesn't show up when right-clicking on a variable from the local window when Jupyter isn't installed:

    image

    After that, I looked into the source code to see if there was anything I could be missing. If I understand it correctly (and there's a good chance I don't), there seems to be only two things we use/call from the Jupyter extension:
    registerRemoteServerProvider and showDataViewer (

    vscode-python/src/client/jupyter/jupyterIntegration.ts

    Line 115 in 3698950

    export type JupyterExtensionApi = {
    ). I believe the entry points to any of those are not displayed anywhere in the Python extension, so that should be fine.
    See More

    Required changes

    If we were to proceed with this idea, there are additional changes that would need to be done on:

    • README
    • Walkthroughs
    • Build and dependencies files
    • License files

    Optional changes

    We could consider introducing more recommendations for users to install the Jupyter extension in scenarios that make sense, for example:

    • When Pylance is triggered for open notebooks
    • When right clicking on a variable in the debugger local window (where "open in data viewer" would show up)
    • From walkthroughs

  6. rchiodo commented on Jan 22, 2022

    @rchiodo
    Rich Chiodo (rchiodo)
    on Jan 22, 2022 via email

  7. luabud commented on Jan 22, 2022

    @luabud
    Luciana Abud (luabud)
    on Jan 22, 2022
    Member

    Thank you for confirming, Rich!

  8. rchiodo commented on Jan 22, 2022

    @rchiodo
    Rich Chiodo (rchiodo)
    on Jan 22, 2022 via email

  9. luabud commented on Jan 22, 2022

    @luabud
    Luciana Abud (luabud)
    on Jan 22, 2022
    Member

    Rich Chiodo (@rchiodo) is this also the case when a kernels isn't selected? I think I'm mostly looking at what are the parts of the experience that are different when the Jupyter extension isn't installed vs when it is installed but no kernel is selected.

  10. rchiodo commented on Jan 22, 2022

    @rchiodo
    Rich Chiodo (rchiodo)
    on Jan 22, 2022

    Yes same thing happens with no kernel selected. Jupyter is the only extension handling intellisense for notebooks (python notebooks anyway)

  11. Luciana Abud (luabud)
    added this to the January 2022 milestone on Jan 24, 2022
  12. Brett Cannon (brettcannon)
    modified the milestones: January 2022, February 2022 on Jan 25, 2022

  13. 27 remaining items

  14. Brett Cannon (brettcannon)
    added this to the January 2023 milestone on Nov 28, 2022
  15. Karthik Nadig (karthiknadig)
    modified the milestones: January 2023, February 2023 on Jan 24, 2023
  16. Karthik Nadig (karthiknadig)
    modified the milestones: February 2023, March 2023 on Feb 21, 2023
  17. Luciana Abud (luabud)
    modified the milestones: March 2023, April 2023 on Mar 23, 2023
  18. Luciana Abud (luabud)
    added a commit that references this issue on Mar 29, 2023

    No longer install the Jupyter extension by default (#20218)

    34c54f4

  19. luabud commented on Apr 7, 2023

    @luabud
    Luciana Abud (luabud)
    on Apr 7, 2023
    Member

    when installing the pre-release version of the Python extension, the Jupyter extension is no longer installed by default. We're planning to ship these changes on our stable version next month :)

  20. Luciana Abud (luabud)
    closed this as completedon Apr 7, 2023
  21. Luciana Abud (luabud)
    added
    verification-neededVerification of issue is requested
    and removed
    needs proposalNeed to make some design decisions
    on Apr 25, 2023

  22. luabud commented on Apr 25, 2023

    @luabud
    Luciana Abud (luabud)
    on Apr 25, 2023
    Member

    To verify, uninstall the Python extension. Then install the pre-release version of the Python extension and make sure it doesn't install the Jupyter extension

  23. Don Jayamanne (DonJayamanne)
    added
    verifiedVerification succeeded
    on Apr 26, 2023
  24. github-actions
    locked as resolved and limited conversation to collaborators on May 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area-data sciencefeature-requestRequest for new features or functionalityverification-neededVerification of issue is requestedverifiedVerification succeeded

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions