Skip to content

Revert calling mypy with relatives paths (regression) #9502

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 3 commits into from
Jan 10, 2020
Merged

Revert calling mypy with relatives paths (regression) #9502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
084c754
Revert "fix(client/linters/mypy): call mypy incorrectly (#5834)"
kimadeline Jan 10, 2020
cc5070a
News file
kimadeline Jan 10, 2020
dd0a590
Revert "Fix MyPy CI tests (#8518)"
kimadeline Jan 10, 2020
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/9496.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Revert changes related to calling `mypy` with relative paths.
5 changes: 1 addition & 4 deletions src/client/linters/mypy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import * as path from 'path';
import { CancellationToken, OutputChannel, TextDocument } from 'vscode';
import '../common/extensions';
import { Product } from '../common/types';
Expand All @@ -14,9 +13,7 @@ export class MyPy extends BaseLinter {
}

protected async runLinter(document: TextDocument, cancellation: CancellationToken): Promise<ILintMessage[]> {
const cwd = this.getWorkspaceRootPath(document);
const relativePath = path.relative(cwd, document.uri.fsPath);
const messages = await this.run([relativePath], document, cancellation, REGEX);
const messages = await this.run([document.uri.fsPath], document, cancellation, REGEX);
messages.forEach(msg => {
msg.severity = this.parseMessagesSeverity(msg.type, this.pythonSettings.linting.mypyCategorySeverity);
msg.code = msg.type;
Expand Down
3 changes: 1 addition & 2 deletions src/test/linters/lint.args.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,7 @@ suite('Linting - Arguments', () => {
});
test('MyPy', async () => {
const linter = new MyPy(outputChannel.object, serviceContainer);
const expectedPath = workspaceUri ? path.join(path.basename(path.dirname(fileUri.fsPath)), path.basename(fileUri.fsPath)) : path.basename(fileUri.fsPath);
const expectedArgs = [expectedPath];
const expectedArgs = [fileUri.fsPath];
await testLinter(linter, expectedArgs);
});
test('Pydocstyle', async () => {
Expand Down
83 changes: 3 additions & 80 deletions src/test/linters/mypy.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,12 @@
// tslint:disable:no-object-literal-type-assertion

import { expect } from 'chai';
import * as path from 'path';
import * as sinon from 'sinon';
import { anything, instance, mock, when } from 'ts-mockito';
import { CancellationToken, CancellationTokenSource, TextDocument, Uri } from 'vscode';
import { Product } from '../../client/common/types';
import { ServiceContainer } from '../../client/ioc/container';
import { parseLine } from '../../client/linters/baseLinter';
import { LinterManager } from '../../client/linters/linterManager';
import { MyPy, REGEX } from '../../client/linters/mypy';
import { ILinterManager, ILintMessage, LintMessageSeverity } from '../../client/linters/types';
import { MockOutputChannel } from '../mockClasses';
import { REGEX } from '../../client/linters/mypy';
import { ILintMessage } from '../../client/linters/types';

// This following is a real-world example. See gh=2380.
// tslint:disable:no-multiline-string no-any max-func-body-length
// tslint:disable-next-line:no-multiline-string
const output = `
provider.pyi:10: error: Incompatible types in assignment (expression has type "str", variable has type "int")
provider.pyi:11: error: Name 'not_declared_var' is not defined
Expand Down Expand Up @@ -71,72 +63,3 @@ suite('Linting - MyPy', () => {
}
});
});

suite('Test Linter', () => {
class TestMyPyLinter extends MyPy {
// tslint:disable: no-unnecessary-override
public async runLinter(document: TextDocument, cancellation: CancellationToken): Promise<ILintMessage[]> {
return super.runLinter(document, cancellation);
}
public getWorkspaceRootPath(document: TextDocument): string {
return super.getWorkspaceRootPath(document);
}
public async run(args: string[], document: TextDocument, cancellation: CancellationToken, regEx: string = REGEX): Promise<ILintMessage[]> {
return super.run(args, document, cancellation, regEx);
}
public parseMessagesSeverity(error: string, severity: any): LintMessageSeverity {
return super.parseMessagesSeverity(error, severity);
}
}

let linter: TestMyPyLinter;
let getWorkspaceRootPathStub: sinon.SinonStub<[TextDocument], string>;
let runStub: sinon.SinonStub<[string[], TextDocument, CancellationToken, (string | undefined)?], Promise<ILintMessage[]>>;
const token = new CancellationTokenSource().token;
teardown(() => sinon.restore());
setup(() => {
const linterManager = mock(LinterManager);
when(linterManager.getLinterInfo(anything())).thenReturn({ product: Product.mypy } as any);
const serviceContainer = mock(ServiceContainer);
when(serviceContainer.get<ILinterManager>(ILinterManager)).thenReturn(instance(linterManager));
getWorkspaceRootPathStub = sinon.stub(TestMyPyLinter.prototype, 'getWorkspaceRootPath');
runStub = sinon.stub(TestMyPyLinter.prototype, 'run');
linter = new TestMyPyLinter(instance(mock(MockOutputChannel)), instance(serviceContainer));
});

test('Get cwd based on document', async () => {
const fileUri = Uri.file(path.join('a', 'b', 'c', 'd', 'e', 'filename.py'));
const cwd = path.join('a', 'b', 'c');
const doc = ({ uri: fileUri } as any) as TextDocument;
getWorkspaceRootPathStub.callsFake(() => cwd);
runStub.callsFake(() => Promise.resolve([]));

await linter.runLinter(doc, token);

expect(getWorkspaceRootPathStub.callCount).to.equal(1);
expect(getWorkspaceRootPathStub.args[0]).to.deep.equal([doc]);
});
test('Pass relative path of document to linter', async () => {
const fileUri = Uri.file(path.join('a', 'b', 'c', 'd', 'e', 'filename.py'));
const cwd = path.join('a', 'b', 'c');
const doc = ({ uri: fileUri } as any) as TextDocument;
getWorkspaceRootPathStub.callsFake(() => cwd);
runStub.callsFake(() => Promise.resolve([]));

await linter.runLinter(doc, token);

expect(runStub.callCount).to.equal(1);
expect(runStub.args[0]).to.deep.equal([[path.relative(cwd, fileUri.fsPath)], doc, token, REGEX]);
});
test('Return empty messages', async () => {
const fileUri = Uri.file(path.join('a', 'b', 'c', 'd', 'e', 'filename.py'));
const cwd = path.join('a', 'b', 'c');
const doc = ({ uri: fileUri } as any) as TextDocument;
getWorkspaceRootPathStub.callsFake(() => cwd);
runStub.callsFake(() => Promise.resolve([]));

const messages = await linter.runLinter(doc, token);

expect(messages).to.be.deep.equal([]);
});
});