@zzzen/pyright-internal 1.2.0-dev.20260621 → 1.2.0-dev.20260628

package/dist/tests/docStringReturnExtraction.test.js

@@ -0,0 +1,125 @@
+"use strict";
+/*
+ * docStringReturnExtraction.test.ts
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT license.
+ *
+ * Tests for extractReturnDocumentation, which pulls the return-value description
+ * out of a function docstring (reST, Epytext, and Google styles).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert = require("assert");
+const docStringUtils_1 = require("../analyzer/docStringUtils");
+describe('extractReturnDocumentation', () => {
+    test('reST :returns: (plural)', () => {
+        const doc = `Compute a value.
+
+:returns: The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('reST :return: (singular)', () => {
+        const doc = `Compute a value.
+
+:return: The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('Epytext @returns: (plural)', () => {
+        const doc = `Compute a value.
+
+@returns: The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('Epytext @return (singular, no colon)', () => {
+        const doc = `Compute a value.
+
+@return The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('Epytext @returns:description (no space after colon)', () => {
+        // Mirrors reST: a missing space after the colon must still extract the description.
+        const doc = `Compute a value.
+
+@returns:The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('Google Returns: single line', () => {
+        const doc = `Compute a value.
+
+Returns:
+    The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('Google Returns: multi-line stops at next section (dedent)', () => {
+        const doc = `Compute a value.
+
+Returns:
+    The computed integer value.
+    Spanning two lines.
+Raises:
+    ValueError: if the value is bad.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.\nSpanning two lines.');
+    });
+    test('Google Returns: multi-line stops at blank line after collecting', () => {
+        const doc = `Compute a value.
+
+Returns:
+    The computed integer value.
+    Spanning two lines.
+
+Some trailing prose that is not part of the return section.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.\nSpanning two lines.');
+    });
+    test('Google Returns: type: description form', () => {
+        const doc = `Compute a value.
+
+Returns:
+    int: The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'int: The computed integer value.');
+    });
+    test('Google Return: (singular header)', () => {
+        const doc = `Compute a value.
+
+Return:
+    The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('reST empty :returns: yields undefined', () => {
+        const doc = `Compute a value.
+
+:returns:`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), undefined);
+    });
+    test('Google Returns: with no indented body yields undefined', () => {
+        const doc = `Compute a value.
+
+Returns:
+Raises:
+    ValueError: if the value is bad.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), undefined);
+    });
+    test('no return section yields undefined', () => {
+        const doc = `Compute a value.
+
+Args:
+    x: the input.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), undefined);
+    });
+    test('Google Returns: header on the first physical line', () => {
+        // The "Returns:" header sits on the docstring's first physical line, so its indentation
+        // must still be recovered correctly even though the first line is special-cased during
+        // docstring cleanup.
+        const doc = `Returns:
+    The computed integer value.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.');
+    });
+    test('Google Returns: header on the first physical line, multi-line body', () => {
+        const doc = `Returns:
+    The computed integer value.
+    Spanning two lines.`;
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(doc), 'The computed integer value.\nSpanning two lines.');
+    });
+    test('empty docstring yields undefined', () => {
+        assert.strictEqual((0, docStringUtils_1.extractReturnDocumentation)(''), undefined);
+    });
+});
+//# sourceMappingURL=docStringReturnExtraction.test.js.map

package/dist/tests/docStringReturnExtraction.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docStringReturnExtraction.test.js","sourceRoot":"","sources":["../../../../../src/tests/docStringReturnExtraction.test.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAEH,iCAAkC;AAElC,+DAAwE;AAExE,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACxC,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,GAAG,GAAG;;sCAEkB,CAAC;QAC/B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,GAAG,GAAG;;qCAEiB,CAAC;QAC9B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,GAAG,GAAG;;sCAEkB,CAAC;QAC/B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,GAAG,GAAG;;oCAEgB,CAAC;QAC7B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,oFAAoF;QACpF,MAAM,GAAG,GAAG;;qCAEiB,CAAC;QAC9B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,GAAG,GAAG;;;gCAGY,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,GAAG,GAAG;;;;;;qCAMiB,CAAC;QAC9B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,kDAAkD,CAAC,CAAC;IAC5G,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,GAAG,GAAG;;;;;;4DAMwC,CAAC;QACrD,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,kDAAkD,CAAC,CAAC;IAC5G,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,GAAG,GAAG;;;qCAGiB,CAAC;QAC9B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,kCAAkC,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,GAAG,GAAG;;;gCAGY,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,GAAG,GAAG;;UAEV,CAAC;QACH,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,GAAG,GAAG;;;;qCAIiB,CAAC;QAC9B,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,GAAG,GAAG;;;kBAGF,CAAC;QACX,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,wFAAwF;QACxF,uFAAuF;QACvF,qBAAqB;QACrB,MAAM,GAAG,GAAG;gCACY,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC5E,MAAM,GAAG,GAAG;;wBAEI,CAAC;QACjB,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,GAAG,CAAC,EAAE,kDAAkD,CAAC,CAAC;IAC5G,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,CAAC,WAAW,CAAC,IAAA,2CAA0B,EAAC,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/tests/fourslash/completions.call.unpackedGenericTypedDict.fourslash.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/fourslash/completions.call.unpackedGenericTypedDict.fourslash.js

@@ -0,0 +1,35 @@
+"use strict";
+/// <reference path="typings/fourslash.d.ts" />
+Object.defineProperty(exports, "__esModule", { value: true });
+// Unpacked parameterized TypedDict as a variadic keyword parameter.
+// expandTypedKwargs() (consumed by both signature help and completion literal-value suggestions)
+// must substitute the TypedDict type argument. Before the fix, the `t` entry kept the unspecialized
+// TypeVar `T@TD`, so no literal-value completions were offered; after the fix the entry is
+// `Literal['a', 'b']`, so the literal values are offered at the call site.
+// @filename: test.py
+//// from typing import Generic, Literal, TypedDict, TypeVar, Unpack
+////
+//// T = TypeVar('T')
+////
+//// class TD(TypedDict, Generic[T]):
+////     t: T
+////
+//// def func(**kwargs: Unpack[TD[Literal['a', 'b']]]) -> None: ...
+////
+//// func(t=[|/*marker*/|])
+// @ts-ignore
+await helper.verifyCompletion('included', 'markdown', {
+    marker: {
+        completions: [
+            {
+                label: "'a'",
+                kind: Consts.CompletionItemKind.Constant,
+            },
+            {
+                label: "'b'",
+                kind: Consts.CompletionItemKind.Constant,
+            },
+        ],
+    },
+});
+//# sourceMappingURL=completions.call.unpackedGenericTypedDict.fourslash.js.map

