massive update, probably broken
[dotfiles/.git] / .config / coc / extensions / coc-python-data / languageServer.0.5.59 / Typeshed / stdlib / 2 / pydoc.pyi
diff --git a/.config/coc/extensions/coc-python-data/languageServer.0.5.59/Typeshed/stdlib/2/pydoc.pyi b/.config/coc/extensions/coc-python-data/languageServer.0.5.59/Typeshed/stdlib/2/pydoc.pyi
new file mode 100644 (file)
index 0000000..d2255e7
--- /dev/null
@@ -0,0 +1,176 @@
+from typing import Any, AnyStr, Callable, Container, Dict, IO, List, Mapping, MutableMapping, NoReturn, Optional, Tuple, Type, Union\r
+from repr import Repr\r
+\r
+from types import FunctionType, MethodType, ModuleType, TracebackType\r
+# the return type of sys.exc_info(), used by ErrorDuringImport.__init__\r
+_Exc_Info = Tuple[Optional[Type[BaseException]], Optional[BaseException], Optional[TracebackType]]\r
+\r
+__author__ = ...  # type: str\r
+__date__ = ...  # type: str\r
+__version__ = ...  # type: str\r
+__credits__ = ...  # type: str\r
+\r
+def pathdirs() -> List[str]: ...\r
+def getdoc(object: object) -> Union[str, unicode]: ...\r
+def splitdoc(doc: AnyStr) -> Tuple[AnyStr, AnyStr]: ...\r
+def classname(object: object, modname: str) -> str: ...\r
+def isdata(object: object) -> bool: ...\r
+def replace(text: AnyStr, *pairs: AnyStr) -> AnyStr: ...\r
+def cram(text: str, maxlen: int) -> str: ...\r
+def stripid(text: str) -> str: ...\r
+def allmethods(cl: type) -> MutableMapping[str, MethodType]: ...\r
+def visiblename(name: str, all: Optional[Container[str]] = ..., obj: Optional[object] = ...) -> bool: ...\r
+def classify_class_attrs(object: object) -> List[Tuple[str, str, type, str]]: ...\r
+\r
+def ispackage(path: str) -> bool: ...\r
+def source_synopsis(file: IO[AnyStr]) -> Optional[AnyStr]: ...\r
+def synopsis(filename: str, cache: MutableMapping[str, Tuple[int, str]] = ...) -> Optional[str]: ...\r
+\r
+class ErrorDuringImport(Exception):\r
+    filename = ...  # type: str\r
+    exc = ...  # type: Optional[Type[BaseException]]\r
+    value = ...  # type: Optional[BaseException]\r
+    tb = ...  # type: Optional[TracebackType]\r
+    def __init__(self, filename: str, exc_info: _Exc_Info) -> None: ...\r
+\r
+def importfile(path: str) -> ModuleType: ...\r
+def safeimport(path: str, forceload: bool = ..., cache: MutableMapping[str, ModuleType] = ...) -> ModuleType: ...\r
+\r
+class Doc:\r
+    def document(self, object: object, name: Optional[str] = ..., *args: Any) -> str: ...\r
+    def fail(self, object: object, name: Optional[str] = ..., *args: Any) -> NoReturn: ...\r
+    def docmodule(self, object: object, name: Optional[str] = ..., *args: Any) -> str: ...\r
+    def docclass(self, object: object, name: Optional[str] = ..., *args: Any) -> str: ...\r
+    def docroutine(self, object: object, name: Optional[str] = ..., *args: Any) -> str: ...\r
+    def docother(self, object: object, name: Optional[str] = ..., *args: Any) -> str: ...\r
+    def docproperty(self, object: object, name: Optional[str] = ..., *args: Any) -> str: ...\r
+    def docdata(self, object: object, name: Optional[str] = ..., *args: Any) -> str: ...\r
+    def getdocloc(self, object: object) -> Optional[str]: ...\r
+\r
+class HTMLRepr(Repr):\r
+    maxlist = ...  # type: int\r
+    maxtuple = ...  # type: int\r
+    maxdict = ...  # type: int\r
+    maxstring = ...  # type: int\r
+    maxother = ...  # type: int\r
+    def __init__(self) -> None: ...\r
+    def escape(self, text: str) -> str: ...\r
+    def repr(self, object: object) -> str: ...\r
+    def repr1(self, x: object, level: complex) -> str: ...\r
+    def repr_string(self, x: Union[str, unicode], level: complex) -> str: ...\r
+    def repr_str(self, x: Union[str, unicode], level: complex) -> str: ...\r
+    def repr_instance(self, x: object, level: complex) -> str: ...\r
+    def repr_unicode(self, x: AnyStr, level: complex) -> str: ...\r
+\r
+class HTMLDoc(Doc):\r
+    def repr(self, object: object) -> str: ...\r
+    def escape(self, test: str) -> str: ...\r
+    def page(self, title: str, contents: str) -> str: ...\r
+    def heading(self, title: str, fgcol: str, bgcol: str, extras: str = ...) -> str: ...\r
+    def section(self, title: str, fgcol: str, bgcol: str, contents: str, width: int = ..., prelude: str = ..., marginalia: Optional[str] = ..., gap: str = ...) -> str: ...\r
+    def bigsection(self, title: str, *args) -> str: ...\r
+    def preformat(self, text: str) -> str: ...\r
+    def multicolumn(self, list: List[Any], format: Callable[[Any], str], cols: int = ...) -> str: ...\r
+    def grey(self, text: str) -> str: ...\r
+    def namelink(self, name: str, *dicts: MutableMapping[str, str]) -> str: ...\r
+    def classlink(self, object: object, modname: str) -> str: ...\r
+    def modulelink(self, object: object) -> str: ...\r
+    def modpkglink(self, data: Tuple[str, str, bool, bool]) -> str: ...\r
+    def markup(self, text: str, escape: Optional[Callable[[str], str]] = ..., funcs: Mapping[str, str] = ..., classes: Mapping[str, str] = ..., methods: Mapping[str, str] = ...) -> str: ...\r
+    def formattree(self, tree: List[Union[Tuple[type, Tuple[type, ...]], list]], modname: str, parent: Optional[type] = ...) -> str: ...\r
+    def docmodule(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., *ignored) -> str: ...\r
+    def docclass(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., funcs: Mapping[str, str] = ..., classes: Mapping[str, str] = ..., *ignored) -> str: ...\r
+    def formatvalue(self, object: object) -> str: ...\r
+    def docroutine(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., funcs: Mapping[str, str] = ..., classes: Mapping[str, str] = ..., methods: Mapping[str, str] = ..., cl: Optional[type] = ..., *ignored) -> str: ...\r
+    def docproperty(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., cl: Optional[Any] = ..., *ignored) -> str: ...\r
+    def docother(self, object: object, name: Optional[str] = ..., mod: Optional[Any] = ..., *ignored) -> str: ...\r
+    def docdata(self, object: object, name: Optional[str] = ..., mod: Optional[Any] = ..., cl: Optional[Any] = ..., *ignored) -> str: ...\r
+    def index(self, dir: str, shadowed: Optional[MutableMapping[str, bool]] = ...) -> str: ...\r
+\r
+class TextRepr(Repr):\r
+    maxlist = ...  # type: int\r
+    maxtuple = ...  # type: int\r
+    maxdict = ...  # type: int\r
+    maxstring = ...  # type: int\r
+    maxother = ...  # type: int\r
+    def __init__(self) -> None: ...\r
+    def repr1(self, x: object, level: complex) -> str: ...\r
+    def repr_string(self, x: str, level: complex) -> str: ...\r
+    def repr_str(self, x: str, level: complex) -> str: ...\r
+    def repr_instance(self, x: object, level: complex) -> str: ...\r
+\r
+class TextDoc(Doc):\r
+    def repr(self, object: object) -> str: ...\r
+    def bold(self, text: str) -> str: ...\r
+    def indent(self, text: str, prefix: str = ...) -> str: ...\r
+    def section(self, title: str, contents: str) -> str: ...\r
+    def formattree(self, tree: List[Union[Tuple[type, Tuple[type, ...]], list]], modname: str, parent: Optional[type] = ..., prefix: str = ...) -> str: ...\r
+    def docmodule(self, object: object, name: Optional[str] = ..., mod: Optional[Any] = ..., *ignored) -> str: ...\r
+    def docclass(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., *ignored) -> str: ...\r
+    def formatvalue(self, object: object) -> str: ...\r
+    def docroutine(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., cl: Optional[Any] = ..., *ignored) -> str: ...\r
+    def docproperty(self, object: object, name: Optional[str] = ..., mod: Optional[Any] = ..., cl: Optional[Any] = ..., *ignored) -> str: ...\r
+    def docdata(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., cl: Optional[Any] = ..., *ignored) -> str: ...\r
+    def docother(self, object: object, name: Optional[str] = ..., mod: Optional[str] = ..., parent: Optional[str] = ..., maxlen: Optional[int] = ..., doc: Optional[Any] = ..., *ignored) -> str: ...\r
+\r
+def pager(text: str) -> None: ...\r
+def getpager() -> Callable[[str], None]: ...\r
+def plain(text: str) -> str: ...\r
+def pipepager(text: str, cmd: str) -> None: ...\r
+def tempfilepager(text: str, cmd: str) -> None: ...\r
+def ttypager(text: str) -> None: ...\r
+def plainpager(text: str) -> None: ...\r
+def describe(thing: Any) -> str: ...\r
+def locate(path: str, forceload: bool = ...) -> object: ...\r
+\r
+text = ...  # type: TextDoc\r
+html = ...  # type: HTMLDoc\r
+\r
+class _OldStyleClass: ...\r
+\r
+def resolve(thing: Union[str, object], forceload: bool = ...) -> Optional[Tuple[object, str]]: ...\r
+def render_doc(thing: Union[str, object], title: str = ..., forceload: bool = ...) -> str: ...\r
+def doc(thing: Union[str, object], title: str = ..., forceload: bool = ...) -> None: ...\r
+def writedoc(thing: Union[str, object], forceload: bool = ...) -> None: ...\r
+def writedocs(dir: str, pkgpath: str = ..., done: Optional[Any] = ...) -> None: ...\r
+\r
+class Helper:\r
+    keywords = ...  # type: Dict[str, Union[str, Tuple[str, str]]]\r
+    symbols = ...  # type: Dict[str, str]\r
+    topics = ...  # type: Dict[str, Union[str, Tuple[str, ...]]]\r
+    def __init__(self, input: Optional[IO[str]] = ..., output: Optional[IO[str]] = ...) -> None: ...\r
+    input = ...  # type: IO[str]\r
+    output = ...  # type: IO[str]\r
+    def __call__(self, request: Union[str, Helper, object] = ...) -> None: ...\r
+    def interact(self) -> None: ...\r
+    def getline(self, prompt: str) -> str: ...\r
+    def help(self, request: Any) -> None: ...\r
+    def intro(self) -> None: ...\r
+    def list(self, items: List[str], columns: int = ..., width: int = ...) -> None: ...\r
+    def listkeywords(self) -> None: ...\r
+    def listsymbols(self) -> None: ...\r
+    def listtopics(self) -> None: ...\r
+    def showtopic(self, topic: str, more_xrefs: str = ...) -> None: ...\r
+    def showsymbol(self, symbol: str) -> None: ...\r
+    def listmodules(self, key: str = ...) -> None: ...\r
+\r
+help = ...  # type: Helper\r
+\r
+# See Python issue #11182: "remove the unused and undocumented pydoc.Scanner class"\r
+# class Scanner:\r
+#     roots = ...  # type: Any\r
+#     state = ...  # type: Any\r
+#     children = ...  # type: Any\r
+#     descendp = ...  # type: Any\r
+#     def __init__(self, roots, children, descendp) -> None: ...\r
+#     def next(self): ...\r
+\r
+class ModuleScanner:\r
+    quit = ...  # type: bool\r
+    def run(self, callback: Callable[[Optional[str], str, str], None], key: Optional[Any] = ..., completer: Optional[Callable[[], None]] = ..., onerror: Optional[Callable] = ...) -> None: ...\r
+\r
+def apropos(key: str) -> None: ...\r
+def serve(port: int, callback: Optional[Callable[[Any], None]] = ..., completer: Optional[Callable[[], None]] = ...) -> None: ...\r
+def gui() -> None: ...\r
+def ispath(x: Any) -> bool: ...\r
+def cli() -> None: ...\r