Add stubs for invoke (#6938)

Author: kasium

pyrightconfig.stricter.json

@@ -36,6 +36,7 @@
         "stubs/html5lib",
         "stubs/httplib2",
         "stubs/humanfriendly",
+        "stubs/invoke",
         "stubs/jmespath",
         "stubs/jsonschema",
         "stubs/ldap3",

stubs/invoke/METADATA.toml

@@ -0,0 +1 @@
+version = "1.6.*"

stubs/invoke/invoke/__init__.pyi

@@ -0,0 +1,37 @@
+from typing import Any
+
+from .collection import Collection as Collection
+from .config import Config as Config
+from .context import Context as Context, MockContext as MockContext
+from .exceptions import (
+    AmbiguousEnvVar as AmbiguousEnvVar,
+    AuthFailure as AuthFailure,
+    CollectionNotFound as CollectionNotFound,
+    CommandTimedOut as CommandTimedOut,
+    Exit as Exit,
+    Failure as Failure,
+    ParseError as ParseError,
+    PlatformError as PlatformError,
+    ResponseNotAccepted as ResponseNotAccepted,
+    SubprocessPipeError as SubprocessPipeError,
+    ThreadException as ThreadException,
+    UncastableEnvVar as UncastableEnvVar,
+    UnexpectedExit as UnexpectedExit,
+    UnknownFileType as UnknownFileType,
+    UnpicklableConfigMember as UnpicklableConfigMember,
+    WatcherError as WatcherError,
+)
+from .executor import Executor as Executor
+from .loader import FilesystemLoader as FilesystemLoader
+from .parser import Argument as Argument, Parser as Parser, ParserContext as ParserContext, ParseResult as ParseResult
+from .program import Program as Program
+from .runners import Local as Local, Promise as Promise, Result as Result, Runner as Runner
+from .tasks import Call as Call, Task as Task, call as call, task as task
+from .terminals import pty_size as pty_size
+from .watchers import FailingResponder as FailingResponder, Responder as Responder, StreamWatcher as StreamWatcher
+
+__version_info__: tuple[int, int, int]
+__version__: str
+
+def run(command: str, **kwargs: Any) -> Result: ...
+def sudo(command: str, **kwargs: Any) -> Result: ...

stubs/invoke/invoke/collection.pyi

@@ -0,0 +1,24 @@
+from typing import Any
+
+class Collection:
+    tasks: Any
+    collections: Any
+    default: str | None
+    name: str | None
+    loaded_from: Any
+    auto_dash_names: bool
+    def __init__(self, *args, **kwargs) -> None: ...
+    @classmethod
+    def from_module(cls, module, name=..., config=..., loaded_from=..., auto_dash_names=...): ...
+    def add_task(self, task, name=..., aliases=..., default=...) -> None: ...
+    def add_collection(self, coll, name=..., default=...) -> None: ...
+    def subcollection_from_path(self, path): ...
+    def task_with_config(self, name): ...
+    def to_contexts(self): ...
+    def subtask_name(self, collection_name, task_name): ...
+    def transform(self, name): ...
+    @property
+    def task_names(self): ...
+    def configuration(self, taskpath=...): ...
+    def configure(self, options) -> None: ...
+    def serialized(self): ...

stubs/invoke/invoke/completion/__init__.pyi

@@ -0,0 +1,8 @@
+from typing import Iterable, NoReturn, Sequence
+
+from ..collection import Collection
+from ..parser import ParserContext, ParseResult
+
+def complete(names: Iterable[str], core: ParseResult, initial_context: ParserContext, collection: Collection) -> NoReturn: ...
+def print_task_names(collection: Collection) -> None: ...
+def print_completion_script(shell: str, names: Sequence[str]) -> None: ...

stubs/invoke/invoke/completion/complete.pyi

@@ -0,0 +1,60 @@
+from typing import Any
+
+def load_source(name: str, path: str) -> dict[str, Any]: ...
+
+class DataProxy:
+    @classmethod
+    def from_data(cls, data, root=..., keypath=...): ...
+    def __getattr__(self, key): ...
+    def __setattr__(self, key, value) -> None: ...
+    def __iter__(self): ...
+    def __eq__(self, other): ...
+    __hash__: Any
+    def __len__(self): ...
+    def __setitem__(self, key, value) -> None: ...
+    def __getitem__(self, key): ...
+    def __contains__(self, key): ...
+    def __delitem__(self, key) -> None: ...
+    def __delattr__(self, name) -> None: ...
+    def clear(self) -> None: ...
+    def pop(self, *args): ...
+    def popitem(self): ...
+    def setdefault(self, *args): ...
+    def update(self, *args, **kwargs) -> None: ...
+
+class Config(DataProxy):
+    prefix: str
+    file_prefix: Any
+    env_prefix: Any
+    @staticmethod
+    def global_defaults(): ...
+    def __init__(
+        self,
+        overrides=...,
+        defaults=...,
+        system_prefix=...,
+        user_prefix=...,
+        project_location=...,
+        runtime_path=...,
+        lazy: bool = ...,
+    ) -> None: ...
+    def load_base_conf_files(self) -> None: ...
+    def load_defaults(self, data, merge: bool = ...) -> None: ...
+    def load_overrides(self, data, merge: bool = ...) -> None: ...
+    def load_system(self, merge: bool = ...) -> None: ...
+    def load_user(self, merge: bool = ...) -> None: ...
+    def load_project(self, merge: bool = ...) -> None: ...
+    def set_runtime_path(self, path) -> None: ...
+    def load_runtime(self, merge: bool = ...) -> None: ...
+    def load_shell_env(self) -> None: ...
+    def load_collection(self, data, merge: bool = ...) -> None: ...
+    def set_project_location(self, path) -> None: ...
+    def merge(self) -> None: ...
+    def clone(self, into=...): ...
+
+class AmbiguousMergeError(ValueError): ...
+
+def merge_dicts(base, updates): ...
+def copy_dict(source): ...
+def excise(dict_, keypath) -> None: ...
+def obliterate(base, deletions) -> None: ...

stubs/invoke/invoke/config.pyi

@@ -0,0 +1,22 @@
+from contextlib import AbstractContextManager
+
+from .config import Config, DataProxy
+
+class Context(DataProxy):
+    def __init__(self, config: Config | None = ...) -> None: ...
+    @property
+    def config(self) -> Config: ...
+    @config.setter
+    def config(self, value: Config) -> None: ...
+    def run(self, command: str, **kwargs): ...
+    def sudo(self, command: str, *, password: str = ..., user: str = ..., **kwargs): ...
+    def prefix(self, command: str) -> AbstractContextManager[None]: ...
+    @property
+    def cwd(self) -> str: ...
+    def cd(self, path: str) -> AbstractContextManager[None]: ...
+
+class MockContext(Context):
+    def __init__(self, config: Config | None = ..., **kwargs) -> None: ...
+    def run(self, command: str, *args, **kwargs): ...
+    def sudo(self, command: str, *args, **kwargs): ...
+    def set_result_for(self, attname, command, result) -> None: ...

stubs/invoke/invoke/context.pyi

@@ -0,0 +1,6 @@
+from typing import Any
+
+class Environment:
+    data: Any
+    def __init__(self, config, prefix) -> None: ...
+    def load(self): ...

stubs/invoke/invoke/env.pyi

@@ -0,0 +1,47 @@
+from typing import Any
+
+class CollectionNotFound(Exception):
+    name: Any
+    start: Any
+    def __init__(self, name, start) -> None: ...
+
+class Failure(Exception):
+    result: Any
+    reason: Any
+    def __init__(self, result, reason=...) -> None: ...
+    def streams_for_display(self): ...
+
+class UnexpectedExit(Failure): ...
+
+class CommandTimedOut(Failure):
+    timeout: Any
+    def __init__(self, result, timeout) -> None: ...
+
+class AuthFailure(Failure):
+    result: Any
+    prompt: Any
+    def __init__(self, result, prompt) -> None: ...
+
+class ParseError(Exception):
+    context: Any
+    def __init__(self, msg, context=...) -> None: ...
+
+class Exit(Exception):
+    message: Any
+    def __init__(self, message=..., code=...) -> None: ...
+    @property
+    def code(self): ...
+
+class PlatformError(Exception): ...
+class AmbiguousEnvVar(Exception): ...
+class UncastableEnvVar(Exception): ...
+class UnknownFileType(Exception): ...
+class UnpicklableConfigMember(Exception): ...
+
+class ThreadException(Exception):
+    exceptions: Any
+    def __init__(self, exceptions) -> None: ...
+
+class WatcherError(Exception): ...
+class ResponseNotAccepted(WatcherError): ...
+class SubprocessPipeError(Exception): ...

stubs/invoke/invoke/exceptions.pyi

@@ -0,0 +1,16 @@
+from typing import Any, Iterable
+
+from .collection import Collection
+from .config import Config
+from .parser import ParserContext, ParseResult
+from .tasks import Call, Task
+
+class Executor:
+    collection: Collection
+    config: Config
+    core: ParseResult | None
+    def __init__(self, collection: Collection, config: Config | None = ..., core: ParseResult | None = ...) -> None: ...
+    def execute(self, *tasks: str | tuple[str, dict[str, Any]] | ParserContext) -> dict[Task, Any]: ...
+    def normalize(self, tasks: Iterable[str | tuple[str, dict[str, Any]] | ParserContext]): ...
+    def dedupe(self, calls: Iterable[Call]) -> list[Call]: ...
+    def expand_calls(self, calls: Iterable[Call | Task]) -> list[Call]: ...

stubs/invoke/invoke/executor.pyi

@@ -0,0 +1,15 @@
+from types import ModuleType
+from typing import IO, Any
+
+from . import Config
+
+class Loader:
+    config: Config
+    def __init__(self, config: Config | None = ...) -> None: ...
+    def find(self, name: str) -> tuple[str, IO[Any], str, tuple[str, str, int]]: ...
+    def load(self, name: str | None = ...) -> tuple[ModuleType, str]: ...
+
+class FilesystemLoader(Loader):
+    def __init__(self, start: str | None = ..., **kwargs: Any) -> None: ...
+    @property
+    def start(self) -> str: ...

stubs/invoke/invoke/loader.pyi

@@ -0,0 +1,3 @@
+from . import Program
+
+program: Program

stubs/invoke/invoke/main.pyi

@@ -0,0 +1,3 @@
+from .argument import Argument as Argument
+from .context import ParserContext as ParserContext, to_flag as to_flag, translate_underscores as translate_underscores
+from .parser import *

stubs/invoke/invoke/parser/__init__.pyi

@@ -0,0 +1,37 @@
+from typing import Any
+
+class Argument:
+    names: Any
+    kind: Any
+    raw_value: Any
+    default: Any
+    help: Any
+    positional: Any
+    optional: Any
+    incrementable: Any
+    attr_name: Any
+    def __init__(
+        self,
+        name=...,
+        names=...,
+        kind=...,
+        default=...,
+        help=...,
+        positional: bool = ...,
+        optional: bool = ...,
+        incrementable: bool = ...,
+        attr_name=...,
+    ) -> None: ...
+    @property
+    def name(self): ...
+    @property
+    def nicknames(self): ...
+    @property
+    def takes_value(self): ...
+    @property
+    def value(self): ...
+    @value.setter
+    def value(self, arg) -> None: ...
+    def set_value(self, value, cast: bool = ...): ...
+    @property
+    def got_value(self): ...

stubs/invoke/invoke/parser/argument.pyi

@@ -0,0 +1,24 @@
+from typing import Any
+
+def translate_underscores(name: str) -> str: ...
+def to_flag(name: str) -> str: ...
+def sort_candidate(arg): ...
+def flag_key(x): ...
+
+class ParserContext:
+    args: Any
+    positional_args: Any
+    flags: Any
+    inverse_flags: Any
+    name: Any
+    aliases: Any
+    def __init__(self, name=..., aliases=..., args=...) -> None: ...
+    def add_arg(self, *args, **kwargs) -> None: ...
+    @property
+    def missing_positional_args(self): ...
+    @property
+    def as_kwargs(self): ...
+    def names_for(self, flag): ...
+    def help_for(self, flag): ...
+    def help_tuples(self): ...
+    def flag_names(self): ...

stubs/invoke/invoke/parser/context.pyi

@@ -0,0 +1,42 @@
+from typing import Any
+
+from .context import ParserContext
+
+def is_flag(value: str) -> bool: ...
+def is_long_flag(value: str) -> bool: ...
+
+class Parser:
+    initial: Any
+    contexts: Any
+    ignore_unknown: Any
+    def __init__(self, contexts=..., initial=..., ignore_unknown: bool = ...) -> None: ...
+    def parse_argv(self, argv): ...
+
+class ParseMachine:
+    initial_state: str
+    def changing_state(self, from_, to) -> None: ...
+    ignore_unknown: Any
+    initial: Any
+    flag: Any
+    flag_got_value: bool
+    result: Any
+    contexts: Any
+    def __init__(self, initial, contexts, ignore_unknown) -> None: ...
+    @property
+    def waiting_for_flag_value(self): ...
+    def handle(self, token) -> None: ...
+    def store_only(self, token) -> None: ...
+    def complete_context(self) -> None: ...
+    context: Any
+    def switch_to_context(self, name) -> None: ...
+    def complete_flag(self) -> None: ...
+    def check_ambiguity(self, value): ...
+    def switch_to_flag(self, flag, inverse: bool = ...) -> None: ...
+    def see_value(self, value) -> None: ...
+    def see_positional_arg(self, value) -> None: ...
+    def error(self, msg) -> None: ...
+
+class ParseResult(list[ParserContext]):
+    remainder: str
+    unparsed: Any
+    def __init__(self, *args, **kwargs) -> None: ...