Skip to content

Fix for formatting notebook cells. #17650

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.

Sign up for GitHub

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 2 commits into from
Oct 8, 2021
Merged

Fix for formatting notebook cells. #17650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d082914
Fix for formatting notebook cells.
karthiknadig Oct 6, 2021
cede299
Ensure we check language id.
karthiknadig Oct 7, 2021
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
1 change: 1 addition & 0 deletions news/2 Fixes/16980.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Ensure we use fragment when formatting notebook cells.
6 changes: 4 additions & 2 deletions src/client/common/editor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,11 +248,13 @@ export async function getTempFileWithDocumentContents(document: TextDocument, fs
// because the language server is watching the file system for Python
// file add/delete/change and we don't want this temp file to trigger it.

let fileName = `${document.uri.fsPath}.${md5(document.uri.fsPath)}.tmp`;
let fileName = `${document.uri.fsPath}.${md5(document.uri.fsPath + document.uri.fragment)}.tmp`;
try {
// When dealing with untitled notebooks, there's no original physical file, hence create a temp file.
if (isNotebookCell(document.uri) && !(await fs.fileExists(document.uri.fsPath))) {
fileName = (await fs.createTemporaryFile(`${path.basename(document.uri.fsPath)}.tmp`)).filePath;
fileName = (
await fs.createTemporaryFile(`${path.basename(document.uri.fsPath)}-${document.uri.fragment}.tmp`)
).filePath;
}
await fs.writeFile(fileName, document.getText());
} catch (ex) {
Expand Down
3 changes: 2 additions & 1 deletion src/client/providers/formatProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

import * as vscode from 'vscode';
import { ICommandManager, IDocumentManager, IWorkspaceService } from '../common/application/types';
import { PYTHON_LANGUAGE } from '../common/constants';
import { IConfigurationService } from '../common/types';
import { IInterpreterService } from '../interpreter/contracts';
import { IServiceContainer } from '../ioc/types';
Expand Down Expand Up @@ -76,7 +77,7 @@ export class PythonFormattingEditProvider
// Workaround is to resolve promise to nothing here, then execute format document and force new save.
// However, we need to know if this is 'format document' or formatting on save.

if (this.saving) {
if (this.saving || document.languageId !== PYTHON_LANGUAGE) {
// We are saving after formatting (see onSaveDocument below)
// so we do not want to format again.
return [];
Expand Down