Skip to content

Mark some of the metadata as transient #13723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/client/common/application/notebook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { inject, injectable } from 'inversify';
import { Disposable, Event, EventEmitter } from 'vscode';
import type {
notebook,
NotebookCellMetadata,
NotebookCellsChangeEvent as VSCNotebookCellsChangeEvent,
NotebookContentProvider,
NotebookDocument,
Expand Down Expand Up @@ -96,8 +97,15 @@ export class VSCodeNotebook implements IVSCodeNotebook {
this.canUseNotebookApi = true;
}
}
public registerNotebookContentProvider(notebookType: string, provider: NotebookContentProvider): Disposable {
return this.notebook.registerNotebookContentProvider(notebookType, provider);
public registerNotebookContentProvider(
notebookType: string,
provider: NotebookContentProvider,
options?: {
transientOutputs: boolean;
transientMetadata: { [K in keyof NotebookCellMetadata]?: boolean };
}
): Disposable {
return this.notebook.registerNotebookContentProvider(notebookType, provider, options);
}
public registerNotebookKernelProvider(
selector: NotebookDocumentFilter,
Expand Down
18 changes: 17 additions & 1 deletion src/client/common/application/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ import {
} from 'vscode';
import type {
NotebookCellLanguageChangeEvent as VSCNotebookCellLanguageChangeEvent,
NotebookCellMetadata,
NotebookCellOutputsChangeEvent as VSCNotebookCellOutputsChangeEvent,
NotebookCellsChangeEvent as VSCNotebookCellsChangeEvent,
NotebookContentProvider,
Expand Down Expand Up @@ -1541,7 +1542,22 @@ export interface IVSCodeNotebook {
readonly onDidChangeNotebookDocument: Event<NotebookCellChangedEvent>;
readonly notebookEditors: Readonly<NotebookEditor[]>;
readonly activeNotebookEditor: NotebookEditor | undefined;
registerNotebookContentProvider(notebookType: string, provider: NotebookContentProvider): Disposable;
registerNotebookContentProvider(
notebookType: string,
provider: NotebookContentProvider,
options?: {
/**
* Controls if outputs change will trigger notebook document content change and if it will be used in the diff editor
* Default to false. If the content provider doesn't persisit the outputs in the file document, this should be set to true.
*/
transientOutputs: boolean;
/**
* Controls if a meetadata property change will trigger notebook document content change and if it will be used in the diff editor
* Default to false. If the content provider doesn't persisit a metadata property in the file document, it should be set to true.
*/
transientMetadata: { [K in keyof NotebookCellMetadata]?: boolean };
}
): Disposable;

registerNotebookKernelProvider(selector: NotebookDocumentFilter, provider: NotebookKernelProvider): Disposable;
}
18 changes: 17 additions & 1 deletion src/client/datascience/notebook/integration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,23 @@ export class NotebookIntegration implements IExtensionSingleActivationService {
}
try {
this.disposables.push(
this.vscNotebook.registerNotebookContentProvider(JupyterNotebookView, this.notebookContentProvider)
this.vscNotebook.registerNotebookContentProvider(JupyterNotebookView, this.notebookContentProvider, {
transientOutputs: false,
transientMetadata: {
breakpointMargin: true,
editable: true,
hasExecutionOrder: true,
inputCollapsed: true,
lastRunDuration: true,
outputCollapsed: true,
runStartTime: true,
runnable: true,
executionOrder: false,
custom: false,
runState: false,
statusMessage: false
}
})
);
this.disposables.push(
this.vscNotebook.registerNotebookKernelProvider(
Expand Down