@zzzen/pyright-internal 1.1.255 → 1.2.0-dev.20220703

package/src/tests/fourslash/fourslash.ts

@@ -1,411 +0,0 @@
-/*
- * fourslash.ts
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT license.
- *
- * this file only exists for the richer editing experiences on *.fourslash.ts files.
- * when fourslash tests are actually running this file is not used.
- *
- * this basically provides type information through // <reference .. > while editing but
- * get ignored when test run due to how test code is injected when running.
- * see - server\pyright\server\src\tests\harness\fourslash\runner.ts@runCode - for more detail
- *
- * when run, helper variable will be bount to TestState (server\pyright\server\src\tests\harness\fourslash\testState.ts)
- * so make sure Foruslash type is in sync with TestState
- *
- * for how markup language and helper is used in fourslash tests, see these 2 tests
- * server\pyright\server\src\tests\fourSlashParser.test.ts
- * server\pyright\server\src\tests\testState.test.ts
- *
- * for debugging, open *.fourslash.ts test file you want to debug, and select "fourslash current file" as debug configuration
- * and set break point in one of TestState methods you are using in the test or set break point on "runCode" above
- * and hit F5.
- */
-
-declare namespace _ {
-    type CompletionItemKind =
-        | 1
-        | 2
-        | 3
-        | 4
-        | 5
-        | 6
-        | 7
-        | 8
-        | 9
-        | 10
-        | 11
-        | 12
-        | 13
-        | 14
-        | 15
-        | 16
-        | 17
-        | 18
-        | 19
-        | 20
-        | 21
-        | 22
-        | 23
-        | 24
-        | 25;
-
-    type FourSlashCompletionVerificationMode = 'exact' | 'included' | 'excluded';
-    interface FourSlashCompletionItem {
-        label: string;
-        kind: CompletionItemKind | undefined;
-        insertionText?: string;
-        documentation?: string;
-        detail?: string;
-        textEdit?: TextEdit;
-        additionalTextEdits?: TextEdit[];
-        detailDescription?: string;
-    }
-
-    interface TextRange {
-        start: number;
-        length: number;
-    }
-
-    interface LineAndColumn {
-        // Both line and column are zero-based
-        line: number;
-        column: number;
-    }
-
-    interface Marker {
-        fileName: string;
-        position: number;
-        data?: {};
-    }
-
-    interface Range {
-        fileName: string;
-        marker?: Marker;
-        pos: number;
-        end: number;
-    }
-
-    interface TextChange {
-        span: TextRange;
-        newText: string;
-    }
-
-    interface Command {
-        title: string;
-        command: string;
-        arguments?: any[];
-    }
-
-    interface Position {
-        // Both line and column are zero-based
-        line: number;
-        character: number;
-    }
-
-    interface PositionRange {
-        start: Position;
-        end: Position;
-    }
-
-    interface TextEdit {
-        range: PositionRange;
-        newText: string;
-    }
-
-    interface DocumentRange {
-        path: string;
-        range: PositionRange;
-    }
-
-    interface TextEditAction {
-        range: PositionRange;
-        replacementText: string;
-    }
-
-    interface FileEditAction extends TextEditAction {
-        filePath: string;
-    }
-
-    type DocumentHighlightKind = 1 | 2 | 3;
-
-    interface DocumentHighlight {
-        range: PositionRange;
-        kind?: DocumentHighlightKind;
-    }
-
-    interface AbbreviationInfo {
-        importFrom?: string;
-        importName: string;
-    }
-
-    interface TextDocumentIdentifier {
-        uri: string;
-    }
-
-    interface OptionalVersionedTextDocumentIdentifier extends TextDocumentIdentifier {
-        version: number | null;
-    }
-
-    interface AnnotatedTextEdit extends TextEdit {
-        annotationId: string;
-    }
-
-    interface TextDocumentEdit {
-        textDocument: OptionalVersionedTextDocumentIdentifier;
-        edits: (TextEdit | AnnotatedTextEdit)[];
-    }
-
-    interface FileOptions {
-        overwrite?: boolean;
-        ignoreIfExists?: boolean;
-    }
-
-    interface ResourceOperation {
-        kind: string;
-        annotationId?: string;
-    }
-
-    interface CreateFile extends ResourceOperation {
-        kind: 'create';
-        uri: string;
-        options?: FileOptions;
-    }
-
-    interface RenameFile extends ResourceOperation {
-        kind: 'rename';
-        oldUri: string;
-        newUri: string;
-        options?: FileOptions;
-    }
-
-    interface DeleteFileOptions {
-        recursive?: boolean;
-        ignoreIfNotExists?: boolean;
-    }
-
-    interface DeleteFile extends ResourceOperation {
-        kind: 'delete';
-        uri: string;
-        options?: DeleteFileOptions;
-    }
-
-    interface ChangeAnnotation {
-        label: string;
-        needsConfirmation?: boolean;
-        description?: string;
-    }
-
-    interface WorkspaceEdit {
-        changes?: {
-            [uri: string]: TextEdit[];
-        };
-        documentChanges?: (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[];
-        changeAnnotations?: {
-            [id: string]: ChangeAnnotation;
-        };
-    }
-
-    type MarkupKind = 'markdown' | 'plaintext';
-
-    type DefinitionFilter = 'all' | 'preferSource' | 'preferStubs';
-
-    interface Fourslash {
-        getMappedFilePath(path: string): string;
-        getDocumentHighlightKind(m?: Marker): DocumentHighlightKind | undefined;
-
-        getMarkerName(m: Marker): string;
-        getMarkerByName(markerName: string): Marker;
-        getMarkerNames(): string[];
-        getMarkers(): Marker[];
-
-        getRanges(): Range[];
-        getRangesInFile(fileName: string): Range[];
-        getRangesByText(): Map<string, Range[]>;
-        getFilteredRanges<T extends {}>(
-            predicate: (m: Marker | undefined, d: T | undefined, text: string) => boolean
-        ): Range[];
-        getPositionRange(markerString: string): PositionRange;
-        expandPositionRange(range: PositionRange, start: number, end: number): PositionRange;
-        convertPositionRange(range: Range): PositionRange;
-        convertPathToUri(path: string): string;
-        getDirectoryPath(path: string): string;
-
-        goToBOF(): void;
-        goToEOF(): void;
-        goToPosition(positionOrLineAndColumn: number | LineAndColumn): void;
-        goToMarker(nameOrMarker: string | Marker): void;
-        goToEachMarker(markers: readonly Marker[], action: (marker: Marker, index: number) => void): void;
-        goToEachRange(action: (range: Range) => void): void;
-        goToRangeStart({ fileName, pos }: Range): void;
-
-        select(startMarker: string, endMarker: string): void;
-        selectAllInFile(fileName: string): void;
-        selectRange(range: Range): void;
-        selectLine(index: number): void;
-
-        moveCaretRight(count: number): void;
-
-        openFile(indexOrName: number | string): void;
-        openFiles(indexOrNames: (number | string)[]): void;
-
-        verifyDiagnostics(map?: { [marker: string]: { category: string; message: string } }): void;
-        verifyCodeActions(
-            map: {
-                [marker: string]: {
-                    codeActions: { title: string; kind: string; command?: Command; edit?: WorkspaceEdit }[];
-                };
-            },
-            verifyCodeActionCount?: boolean
-        ): Promise<any>;
-        verifyCommand(command: Command, files: { [filePath: string]: string }): Promise<any>;
-        verifyInvokeCodeAction(
-            map: {
-                [marker: string]: { title: string; files?: { [filePath: string]: string }; edits?: TextEdit[] };
-            },
-            verifyCodeActionCount?: boolean
-        ): Promise<any>;
-        verifyHover(kind: string, map: { [marker: string]: string | null }): void;
-        verifyCompletion(
-            verifyMode: FourSlashCompletionVerificationMode,
-            docFormat: MarkupKind,
-            map: {
-                [marker: string]: {
-                    completions: FourSlashCompletionItem[];
-                    memberAccessInfo?: {
-                        lastKnownModule?: string;
-                        lastKnownMemberName?: string;
-                        unknownMemberName?: string;
-                    };
-                };
-            },
-            abbrMap?: { [abbr: string]: AbbreviationInfo }
-        ): Promise<void>;
-        verifySignature(
-            docFormat: MarkupKind,
-            map: {
-                [marker: string]: {
-                    noSig?: boolean;
-                    signatures?: {
-                        label: string;
-                        parameters: string[];
-                        documentation?: string;
-                    }[];
-                    activeParameters?: (number | undefined)[];
-                    callHasParameters?: boolean;
-                };
-            }
-        ): void;
-        verifyFindAllReferences(map: {
-            [marker: string]: {
-                references: DocumentRange[];
-            };
-        }): void;
-        verifyHighlightReferences(map: {
-            [marker: string]: {
-                references: DocumentHighlight[];
-            };
-        }): void;
-        verifyFindDefinitions(
-            map: {
-                [marker: string]: {
-                    definitions: DocumentRange[];
-                };
-            },
-            filter?: DefinitionFilter
-        ): void;
-        verifyFindTypeDefinitions(map: {
-            [marker: string]: {
-                definitions: DocumentRange[];
-            };
-        }): void;
-        verifyRename(map: {
-            [marker: string]: {
-                newName: string;
-                changes: FileEditAction[];
-            };
-        }): void;
-
-        /* not tested yet
-        paste(text: string): void;
-
-        type(text: string): void;
-        replace(start: number, length: number, text: string): void;
-        deleteChar(count: number): void;
-        deleteLineRange(startIndex: number, endIndexInclusive: number): void;
-        deleteCharBehindMarker(count: number): void;
-
-        verifyCaretAtMarker(markerName: string): void;
-        verifyCurrentLineContent(text: string): void;
-        verifyCurrentFileContent(text: string): void;
-        verifyTextAtCaretIs(text: string): void;
-        verifyRangeIs(expectedText: string, includeWhiteSpace?: boolean): void;
-
-        setCancelled(numberOfCalls: number): void;
-        resetCancelled(): void; */
-    }
-}
-
-declare var helper: _.Fourslash;
-
-declare namespace Consts {
-    export namespace MarkupKind {
-        export const PlainText = 'plaintext';
-        export const Markdown = 'markdown';
-    }
-
-    export namespace CodeActionKind {
-        export const QuickFix = 'quickfix';
-        export const Refactor = 'refactor';
-    }
-
-    export enum Commands {
-        createTypeStub = 'pyright.createtypestub',
-        restartServer = 'pyright.restartserver',
-        orderImports = 'pyright.organizeimports',
-        addMissingOptionalToParam = 'pyright.addoptionalforparam',
-    }
-
-    namespace DocumentHighlightKind {
-        /**
-         * A textual occurrence.
-         */
-        const Text: 1;
-        /**
-         * Read-access of a symbol, like reading a variable.
-         */
-        const Read: 2;
-        /**
-         * Write-access of a symbol, like writing to a variable.
-         */
-        const Write: 3;
-    }
-
-    namespace CompletionItemKind {
-        const Text: 1;
-        const Method: 2;
-        const Function: 3;
-        const Constructor: 4;
-        const Field: 5;
-        const Variable: 6;
-        const Class: 7;
-        const Interface: 8;
-        const Module: 9;
-        const Property: 10;
-        const Unit: 11;
-        const Value: 12;
-        const Enum: 13;
-        const Keyword: 14;
-        const Snippet: 15;
-        const Color: 16;
-        const File: 17;
-        const Reference: 18;
-        const Folder: 19;
-        const EnumMember: 20;
-        const Constant: 21;
-        const Struct: 22;
-        const Event: 23;
-        const Operator: 24;
-        const TypeParameter: 25;
-    }
-}

package/src/tests/fourslash/highlightreferences.attributes.fourslash.ts

@@ -1,31 +0,0 @@
-/// <reference path="fourslash.ts" />
-
-// @filename: test.py
-//// class DummyClass:
-////     def __init__(self):
-////         self.[|{| "kind":"write" |}var|] = 1
-////         self.[|{| "kind":"write" |}var|] += 1
-////
-////     def method_1(self):
-////         self.[|{| "kind":"write" |}var|] += 2
-////         self.[|{| "kind":"write" |}var|] = None
-////
-////     def method_2(self):
-////         self.[|{| "kind":"write" |}var|] += 3
-////         self.[|{| "kind":"write" |}var|] = None
-////         self.[|{| "name":"marker", "kind":"write" |}var|] = 1
-////
-//// x = DummyClass()
-//// print(x.[|{| "kind":"read" |}var|])
-
-{
-    const ranges = helper.getRanges();
-
-    helper.verifyHighlightReferences({
-        marker: {
-            references: ranges.map((r) => {
-                return { range: helper.convertPositionRange(r), kind: helper.getDocumentHighlightKind(r.marker) };
-            }),
-        },
-    });
-}

package/src/tests/fourslash/hover.builtinDocstrings.fourslash.ts

@@ -1,64 +0,0 @@
-/// <reference path="fourslash.ts" />
-
-// @filename: docstrings.py
-//// [|/*object*/object|]
-//// [|/*objectInit*/object|]()
-//// object().[|/*objectDir*/__dir__|]
-////
-//// class A: ...
-////
-//// [|/*a*/A|]
-//// [|/*aInit*/A|]()
-//// A().[|/*aDir*/__dir__|]
-////
-//// class B:
-////     """This is the class doc for B."""
-////     def __init__(self):
-////         """This is the __init__ doc for B."""
-////
-//// [|/*b*/B|]
-//// [|/*bInit*/B|]()
-////
-//// class C:
-////     """This is the class doc for C."""
-////     def __init__(self):
-////         pass
-////
-//// [|/*c*/C|]
-//// [|/*cInit*/C|]()
-////
-//// class D:
-////     def __init__(self):
-////         """This is the __init__ doc for D."""
-////         pass
-////
-//// [|/*d*/D|]
-//// [|/*dInit*/D|]()
-
-// @filename: typeshed-fallback/stdlib/builtins.py
-//// class object():
-////     """This is the class doc for object."""
-////     def __init__(self):
-////         """This is the __init__ doc for object."""
-////         pass
-////
-////     def __dir__(self):
-////         """This is the __dir__ doc for object."""
-////         pass
-
-{
-    helper.verifyHover('plaintext', {
-        object: '(class) object\n\nThis is the class doc for object.',
-        objectInit: '(class) object()\n\nThis is the __init__ doc for object.',
-        objectDir: '(method) __dir__: () -> Iterable[str]\n\nThis is the __dir__ doc for object.',
-        a: '(class) A',
-        aInit: '(class) A()',
-        aDir: '(method) __dir__: () -> Iterable[str]',
-        b: '(class) B\n\nThis is the class doc for B.',
-        bInit: '(class) B()\n\nThis is the __init__ doc for B.',
-        c: '(class) C\n\nThis is the class doc for C.',
-        cInit: '(class) C()\n\nThis is the class doc for C.',
-        d: '(class) D',
-        dInit: '(class) D()\n\nThis is the __init__ doc for D.',
-    });
-}

package/src/tests/fourslash/hover.classNoInit.fourslash.ts

@@ -1,14 +0,0 @@
-/// <reference path="fourslash.ts" />
-
-// @filename: test.py
-//// class Something:
-////     '''This is a test.'''
-////
-////     def __init__(self, text: str) -> None:
-////         self.text = text
-////
-//// [|/*marker1*/Something|]()
-
-helper.verifyHover('markdown', {
-    marker1: '```python\n(class) Something(text: str)\n```\n---\nThis is a test.',
-});

package/src/tests/fourslash/hover.docFromScr.stringFormat.fourslash.ts

@@ -1,52 +0,0 @@
-/// <reference path="fourslash.ts" />
-
-// @filename: test.py
-
-//// # empty string
-//// [|/*marker1*/emptySingleQuotes|]= ''
-//// [|/*marker2*/emptyDoubleQuotes|]= ""
-//// [|/*marker3*/emptyTripleQuotes|]= ''''''
-//// [|/*marker4*/emptyTripleDoubleQuotes|]= """"""
-
-//// # simple string
-//// [|/*marker5*/simpleSingleQuotes|]= 'a'
-//// [|/*marker6*/simpleDoubleQuotes|]= "b"
-//// [|/*marker7*/simpleTripleQuotes|]= '''foo\nbar'''
-//// [|/*marker8*/simpleTripleDoubleQuotes|]= """foo\nbar"""
-
-//// # escaped quotes
-//// [|/*marker9*/singleQuotesWithEscapedQuote|]= '\''
-//// [|/*marker10*/doubleQuotesWithEscapedQuote|]= "\""
-//// [|/*marker11*/tripleQuotesWithEscapedQuote|]= '''\n\'\'\''''
-//// [|/*marker12*/tripleDoubleQuotesWithEscapedQuote|]= """\n\"\"\""""
-
-//// # mixing quotes
-//// [|/*marker13*/singleQuotesWithDouble|]= '"'
-//// [|/*marker14*/singleQuotesWithTripleDouble|]= '"""'
-//// [|/*marker15*/singleTripleQuoteWithSingleAndDoubleQuote|]= ''' '"' '''
-
-//// # multiline (truncated)
-//// const [|/*marker16*/html|] = '''<!DOCTYPE html><html lang="en">\n<head><title>Title</title></head></html>'''
-//// const [|/*marker17*/htmlWithSingleQuotes|] = '''<!DOCTYPE html><html lang="en">\n<head><title>Title's</title></head></html>'''
-//// const [|/*marker18*/htmlWithTripleEscapedQuotes|] = '''<!DOCTYPE html><html lang="en">\n<head><title>Title\'\'\'s</title></head></html>'''
-
-helper.verifyHover('markdown', {
-    marker1: `\`\`\`python\n(variable) emptySingleQuotes: Literal['']\n\`\`\``,
-    marker2: `\`\`\`python\n(variable) emptyDoubleQuotes: Literal['']\n\`\`\``,
-    marker3: `\`\`\`python\n(variable) emptyTripleQuotes: Literal['']\n\`\`\``,
-    marker4: `\`\`\`python\n(variable) emptyTripleDoubleQuotes: Literal['']\n\`\`\``,
-    marker5: `\`\`\`python\n(variable) simpleSingleQuotes: Literal['a']\n\`\`\``,
-    marker6: `\`\`\`python\n(variable) simpleDoubleQuotes: Literal['b']\n\`\`\``,
-    marker7: `\`\`\`python\n(variable) simpleTripleQuotes: Literal['foo\\nbar']\n\`\`\``,
-    marker8: `\`\`\`python\n(variable) simpleTripleDoubleQuotes: Literal['foo\\nbar']\n\`\`\``,
-    marker9: `\`\`\`python\n(variable) singleQuotesWithEscapedQuote: Literal['\\\'']\n\`\`\``,
-    marker10: `\`\`\`python\n(variable) doubleQuotesWithEscapedQuote: Literal['"']\n\`\`\``,
-    marker11: `\`\`\`python\n(variable) tripleQuotesWithEscapedQuote: Literal['\\n\\'\\'\\'']\n\`\`\``,
-    marker12: `\`\`\`python\n(variable) tripleDoubleQuotesWithEscapedQuote: Literal['\\n"""']\n\`\`\``,
-    marker13: `\`\`\`python\n(variable) singleQuotesWithDouble: Literal['"']\n\`\`\``,
-    marker14: `\`\`\`python\n(variable) singleQuotesWithTripleDouble: Literal['"""']\n\`\`\``,
-    marker15: `\`\`\`python\n(variable) singleTripleQuoteWithSingleAndDoubleQuote: Literal[' \\'"\\' ']\n\`\`\``,
-    marker16: `\`\`\`python\n(variable) html: Literal['<!DOCTYPE html><html lang="en">\\n<head><title>Title…']\n\`\`\``,
-    marker17: `\`\`\`python\n(variable) htmlWithSingleQuotes: Literal['<!DOCTYPE html><html lang="en">\\n<head><title>Title…']\n\`\`\``,
-    marker18: `\`\`\`python\n(variable) htmlWithTripleEscapedQuotes: Literal['<!DOCTYPE html><html lang="en">\\n<head><title>Title…']\n\`\`\``,
-});

package/src/tests/fourslash/hover.docFromSrc.fourslash.ts

@@ -1,83 +0,0 @@
-/// <reference path="fourslash.ts" />
-
-// @filename: module1.py
-//// '''module1 docs'''
-////
-//// def func1():
-////     '''func1 docs'''
-////     return True
-////
-//// class A:
-////     '''A docs'''
-////     def method1(self):
-////         '''A.method1 docs'''
-////         return True
-////     class Inner:
-////         '''A.Inner docs'''
-////         def method1(self):
-////             '''A.Inner.method1 docs'''
-////             return True
-////
-//// class B:
-////     '''B docs'''
-////     def __init__(self):
-////         '''B init docs'''
-////         pass
-
-// @filename: module1.pyi
-//// def func1() -> bool: ...
-////
-//// class A:
-////     def method1(self) -> bool: ...
-////     class Inner:
-////         def method1(self) -> bool: ...
-////
-//// class B:
-////     def __init__(self): ...
-
-// @filename: module2/__init__.py
-// @library: true
-//// '''module2 docs'''
-////
-//// from ._internal import func2
-
-// @filename: module2/_internal.py
-// @library: true
-//// from ._more_internal import func2
-
-// @filename: module2/_more_internal.py
-// @library: true
-//// def func2():
-////     '''func2 docs'''
-////     return True
-
-// @filename: typings/module2.pyi
-//// def func2() -> bool: ...
-
-// @filename: test.py
-//// import module1
-//// import module2
-////
-//// print([|/*module1_docs*/module1|].[|/*func1_docs*/func1|]())
-////
-//// a = module1.[|/*a_docs*/A|]()
-//// print(a.[|/*method1_docs*/method1|]())
-////
-//// b = module1.[|/*b_docs*/B|]()
-////
-//// print([|/*module2_docs*/module2|].[|/*func2_docs*/func2|]())
-////
-//// inner = module1.A.[|/*a_inner_docs*/Inner|]()
-//// print(inner.[|/*inner_method1_docs*/method1|]())
-
-helper.verifyHover('markdown', {
-    a_docs: '```python\n(class) A()\n```\n---\nA docs',
-    b_docs: '```python\n(class) B()\n```\n---\nB init docs',
-    a_inner_docs: '```python\n(class) Inner()\n```\n---\nA.Inner docs',
-    func1_docs: '```python\n(function) func1: () -> bool\n```\n---\nfunc1 docs',
-    func2_docs: '```python\n(function) func2: () -> bool\n```\n---\nfunc2 docs',
-    inner_method1_docs: '```python\n(method) method1: () -> bool\n```\n---\nA.Inner.method1 docs',
-    method1_docs: '```python\n(method) method1: () -> bool\n```\n---\nA.method1 docs',
-    module1_docs: '```python\n(module) module1\n```\n---\nmodule1 docs',
-    module2_docs: '```python\n(module) module2\n```\n---\nmodule2 docs',
-});

package/src/tests/fourslash/hover.docFromSrc.pkg-vs-module1.fourslash.ts

@@ -1,26 +0,0 @@
-/// <reference path="fourslash.ts" />
-
-// @filename: package1/__init__.py
-// @library: true
-//// from .subpackage import func1
-
-// @filename: package1/subpackage.py
-// @library: true
-//// def func1():
-////     '''func1 docs'''
-////     return True
-
-// @filename: typings/package1/__init__.pyi
-//// from .subpackage import func1 as func1
-
-// @filename: typings/package1/subpackage/__init__.pyi
-//// def func1() -> bool: ...
-
-// @filename: test.py
-//// from package1 import func1
-////
-//// print([|/*func1_docs*/func1|]())
-
-helper.verifyHover('markdown', {
-    func1_docs: '```python\n(function) func1: () -> bool\n```\n---\nfunc1 docs',
-});