Skip to content
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

Ensure orig_nbformat is not written to ipynb file #192359

Merged
merged 1 commit into from
Sep 7, 2023
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 2 additions & 4 deletions extensions/ipynb/src/ipynbMain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type NotebookMetadata = {
pygments_lexer?: string;
[propName: string]: unknown;
};
orig_nbformat: number;
orig_nbformat?: number;
[propName: string]: unknown;
};

Expand Down Expand Up @@ -76,9 +76,7 @@ export function activate(context: vscode.ExtensionContext) {
data.metadata = {
custom: {
cells: [],
metadata: {
orig_nbformat: 4
},
metadata: {},
nbformat: 4,
nbformat_minor: 2
}
Expand Down
8 changes: 4 additions & 4 deletions extensions/ipynb/src/notebookSerializer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export class NotebookSerializer implements vscode.NotebookSerializer {

// For notebooks without metadata default the language in metadata to the preferred language.
if (!json.metadata || (!json.metadata.kernelspec && !json.metadata.language_info)) {
json.metadata = json.metadata || { orig_nbformat: defaultNotebookFormat.major };
json.metadata = json.metadata || {};
json.metadata.language_info = json.metadata.language_info || { name: preferredCellLanguage };
}

Expand Down Expand Up @@ -101,8 +101,8 @@ export class NotebookSerializer implements vscode.NotebookSerializer {
export function getNotebookMetadata(document: vscode.NotebookDocument | vscode.NotebookData) {
const notebookContent: Partial<nbformat.INotebookContent> = document.metadata?.custom || {};
notebookContent.cells = notebookContent.cells || [];
notebookContent.nbformat = notebookContent.nbformat || 4;
notebookContent.nbformat_minor = notebookContent.nbformat_minor ?? 2;
notebookContent.metadata = notebookContent.metadata || { orig_nbformat: 4 };
notebookContent.nbformat = notebookContent.nbformat || defaultNotebookFormat.major;
notebookContent.nbformat_minor = notebookContent.nbformat_minor ?? defaultNotebookFormat.minor;
notebookContent.metadata = notebookContent.metadata || {};
return notebookContent;
}