Import from typing, typing_extensions and enum modules on Python 3.8 (#…

…2446)

* "Add .python-version file"

* remove pathlib from dependencies

* change import

* Revert "change import" (:

This reverts commit c70cd57.

* Fix failing unittests on MacOS (#2436)

This commit adopts `unittesting.ViewTestCase` to run view related test cases.

ViewTestCase ...

1. provides `view` and `window` members pointing to a dedicated view, being
   created for testing.
2. ensures not to close empty windows, which was probably the most likely
   reason for unittests failing before on MacOS.

* keep the same order as before

* rchlint

* add release notes

* Import from enum and typing modules

* Keep using fake enums

* Import remaining classes from typing_extensions

* Fix enum types and import from enum module

* Quoted type annotation not needed anymore with the ParamSpec from typing_extensions

---------

Co-authored-by: Предраг Николић <[email protected]>
Co-authored-by: Rafal Chlodnicki <[email protected]>
Co-authored-by: deathaxe <[email protected]>
Co-authored-by: Raoul Wols <[email protected]>

boot.py

@@ -36,7 +36,6 @@
 from .plugin.core.transports import kill_all_subprocesses
 from .plugin.core.tree_view import LspCollapseTreeItemCommand
 from .plugin.core.tree_view import LspExpandTreeItemCommand
-from .plugin.core.typing import Any, Optional, List, Type, Dict
 from .plugin.core.views import LspRunTextCommandHelperCommand
 from .plugin.document_link import LspOpenLinkCommand
 from .plugin.documents import DocumentSyncListener
@@ -86,6 +85,7 @@
 from .plugin.tooling import LspOnDoubleClickCommand
 from .plugin.tooling import LspParseVscodePackageJson
 from .plugin.tooling import LspTroubleshootServerCommand
+from typing import Any, Dict, List, Optional, Type
 
 
 def _get_final_subclasses(derived: List[Type], results: List[Type]) -> None:

dependencies.json

@@ -3,6 +3,7 @@
         ">=4096": [
             "bracex",
             "mdpopups",
+            "typing_extensions",
             "wcmatch"
         ]
     }

plugin/code_actions.py

@@ -11,7 +11,6 @@
 from .core.sessions import AbstractViewListener
 from .core.sessions import SessionBufferProtocol
 from .core.settings import userprefs
-from .core.typing import Any, List, Dict, Callable, Optional, Tuple, TypeGuard, Union, cast
 from .core.views import entire_content_region
 from .core.views import first_selection_region
 from .core.views import format_code_actions_for_quick_panel
@@ -21,6 +20,9 @@
 from abc import ABCMeta
 from abc import abstractmethod
 from functools import partial
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+from typing import cast
+from typing_extensions import TypeGuard
 import sublime
 
 ConfigName = str

plugin/code_lens.py

@@ -2,14 +2,15 @@
 from .core.protocol import CodeLens
 from .core.protocol import CodeLensExtended
 from .core.protocol import Error
-from .core.typing import List, Tuple, Dict, Iterable, Optional, Generator, Union, cast
 from .core.registry import LspTextCommand
 from .core.registry import LspWindowCommand
 from .core.registry import windows
 from .core.views import make_command_link
 from .core.views import range_to_region
 from html import escape as html_escape
 from functools import partial
+from typing import Dict, Generator, Iterable, List, Optional, Tuple, Union
+from typing import cast
 import itertools
 import sublime
 

plugin/color.py

@@ -4,9 +4,9 @@
 from .core.protocol import ColorPresentationParams
 from .core.protocol import Request
 from .core.registry import LspTextCommand
-from .core.typing import List
 from .core.views import range_to_region
 from .core.views import text_document_identifier
+from typing import List
 import sublime
 
 

plugin/completion.py

@@ -19,14 +19,16 @@
 from .core.registry import LspTextCommand
 from .core.sessions import Session
 from .core.settings import userprefs
-from .core.typing import Callable, List, Dict, Optional, Generator, Tuple, Union, cast, Any, TypeGuard
 from .core.views import FORMAT_STRING, FORMAT_MARKUP_CONTENT
 from .core.views import MarkdownLangMap
 from .core.views import minihtml
 from .core.views import range_to_region
 from .core.views import show_lsp_popup
 from .core.views import text_document_position_params
 from .core.views import update_lsp_popup
+from typing import Any, Callable, Dict, Generator, List, Optional, Tuple, Union
+from typing import cast
+from typing_extensions import TypeGuard
 import functools
 import html
 import sublime

plugin/core/active_request.py

@@ -3,7 +3,7 @@
 from .progress import ViewProgressReporter
 from .progress import WindowProgressReporter
 from .protocol import Request
-from .typing import Any, Optional, Dict
+from typing import Any, Dict, Optional
 from weakref import ref
 import sublime
 

plugin/core/collections.py

@@ -1,8 +1,8 @@
 """
 Module with additional collections.
 """
-from .typing import Optional, Dict, Any, Generator
 from copy import deepcopy
+from typing import Any, Dict, Generator, Optional
 import sublime
 
 

plugin/core/configurations.py

@@ -2,13 +2,13 @@
 from .logging import exception_log
 from .logging import printf
 from .types import ClientConfig
-from .typing import Generator, List, Optional, Set, Dict, Deque
 from .url import parse_uri
 from .workspace import enable_in_project, disable_in_project
 from abc import ABCMeta
 from abc import abstractmethod
 from collections import deque
 from datetime import datetime, timedelta
+from typing import Deque, Dict, Generator, List, Optional, Set
 from weakref import WeakSet
 import sublime
 

plugin/core/constants.py

@@ -3,7 +3,7 @@
 from .protocol import DiagnosticSeverity
 from .protocol import DocumentHighlightKind
 from .protocol import SymbolKind
-from .typing import Dict, Tuple
+from typing import Dict, Tuple
 import sublime
 
 

plugin/core/css.py

@@ -1,5 +1,5 @@
+from typing import Optional
 import sublime
-from .typing import Optional
 
 
 class CSS:

plugin/core/diagnostics_storage.py

@@ -1,8 +1,8 @@
 from .protocol import Diagnostic, DiagnosticSeverity, DocumentUri
-from .typing import Callable, Iterator, List, Tuple, TypeVar
 from .url import parse_uri
 from .views import diagnostic_severity
 from collections import OrderedDict
+from typing import Callable, Iterator, List, Tuple, TypeVar
 import functools
 
 ParsedUri = Tuple[str, str]

plugin/core/edit.py

@@ -3,7 +3,7 @@
 from .protocol import TextEdit
 from .protocol import UINT_MAX
 from .protocol import WorkspaceEdit
-from .typing import List, Dict, Optional, Tuple
+from typing import Dict, List, Optional, Tuple
 import sublime
 
 

plugin/core/file_watcher.py

@@ -1,8 +1,8 @@
 from .protocol import FileChangeType
 from .protocol import WatchKind
-from .typing import List, Literal, Optional, Protocol, Tuple, Type, Union
 from abc import ABCMeta
 from abc import abstractmethod
+from typing import List, Literal, Optional, Protocol, Tuple, Type, Union
 
 DEFAULT_KIND = WatchKind.Create | WatchKind.Change | WatchKind.Delete
 

plugin/core/input_handlers.py

@@ -1,8 +1,9 @@
 from .constants import ST_VERSION
-from .typing import Any, Callable, Dict, List, Optional, ParamSpec, Tuple, Union
-from .typing import final
 from abc import ABCMeta
 from abc import abstractmethod
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+from typing import final
+from typing_extensions import ParamSpec
 import functools
 import sublime
 import sublime_plugin

plugin/core/logging.py

@@ -1,4 +1,4 @@
-from .typing import Any
+from typing import Any
 import traceback
 import inspect
 import sublime

plugin/core/message_request_handler.py

@@ -2,9 +2,9 @@
 from .protocol import Response
 from .protocol import ShowMessageRequestParams
 from .sessions import Session
-from .typing import Any, Dict, List
 from .views import show_lsp_popup
 from .views import text2html
+from typing import Any, Dict, List
 import sublime
 
 

plugin/core/open.py

@@ -5,10 +5,10 @@
 from .protocol import DocumentUri
 from .protocol import Range
 from .protocol import UINT_MAX
-from .typing import Dict, Tuple, Optional
-from .typing import cast
 from .url import parse_uri
 from .views import range_to_region
+from typing import Dict, Optional, Tuple
+from typing import cast
 from urllib.parse import unquote, urlparse
 import os
 import re

plugin/core/panels.py

@@ -1,6 +1,6 @@
 from .types import PANEL_FILE_REGEX
 from .types import PANEL_LINE_REGEX
-from .typing import Iterable, Optional
+from typing import Iterable, Optional
 import sublime
 
 

plugin/core/paths.py

@@ -1,8 +1,8 @@
 from .protocol import DocumentUri
 from .sessions import Session
-from .typing import Iterable, Optional, Tuple
 from .views import parse_uri
 from pathlib import Path
+from typing import Iterable, Optional, Tuple
 
 
 def simple_path(session: Optional[Session], uri: DocumentUri) -> str:

plugin/core/progress.py

@@ -1,5 +1,5 @@
+from typing import Optional, Union
 import sublime
-from .typing import Optional, Union
 
 
 class ProgressReporter:

plugin/core/promise.py

@@ -1,4 +1,4 @@
-from .typing import Callable, Generic, List, Optional, Protocol, Tuple, TypeVar, Union
+from typing import Callable, Generic, List, Optional, Protocol, Tuple, TypeVar, Union
 import functools
 import threading
 

plugin/core/protocol.py

@@ -1,6 +1,8 @@
-from .typing import Enum, IntEnum, IntFlag, StrEnum
-from .typing import Any, Dict, Generic, Iterable, List, Literal, Mapping, NotRequired, Optional, TypedDict, TypeVar, Union  # noqa: E501
+from .typing import StrEnum
+from enum import IntEnum, IntFlag
 from functools import total_ordering
+from typing import Any, Dict, Generic, Iterable, List, Literal, Mapping, Optional, TypedDict, TypeVar, Union
+from typing_extensions import NotRequired
 import sublime
 
 INT_MAX = 2**31 - 1
@@ -14,7 +16,7 @@
 RegExp = str
 
 
-class SemanticTokenTypes(Enum):
+class SemanticTokenTypes(StrEnum):
     """ A set of predefined token types. This set is not fixed
     an clients can specify additional token types via the
     corresponding client capabilities.
@@ -48,7 +50,7 @@ class SemanticTokenTypes(Enum):
     """ @since 3.17.0 """
 
 
-class SemanticTokenModifiers(Enum):
+class SemanticTokenModifiers(StrEnum):
     """ A set of predefined token modifiers. This set is not fixed
     an clients can specify additional token types via the
     corresponding client capabilities.
@@ -66,7 +68,7 @@ class SemanticTokenModifiers(Enum):
     DefaultLibrary = 'defaultLibrary'
 
 
-class DocumentDiagnosticReportKind(Enum):
+class DocumentDiagnosticReportKind(StrEnum):
     """ The document diagnostic report kinds.
 
     @since 3.17.0 """
@@ -167,7 +169,7 @@ class SymbolTag(IntEnum):
     """ Render a symbol as obsolete, usually using a strike-out. """
 
 
-class UniquenessLevel(Enum):
+class UniquenessLevel(StrEnum):
     """ Moniker uniqueness level to define scope of the moniker.
 
     @since 3.16.0 """
@@ -183,7 +185,7 @@ class UniquenessLevel(Enum):
     """ The moniker is globally unique """
 
 
-class MonikerKind(Enum):
+class MonikerKind(StrEnum):
     """ The moniker kind.
 
     @since 3.16.0 """
@@ -383,7 +385,7 @@ class CodeActionKind(StrEnum):
     @since 3.15.0 """
 
 
-class TraceValues(Enum):
+class TraceValues(StrEnum):
     Off = 'off'
     """ Turn tracing off. """
     Messages = 'messages'
@@ -392,7 +394,7 @@ class TraceValues(Enum):
     """ Verbose message tracing. """
 
 
-class MarkupKind(Enum):
+class MarkupKind(StrEnum):
     """ Describes the content type that a client supports in various
     result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
 
@@ -415,7 +417,7 @@ class InlineCompletionTriggerKind(IntEnum):
     """ Completion was triggered automatically while editing. """
 
 
-class PositionEncodingKind(Enum):
+class PositionEncodingKind(StrEnum):
     """ A set of predefined position encoding kinds.
 
     @since 3.17.0 """
@@ -517,7 +519,7 @@ class CodeActionTriggerKind(IntEnum):
     also be triggered when file content changes. """
 
 
-class FileOperationPatternKind(Enum):
+class FileOperationPatternKind(StrEnum):
     """ A pattern kind describing if a glob pattern matches a file a folder or
     both.
 
@@ -538,7 +540,7 @@ class NotebookCellKind(IntEnum):
     """ A code-cell is source code. """
 
 
-class ResourceOperationKind(Enum):
+class ResourceOperationKind(StrEnum):
     Create = 'create'
     """ Supports creating new files and folders. """
     Rename = 'rename'
@@ -547,7 +549,7 @@ class ResourceOperationKind(Enum):
     """ Supports deleting existing files and folders. """
 
 
-class FailureHandlingKind(Enum):
+class FailureHandlingKind(StrEnum):
     Abort = 'abort'
     """ Applying the workspace change is simply aborted if one of the changes provided
     fails. All operations executed before the failing operation stay executed. """
@@ -569,7 +571,7 @@ class PrepareSupportDefaultBehavior(IntEnum):
     according the to language's syntax rule. """
 
 
-class TokenFormat(Enum):
+class TokenFormat(StrEnum):
     Relative = 'relative'
 
 

plugin/core/registry.py

@@ -3,7 +3,6 @@
 from .protocol import LocationLink
 from .sessions import AbstractViewListener
 from .sessions import Session
-from .typing import Optional, Any, Generator, Iterable, List, Union
 from .views import first_selection_region
 from .views import get_uri_and_position_from_location
 from .views import MissingUriError
@@ -12,6 +11,7 @@
 from .windows import WindowManager
 from .windows import WindowRegistry
 from functools import partial
+from typing import Any, Generator, Iterable, List, Optional, Union
 import operator
 import sublime
 import sublime_plugin