package/dist/tests/fourslash/completions.call.unpackedGenericTypedDict.fourslash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completions.call.unpackedGenericTypedDict.fourslash.js","sourceRoot":"","sources":["../../../../../../src/tests/fourslash/completions.call.unpackedGenericTypedDict.fourslash.ts"],"names":[],"mappings":";AAAA,+CAA+C;;AAE/C,oEAAoE;AACpE,iGAAiG;AACjG,oGAAoG;AACpG,2FAA2F;AAC3F,2EAA2E;AAE3E,qBAAqB;AACrB,oEAAoE;AACpE,IAAI;AACJ,qBAAqB;AACrB,IAAI;AACJ,qCAAqC;AACrC,aAAa;AACb,IAAI;AACJ,mEAAmE;AACnE,IAAI;AACJ,2BAA2B;AAE3B,aAAa;AACb,MAAM,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE;IAClD,MAAM,EAAE;QACJ,WAAW,EAAE;YACT;gBACI,KAAK,EAAE,KAAK;gBACZ,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,QAAQ;aAC3C;YACD;gBACI,KAAK,EAAE,KAAK;gBACZ,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,QAAQ;aAC3C;SACJ;KACJ;CACJ,CAAC,CAAC"}

package/dist/tests/fourslash/completions.keywords.expressionContext.fourslash.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/fourslash/completions.keywords.expressionContext.fourslash.js

