Support typing of fixture parameters

[thu2004]

src/fixtureParser.ts

• correctly locate pytest fixture when they are install with pip
• Add returnType and module attribute to Fixture

src/suggestionProvider.ts

• support typing of fixture parameter
• Change completion item kind from Field to Snippet together with the snippet setting, show our suggestions on the top of the suggestion list

Add 2 more tests for typing of fixture parameters

[nickjmiller]

Thank you for doing this!

[thu2004]

@nickjmiller please release it if the feature is approved.

[nickjmiller]

The new tests don't seem to be passing on a windows machine and the functionality isn't working either. I can look into it a little deeper this weekend, it may just be related to the path separator.

[thu2004]

I improved tests and test data. It is now independent what other pytest plugins your have in your system. Instead of compare if the fixture list is match, now it checks if the expected fixtures exist in the fixture list reported by pytest.

I downloaded and start a Windows virtual machine and run all tests successfully both on Windows and Linux OS.

[nickjmiller]

Thanks, the tests are working now and the functionality as well, I just didn't read the README close enough before.

I do think it's a bit unintuitive to trigger this, what do you think of including the return type in the original CompletionItem, e.g.:

let fixtureName = fixture.name;
if (fixture.returnType) {
    fixtureName += `: ${fixture.returnType}`;
}
let item = new vscode.CompletionItem(
    fixtureName,
    vscode.CompletionItemKind.Snippet
);
...

I think this might be a nice way to expose this, but it would need to be a toggleable option since earlier versions of python wouldn't support it and some people might not want typing. Or maybe two suggestions could be provided:

let fixtureName = fixture.name;
let item = new vscode.CompletionItem(
    fixtureName,
    vscode.CompletionItemKind.Snippet
);
if (fixture.returnType) {
    let itemWithType = new vscode.CompletionItem(
        fixtureName: `${fixtureName}: ${fixture.returnType}`,
        vscode.CompletionItemKind.Snippet
    );
...

[thu2004]

I started with the solution to autocomplete fixture with the type as you showed above. I found some drawbacks and it is not intuitive.

• The need of a new setting
• tester does not care about all fixtures with typing, for example some of the pytest build-in fixture:
  def test_aaa(capsysbinary:Generator[CaptureFixture[bytes], None, None])
  def test_aaa(monkeypatch:Generator["MonkeyPatch", None, None])
  It a pain to resolve all needed import statements or the user have to manually remove the typing.
  Please try the above fixture.
• It is intuitive to use ':' and then autocomplete if you think outside the fixture context.
  When you define a new function with parameter, after you typed the name of parameter and if you want to add typing, you press ':' then write the type or trigger autocomplete to get suggestion of type.