VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2025-12-15 16:27:08 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve pydoc stubs (#6554)

Browse Source
This commit is contained in:
Alex Waygood
2021-12-09 13:28:35 +00:00
committed by GitHub
parent 384e309f53
commit 65f0e8b770
2 changed files with 8 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
stdlib/pydoc.pyi
View File

@@ -109,7 +109,7 @@ class HTMLDoc(Doc):
*ignored: Any,
) -> str: ...
def formatvalue(self, object: object) -> str: ...
def docroutine(
def docroutine( # type: ignore[override]
self,
object: object,
name: str | None = ...,
@@ -118,15 +118,10 @@ class HTMLDoc(Doc):
classes: Mapping[str, str] = ...,
methods: Mapping[str, str] = ...,
cl: type | None = ...,
*ignored: Any,
) -> str: ...
def docproperty(
self, object: object, name: str | None = ..., mod: str | None = ..., cl: Any | None = ..., *ignored: Any
) -> str: ...
def docproperty(self, object: object, name: str | None = ..., mod: str | None = ..., cl: Any | None = ...) -> str: ... # type: ignore[override]
def docother(self, object: object, name: str | None = ..., mod: Any | None = ..., *ignored: Any) -> str: ...
def docdata(
self, object: object, name: str | None = ..., mod: Any | None = ..., cl: Any | None = ..., *ignored: Any
) -> str: ...
def docdata(self, object: object, name: str | None = ..., mod: Any | None = ..., cl: Any | None = ...) -> str: ... # type: ignore[override]
def index(self, dir: str, shadowed: MutableMapping[str, bool] | None = ...) -> str: ...
def filelink(self, url: str, path: str) -> str: ...
@@ -150,19 +145,13 @@ class TextDoc(Doc):
def formattree(
self, tree: list[tuple[type, Tuple[type, ...]] | list[Any]], modname: str, parent: type | None = ..., prefix: str = ...
) -> str: ...
def docmodule(self, object: object, name: str | None = ..., mod: Any | None = ..., *ignored: Any) -> str: ...
def docmodule(self, object: object, name: str | None = ..., mod: Any | None = ...) -> str: ... # type: ignore[override]
def docclass(self, object: object, name: str | None = ..., mod: str | None = ..., *ignored: Any) -> str: ...
def formatvalue(self, object: object) -> str: ...
def docroutine(
self, object: object, name: str | None = ..., mod: str | None = ..., cl: Any | None = ..., *ignored: Any
) -> str: ...
def docproperty(
self, object: object, name: str | None = ..., mod: Any | None = ..., cl: Any | None = ..., *ignored: Any
) -> str: ...
def docdata(
self, object: object, name: str | None = ..., mod: str | None = ..., cl: Any | None = ..., *ignored: Any
) -> str: ...
def docother(
def docroutine(self, object: object, name: str | None = ..., mod: str | None = ..., cl: Any | None = ...) -> str: ... # type: ignore[override]
def docproperty(self, object: object, name: str | None = ..., mod: Any | None = ..., cl: Any | None = ...) -> str: ... # type: ignore[override]
def docdata(self, object: object, name: str | None = ..., mod: str | None = ..., cl: Any | None = ...) -> str: ... # type: ignore[override]
def docother( # type: ignore[override]
self,
object: object,
name: str | None = ...,
@@ -170,7 +159,6 @@ class TextDoc(Doc):
parent: str | None = ...,
maxlen: int | None = ...,
doc: Any | None = ...,
*ignored: Any,
) -> str: ...
def pager(text: str) -> None: ...

8
tests/stubtest_allowlists/py3_common.txt
View File

@@ -160,14 +160,6 @@ optparse.Values.__getattr__ # Some attributes are set in __init__ using setattr
pickle.Pickler.persistent_id # C pickler persistent_id is an attribute
pickle.Unpickler.persistent_load # C unpickler persistent_load is an attribute
poplib.POP3_SSL.stls # bad declaration of inherited function. See poplib.pyi
pydoc.HTMLDoc.docdata
pydoc.HTMLDoc.docproperty
pydoc.HTMLDoc.docroutine
pydoc.TextDoc.docdata
pydoc.TextDoc.docmodule
pydoc.TextDoc.docother
pydoc.TextDoc.docproperty
pydoc.TextDoc.docroutine
select.poll # Depends on configuration
selectors.DevpollSelector # Depends on configuration
socketserver.BaseServer.fileno # implemented in derived classes