@@ -0,0 +1,86 @@
+"use strict";
+/// <reference path="typings/fourslash.d.ts" />
+Object.defineProperty(exports, "__esModule", { value: true });
+// Statement-only keywords (e.g. `raise`, `return`) should be suppressed in
+// slots that can only contain an expression, while still being offered at the
+// start of a statement. Expression-valid keywords (e.g. `lambda`) must keep
+// appearing in expression slots.
+// @filename: stmtStart.py
+//// def func():
+////     re[|/*stmtStart*/|]
+// @filename: forIterable.py
+//// for item in ra[|/*forIterable*/|]
+// @filename: forIterableExprKeyword.py
+//// for item in la[|/*forIterableExprKeyword*/|]
+// @filename: assignRhs.py
+//// x = re[|/*assignRhs*/|]
+// @filename: assignRhsExprKeyword.py
+//// x = la[|/*assignRhsExprKeyword*/|]
+// @filename: walrusRhs.py
+//// if (n := re[|/*walrusRhs*/|]):
+////     pass
+// @filename: comprehensionIterable.py
+//// z = [i for i in re[|/*comprehensionIterable*/|]]
+// @filename: callArg.py
+//// print(re[|/*callArg*/|])
+// @filename: subscript.py
+//// data = [1, 2]
+//// w = data[re[|/*subscript*/|]]
+// @filename: returnValue.py
+//// def func():
+////     return ra[|/*returnValue*/|]
+// @filename: whileCondition.py
+//// while re[|/*whileCondition*/|]:
+////     pass
+// @filename: ifCondition.py
+//// if re[|/*ifCondition*/|]:
+////     pass
+{
+    helper.openFiles(helper.getMarkers().map((m) => m.fileName));
+    // Statement-only keywords are still offered at statement start, and
+    // expression-valid keywords are still offered in expression slots.
+    // @ts-ignore
+    await helper.verifyCompletion('included', 'markdown', {
+        stmtStart: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        forIterableExprKeyword: {
+            completions: [{ label: 'lambda', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        assignRhsExprKeyword: {
+            completions: [{ label: 'lambda', kind: Consts.CompletionItemKind.Keyword }],
+        },
+    });
+    // Statement-only keywords are suppressed in expression-only slots.
+    // @ts-ignore
+    await helper.verifyCompletion('excluded', 'markdown', {
+        forIterable: {
+            completions: [{ label: 'raise', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        assignRhs: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        walrusRhs: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        comprehensionIterable: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        callArg: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        subscript: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        returnValue: {
+            completions: [{ label: 'raise', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        whileCondition: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+        ifCondition: {
+            completions: [{ label: 'return', kind: Consts.CompletionItemKind.Keyword }],
+        },
+    });
+}
+//# sourceMappingURL=completions.keywords.expressionContext.fourslash.js.map

package/dist/tests/fourslash/completions.keywords.expressionContext.fourslash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completions.keywords.expressionContext.fourslash.js","sourceRoot":"","sources":["../../../../../../src/tests/fourslash/completions.keywords.expressionContext.fourslash.ts"],"names":[],"mappings":";AAAA,+CAA+C;;AAE/C,2EAA2E;AAC3E,8EAA8E;AAC9E,4EAA4E;AAC5E,iCAAiC;AAEjC,0BAA0B;AAC1B,gBAAgB;AAChB,4BAA4B;AAE5B,4BAA4B;AAC5B,sCAAsC;AAEtC,uCAAuC;AACvC,iDAAiD;AAEjD,0BAA0B;AAC1B,4BAA4B;AAE5B,qCAAqC;AACrC,uCAAuC;AAEvC,0BAA0B;AAC1B,mCAAmC;AACnC,aAAa;AAEb,sCAAsC;AACtC,qDAAqD;AAErD,wBAAwB;AACxB,6BAA6B;AAE7B,0BAA0B;AAC1B,kBAAkB;AAClB,kCAAkC;AAElC,4BAA4B;AAC5B,gBAAgB;AAChB,qCAAqC;AAErC,+BAA+B;AAC/B,oCAAoC;AACpC,aAAa;AAEb,4BAA4B;AAC5B,8BAA8B;AAC9B,aAAa;AAEb,CAAC;IACG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE7D,oEAAoE;IACpE,mEAAmE;IACnE,aAAa;IACb,MAAM,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE;QAClD,SAAS,EAAE;YACP,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,sBAAsB,EAAE;YACpB,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,oBAAoB,EAAE;YAClB,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;KACJ,CAAC,CAAC;IAEH,mEAAmE;IACnE,aAAa;IACb,MAAM,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE;QAClD,WAAW,EAAE;YACT,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC7E;QACD,SAAS,EAAE;YACP,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,SAAS,EAAE;YACP,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,qBAAqB,EAAE;YACnB,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,OAAO,EAAE;YACL,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,SAAS,EAAE;YACP,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,WAAW,EAAE;YACT,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC7E;QACD,cAAc,EAAE;YACZ,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;QACD,WAAW,EAAE;YACT,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;SAC9E;KACJ,CAAC,CAAC;AACP,CAAC"}

package/dist/tests/fourslash/diagnostics.missingModuleSource.compiledModule.fourslash.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/fourslash/diagnostics.missingModuleSource.compiledModule.fourslash.js

@@ -0,0 +1,122 @@
+"use strict";
+/// <reference path="typings/fourslash.d.ts" />
+Object.defineProperty(exports, "__esModule", { value: true });
+// A package shipped as a "sourceless distribution": a compiled `.pyc` module sits
+// where the `.py` source would be (directly beside its `.pyi` stub, NOT under
+// `__pycache__`), with no `.py` file. Python imports such a `.pyc` directly, so the
+// module exists at runtime even though it has no Python source. The
+// `reportMissingModuleSource` warning ("could not be resolved from source") is
+// therefore misleading and should NOT fire.
+//
+// This mirrors the native-extension case (a `.pyd`/`.so` backing a `.pyi` stub):
+// a compiled implementation with no Python source is still a real runtime module.
+// --- Top-level compiled module: `mod.pyc` beside `mod.pyi`, no `mod.py`. ---
+// @filename: compiledmod.pyi
+// @library: true
+//// VALUE: int
+// @filename: compiledmod.pyc
+// @library: true
+//// # Compiled bytecode placeholder. Only the file's presence matters to import
+//// # resolution; the text content is never parsed.
+// --- Compiled package + compiled submodule: `__init__.pyc`/`sub.pyc` beside the
+//     stubs, no `.py` anywhere. Exercises the package (`__init__`) layout and the
+//     dotted/submodule resolution paths.
+//
+//     Note: `import compiledpkg` itself does NOT exercise the new `.pyc` branch --
+//     the non-stub pass resolves the package via the pre-existing namespace-package
+//     directory fallback (`foundDirectory` -> `isImportFound`), and `__init__.pyc`
+//     is never probed. The genuinely new-branch cases are the top-level
+//     `compiledmod` and the submodule `compiledpkg.sub` (dotted + `from ... import`). ---
+// @filename: compiledpkg/__init__.pyi
+// @library: true
+//// PKGVALUE: int
+// @filename: compiledpkg/__init__.pyc
+// @library: true
+//// # Compiled bytecode placeholder for the package __init__.
+// @filename: compiledpkg/sub.pyi
+// @library: true
+//// SUBVALUE: int
+// @filename: compiledpkg/sub.pyc
+// @library: true
+//// # Compiled bytecode placeholder for the submodule.
+// --- Compiled module WITHOUT a stub (`.pyc` only, no `.pyi`/`.py`). The `.pyc`
+//     branch is gated on `!allowPyi`, so the stub (primary) resolution must still
+//     fail here and `reportMissingImports` must fire. Regression guard. ---
+// @filename: pyconlymod.pyc
+// @library: true
+//// # Compiled bytecode placeholder; there is no stub for this module.
+// --- `isLastPart` gate guard: a `.pyc` at a NON-leaf (mid-path) position must NOT
+//     partially resolve a dotted import. `midpathmod.pyc` exists but there is no
+//     `midpathmod/` package directory, so `import midpathmod.sub` must still fail
+//     with reportMissingImports. The new branch is gated on `isLastPart`, so a
+//     mid-path `.pyc` can never satisfy a non-leaf component. ---
+// @filename: midpathmod.pyc
+// @library: true
+//// # Compiled bytecode placeholder at a mid-path position; no package directory.
+// --- Stub-only controls (no `.pyc`, no `.py`): `reportMissingModuleSource` MUST
+//     still fire for both a top-level module and a submodule. ---
+// @filename: stubonlymod.pyi
+// @library: true
+//// HELPER: int
+// @filename: stubonlypkg/__init__.pyi
+// @library: true
+//// # Stub-only package (control).
+// @filename: stubonlypkg/missing.pyi
+// @library: true
+//// def helper() -> int: ...
+// @filename: test.py
+//// # Compiled `.pyc` sits beside the `.pyi` stub (no `.py`) -> NO warning.
+//// from compiledmod import VALUE
+//// import compiledmod
+////
+//// # Compiled package (`__init__.pyc` beside `__init__.pyi`, no `__init__.py`) -> NO warning.
+//// import compiledpkg
+//// from compiledpkg import PKGVALUE
+////
+//// # Compiled submodule, dotted (visitModuleName path) -> NO warning.
+//// import compiledpkg.sub
+//// from compiledpkg.sub import SUBVALUE
+////
+//// # Compiled submodule imported as a name (visitImportFromAs submoduleFallback) -> NO warning.
+//// from compiledpkg import sub
+////
+//// # `.pyc` only, no stub: primary (stub) resolution must still fail -> reportMissingImports.
+//// import [|/*markerMissing*/pyconlymod|]
+////
+//// # Mid-path `.pyc` (no package directory): dotted import must still fail (isLastPart gate).
+//// import [|/*markerMidpath*/midpathmod.sub|]
+////
+//// # Stub-only module (no `.pyc`, no `.py`) -> warning MUST still fire (control).
+//// from [|/*marker1*/stubonlymod|] import HELPER
+//// import [|/*marker2*/stubonlymod|]
+////
+//// # Stub-only submodule (no `.pyc`, no `.py`) -> warning MUST still fire (control).
+//// from [|/*marker3*/stubonlypkg.missing|] import helper
+//// from stubonlypkg import [|/*marker4*/missing|]
+helper.verifyDiagnostics({
+    markerMissing: {
+        category: 'error',
+        message: 'Import "pyconlymod" could not be resolved',
+    },
+    markerMidpath: {
+        category: 'error',
+        message: 'Import "midpathmod.sub" could not be resolved',
+    },
+    marker1: {
+        category: 'warning',
+        message: 'Import "stubonlymod" could not be resolved from source',
+    },
+    marker2: {
+        category: 'warning',
+        message: 'Import "stubonlymod" could not be resolved from source',
+    },
+    marker3: {
+        category: 'warning',
+        message: 'Import "stubonlypkg.missing" could not be resolved from source',
+    },
+    marker4: {
+        category: 'warning',
+        message: 'Import "stubonlypkg.missing" could not be resolved from source',
+    },
+});
+//# sourceMappingURL=diagnostics.missingModuleSource.compiledModule.fourslash.js.map

package/dist/tests/fourslash/diagnostics.missingModuleSource.compiledModule.fourslash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostics.missingModuleSource.compiledModule.fourslash.js","sourceRoot":"","sources":["../../../../../../src/tests/fourslash/diagnostics.missingModuleSource.compiledModule.fourslash.ts"],"names":[],"mappings":";AAAA,+CAA+C;;AAE/C,kFAAkF;AAClF,8EAA8E;AAC9E,oFAAoF;AACpF,oEAAoE;AACpE,+EAA+E;AAC/E,4CAA4C;AAC5C,EAAE;AACF,iFAAiF;AACjF,kFAAkF;AAElF,8EAA8E;AAC9E,6BAA6B;AAC7B,iBAAiB;AACjB,eAAe;AAEf,6BAA6B;AAC7B,iBAAiB;AACjB,gFAAgF;AAChF,oDAAoD;AAEpD,iFAAiF;AACjF,kFAAkF;AAClF,yCAAyC;AACzC,EAAE;AACF,mFAAmF;AACnF,oFAAoF;AACpF,mFAAmF;AACnF,wEAAwE;AACxE,0FAA0F;AAC1F,sCAAsC;AACtC,iBAAiB;AACjB,kBAAkB;AAElB,sCAAsC;AACtC,iBAAiB;AACjB,8DAA8D;AAE9D,iCAAiC;AACjC,iBAAiB;AACjB,kBAAkB;AAElB,iCAAiC;AACjC,iBAAiB;AACjB,uDAAuD;AAEvD,gFAAgF;AAChF,kFAAkF;AAClF,4EAA4E;AAC5E,4BAA4B;AAC5B,iBAAiB;AACjB,uEAAuE;AAEvE,mFAAmF;AACnF,iFAAiF;AACjF,kFAAkF;AAClF,+EAA+E;AAC/E,kEAAkE;AAClE,4BAA4B;AAC5B,iBAAiB;AACjB,kFAAkF;AAElF,iFAAiF;AACjF,kEAAkE;AAClE,6BAA6B;AAC7B,iBAAiB;AACjB,gBAAgB;AAEhB,sCAAsC;AACtC,iBAAiB;AACjB,mCAAmC;AAEnC,qCAAqC;AACrC,iBAAiB;AACjB,6BAA6B;AAE7B,qBAAqB;AACrB,4EAA4E;AAC5E,kCAAkC;AAClC,uBAAuB;AACvB,IAAI;AACJ,+FAA+F;AAC/F,uBAAuB;AACvB,qCAAqC;AACrC,IAAI;AACJ,uEAAuE;AACvE,2BAA2B;AAC3B,yCAAyC;AACzC,IAAI;AACJ,iGAAiG;AACjG,gCAAgC;AAChC,IAAI;AACJ,+FAA+F;AAC/F,2CAA2C;AAC3C,IAAI;AACJ,+FAA+F;AAC/F,+CAA+C;AAC/C,IAAI;AACJ,mFAAmF;AACnF,kDAAkD;AAClD,sCAAsC;AACtC,IAAI;AACJ,sFAAsF;AACtF,0DAA0D;AAC1D,mDAAmD;AAEnD,MAAM,CAAC,iBAAiB,CAAC;IACrB,aAAa,EAAE;QACX,QAAQ,EAAE,OAAO;QACjB,OAAO,EAAE,2CAA2C;KACvD;IACD,aAAa,EAAE;QACX,QAAQ,EAAE,OAAO;QACjB,OAAO,EAAE,+CAA+C;KAC3D;IACD,OAAO,EAAE;QACL,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,wDAAwD;KACpE;IACD,OAAO,EAAE;QACL,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,wDAAwD;KACpE;IACD,OAAO,EAAE;QACL,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,gEAAgE;KAC5E;IACD,OAAO,EAAE;QACL,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,gEAAgE;KAC5E;CACJ,CAAC,CAAC"}

package/dist/tests/harness/testAccessHost.d.ts

@@ -8,5 +8,5 @@ export declare class TestAccessHost extends NoAccessHost {
     private _searchPaths;
     private _fs?;
     constructor(_modulePath?: Uri, _searchPaths?: Uri[], _fs?: FileSystem | undefined);
-    getPythonSearchPaths(pythonPath?: Uri, importLogger?: ImportLogger): PythonPathResult;
+    getPythonSearchPaths(pythonPath?: Uri, importLogger?: ImportLogger, cwd?: Uri): PythonPathResult;
 }

package/dist/tests/harness/testAccessHost.js

@@ -18,7 +18,7 @@ class TestAccessHost extends host_1.NoAccessHost {
         this._searchPaths = _searchPaths;
         this._fs = _fs;
     }
-    getPythonSearchPaths(pythonPath, importLogger) {
+    getPythonSearchPaths(pythonPath, importLogger, cwd) {
         // Filter out non-directory paths if filesystem is available
         const filteredPaths = this._fs ? this._searchPaths.filter((p) => (0, uriUtils_1.isDirectory)(this._fs, p)) : this._searchPaths;
         return {

package/dist/tests/harness/testAccessHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"testAccessHost.js","sourceRoot":"","sources":["../../../../../../src/tests/harness/testAccessHost.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAKH,4CAAiD;AACjD,8CAA2C;AAC3C,wDAAwD;AAExD,MAAa,cAAe,SAAQ,mBAAY;IAC5C,YAAoB,cAAc,SAAG,CAAC,KAAK,EAAE,EAAU,eAAsB,EAAE,EAAU,GAAgB;QACrG,KAAK,EAAE,CAAC;QADQ,gBAAW,GAAX,WAAW,CAAc;QAAU,iBAAY,GAAZ,YAAY,CAAY;QAAU,QAAG,GAAH,GAAG,CAAa;IAEzG,CAAC;IAEQ,oBAAoB,CAAC,UAAgB,EAAE,YAA2B;QACvE,4DAA4D;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,sBAAW,EAAC,IAAI,CAAC,GAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;QAEhH,OAAO;YACH,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,IAAI,CAAC,WAAW;SAC3B,CAAC;IACN,CAAC;CACJ;AAdD,wCAcC"}
+{"version":3,"file":"testAccessHost.js","sourceRoot":"","sources":["../../../../../../src/tests/harness/testAccessHost.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAKH,4CAAiD;AACjD,8CAA2C;AAC3C,wDAAwD;AAExD,MAAa,cAAe,SAAQ,mBAAY;IAC5C,YAAoB,cAAc,SAAG,CAAC,KAAK,EAAE,EAAU,eAAsB,EAAE,EAAU,GAAgB;QACrG,KAAK,EAAE,CAAC;QADQ,gBAAW,GAAX,WAAW,CAAc;QAAU,iBAAY,GAAZ,YAAY,CAAY;QAAU,QAAG,GAAH,GAAG,CAAa;IAEzG,CAAC;IAEQ,oBAAoB,CAAC,UAAgB,EAAE,YAA2B,EAAE,GAAS;QAClF,4DAA4D;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,sBAAW,EAAC,IAAI,CAAC,GAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;QAEhH,OAAO;YACH,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,IAAI,CAAC,WAAW;SAC3B,CAAC;IACN,CAAC;CACJ;AAdD,wCAcC"}

package/dist/tests/importResolver.test.js

@@ -52,6 +52,39 @@ describe('Import tests with fake venv', () => {
                 (0, assert_1.default)(importResult.isStubFile);
                 assert_1.default.strictEqual(1, importResult.resolvedUris.filter((f) => !f.isEmpty() && f.getFilePath() === (0, pathUtils_1.combinePaths)(libraryRoot, 'myLib', 'partialStub.pyi')).length);
             });
+            test('symlinked partial stub file exists', () => {
+                const stubSource = (0, pathUtils_1.combinePaths)((0, pathUtils_1.normalizeSlashes)('/'), 'wheel', 'partialStub.pyi');
+                const files = [
+                    {
+                        path: stubSource,
+                        content: 'def test(): ...',
+                    },
+                    {
+                        path: (0, pathUtils_1.combinePaths)(libraryRoot, 'myLib-stubs', 'py.typed'),
+                        content: 'partial\n',
+                    },
+                    {
+                        path: (0, pathUtils_1.combinePaths)(libraryRoot, 'myLib', 'partialStub.py'),
+                        content: 'def test(): pass',
+                    },
+                ];
+                const testFS = createTestFileSystem(files);
+                testFS.symlinkSync(stubSource, (0, pathUtils_1.combinePaths)(libraryRoot, 'myLib-stubs', 'partialStub.pyi'));
+                const fs = new pyrightFileSystem_1.PyrightFileSystem(testFS);
+                const partialStubService = new partialStubService_1.PartialStubService(fs);
+                const sp = (0, serviceProviderExtensions_1.createServiceProvider)(testFS, fs, partialStubService);
+                const configOptions = new configOptions_1.ConfigOptions(uriUtils_1.UriEx.file('/'));
+                const uri = uriUtils_1.UriEx.file(files[files.length - 1].path);
+                const importResolver = new importResolver_1.ImportResolver(sp, configOptions, new testAccessHost_1.TestAccessHost(sp.fs().getModulePath(), [uriUtils_1.UriEx.file(libraryRoot)]));
+                const importResult = importResolver.resolveImport(uri, configOptions.findExecEnvironment(uri), {
+                    leadingDots: 0,
+                    nameParts: ['myLib', 'partialStub'],
+                    importedSymbols: new Set(),
+                });
+                (0, assert_1.default)(importResult.isImportFound);
+                (0, assert_1.default)(importResult.isStubFile);
+                assert_1.default.strictEqual(1, importResult.resolvedUris.filter((f) => f.getFilePath() === (0, pathUtils_1.combinePaths)(libraryRoot, 'myLib', 'partialStub.pyi')).length);
+            });
             test('partial stub __init__ exists', () => {
                 const files = [
                     {