CARVIEW |
Select Language
HTTP/2 200
date: Sat, 19 Jul 2025 14:37:32 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
etag: W/"a62a6f3bce507a8cdf049e882b8a5fd3"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=pSAs6EutMWRc7FxMui5ess9YG%2FjAJ6EF%2Fs98bggKWTaC6UoHg2dhg6TfXPc2aO8JqikX8du2hm9zn%2Bge%2BOBe6kyjoWaEat3F3BpDqYetkSjh%2FW6toQdNdfjOuaaj4DJDu%2BF7pfZHoMQTT9ED8lOvDkq2KJve9m0OppRGSsv%2FUNfIDuWIC%2FI8F88bfGotF8IygZEwKTLIOaPi%2FtKiE34TbF%2BDPlaGIotqkCKHfBg6iscdkXMqYFZ6u0BguYM93AdM6OLNKqLYkUB%2FrhzvlC1UMA%3D%3D--KksVnFW7grWRUuoU--gDYWrsrNmqAXxqTX7PJUtA%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.394531353.1752935851; Path=/; Domain=github.com; Expires=Sun, 19 Jul 2026 14:37:31 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Sun, 19 Jul 2026 14:37:31 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: D612:67A53:5ACAB3:71B885:687BADAB
Extensibility for other extensions · microsoft/vscode-jupyter Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 332
Extensibility for other extensions
Rich Chiodo edited this page May 3, 2022
·
4 revisions
The ms-toolsai.jupyter extension has a number of extensibility points for external partners to interface with. The definition of these extensibility points can be found here:
Some of the sub parts of that API are described in more detail below.
This api is called by an external extension to register a remote Jupyter server URI provider. This provider has the capability to inject UI into this command here:
(in that example, the Azure Compute entry was added).
When implementing the IJupyterUriQuickPicker
, you have a number of responsibilities:
- Add a
jupyterRemoteServerProvider
to your package.jsoncontributes
section. Like so:
"contributes": {
"jupyterRemoteServerProvider": []
},
- Call
registerRemoteServerProvider
in your extension'sactivate
function. - Provide an entry point for the dialog above. You do this with the call to
getQuickPickEntryItems
. - Provide
handleQuickPick
. This function is called if the user picks one of your entries you provided ingetQuickPickEntryItems
. -
handleQuickPick
can put up more UI to ask the user to pick from a number of choices. Its end result should be a handle to a choice or 'back'. That handle is a string value that will be used later to identify the choices the user made in your UI. -
getServerUri
should be able to take a handle returned fromhandleNextSteps
and provide an authorization header and a URL for final connection to a Jupyter server. At this point you might ask for a user name/password.
An example of implementing IJupyterUriQuickPicker
can be found here:
The jupyter extension defines a number of context keys that can be used in when
clauses for keybindings. These include:
Context Key | When is it true |
---|---|
jupyter.isnativeactive | true if the currently active notebook is a jupyter notebook (as opposed to say a github issues notebook) |
jupyter.notebookeditor.canrestartNotebookkernel | true when the current kernel for a notebook is active |
jupyter.notebookeditor.canInterruptNotebookKernel | true when the current kernel for a notebook is not busy |
jupyter.interactive.canRestartNotebookKernel | true when the current kernel for an interactive window is active |
jupyter.interactive.canInterruptNotebookKernel | true when the current kernel for an interactive window is not busy |
jupyter.isinteractiveactive | true when an interactive window is the active editor |
jupyter.isinteractiveornativeactive | true when the active editor is a notebook or an interactive window |
jupyter.ispythonornativeactive | true when the active editor is a python file or a notebook |
jupyter.ispythonorinteractiveeactive | true when the active editor is a python file or an interactive window |
jupyter.ispythonorinteractiveornativeeactive | true when the active editor is a python file, a notebook, or an interactive window |
jupyter.havenativecells | true when a notebook has any cells |
jupyter.ispythonnotebook | true when the kernel for a notebook is python based |
jupyter.kernel.isjupyter | true when the kernel for a notebook comes from the jupyter extension |
jupyter.hasNativeNotebookOrInteractiveWindowOpen | true when a notebook or an interactive window is open |
jupyter.notebookeditor.debuggingInProgress | true when debugging a notebook cell |
jupyter.notebookeditor.runByLineInProgress | true when running by line is active in a notebook cell |
jupyter.dataViewerActive | true when the dataviewer panel is open |
jupyter.ownsSelection | true when the setting jupyter.sendSelectionToInteractiveWindow is true |
jupyter.hascodecells | true when cell markers are present in the active python editor |
jupyter.zmqavailable | true when ZMQ support is enabled on the user's machine (determines how kernels are started) |
jupyter.replayLogLoaded | used for debugging pylance LSP output |
jupyter.development | true if building extension from command line |
jupyter.webExtension | true if running in the web version of the extension |
jupyter.vscode.channel | set to vscode channel (insiders or stable) |
- Contribution
- Source Code Organization
- Coding Standards
- Profiling
- Coding Guidelines
- Component Governance
- Writing tests
- Kernels
- Intellisense
- Debugging
- IPyWidgets
- Extensibility
- Module Dependencies
- Errors thrown
- Jupyter API
- Variable fetching
- Import / Export
- React Webviews: Variable Viewer, Data Viewer, and Plot Viewer
- FAQ
- Kernel Crashes
- Jupyter issues in the Python Interactive Window or Notebook Editor
- Finding the code that is causing high CPU load in production
- How to install extensions from VSIX when using Remote VS Code
- How to connect to a jupyter server for running code in vscode.dev
- Jupyter Kernels and the Jupyter Extension
Clone this wiki locally
You can’t perform that action at this time.