Skip to content

Commit 29c69fe

Browse files
authored
[tkinter] Annotate several functions (#14631)
1 parent 1b1f3a9 commit 29c69fe

File tree

2 files changed

+54
-55
lines changed

2 files changed

+54
-55
lines changed

stdlib/_tkinter.pyi

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -54,34 +54,34 @@ _TkinterTraceFunc: TypeAlias = Callable[[tuple[str, ...]], object]
5454
@final
5555
class TkappType:
5656
# Please keep in sync with tkinter.Tk
57-
def adderrorinfo(self, msg, /): ...
57+
def adderrorinfo(self, msg: str, /): ...
5858
def call(self, command: Any, /, *args: Any) -> Any: ...
59-
def createcommand(self, name, func, /): ...
59+
def createcommand(self, name: str, func, /): ...
6060
if sys.platform != "win32":
61-
def createfilehandler(self, file, mask, func, /): ...
62-
def deletefilehandler(self, file, /): ...
61+
def createfilehandler(self, file, mask: int, func, /): ...
62+
def deletefilehandler(self, file, /) -> None: ...
6363

64-
def createtimerhandler(self, milliseconds, func, /): ...
65-
def deletecommand(self, name, /): ...
64+
def createtimerhandler(self, milliseconds: int, func, /): ...
65+
def deletecommand(self, name: str, /): ...
6666
def dooneevent(self, flags: int = 0, /): ...
6767
def eval(self, script: str, /) -> str: ...
68-
def evalfile(self, fileName, /): ...
69-
def exprboolean(self, s, /): ...
70-
def exprdouble(self, s, /): ...
71-
def exprlong(self, s, /): ...
72-
def exprstring(self, s, /): ...
73-
def getboolean(self, arg, /): ...
74-
def getdouble(self, arg, /): ...
75-
def getint(self, arg, /): ...
68+
def evalfile(self, fileName: str, /): ...
69+
def exprboolean(self, s: str, /): ...
70+
def exprdouble(self, s: str, /): ...
71+
def exprlong(self, s: str, /): ...
72+
def exprstring(self, s: str, /): ...
73+
def getboolean(self, arg, /) -> bool: ...
74+
def getdouble(self, arg, /) -> float: ...
75+
def getint(self, arg, /) -> int: ...
7676
def getvar(self, *args, **kwargs): ...
7777
def globalgetvar(self, *args, **kwargs): ...
7878
def globalsetvar(self, *args, **kwargs): ...
7979
def globalunsetvar(self, *args, **kwargs): ...
8080
def interpaddr(self) -> int: ...
8181
def loadtk(self) -> None: ...
82-
def mainloop(self, threshold: int = 0, /): ...
83-
def quit(self): ...
84-
def record(self, script, /): ...
82+
def mainloop(self, threshold: int = 0, /) -> None: ...
83+
def quit(self) -> None: ...
84+
def record(self, script: str, /): ...
8585
def setvar(self, *ags, **kwargs): ...
8686
if sys.version_info < (3, 11):
8787
@deprecated("Deprecated since Python 3.9; removed in Python 3.11. Use `splitlist()` instead.")
@@ -90,7 +90,7 @@ class TkappType:
9090
def splitlist(self, arg, /): ...
9191
def unsetvar(self, *args, **kwargs): ...
9292
def wantobjects(self, *args, **kwargs): ...
93-
def willdispatch(self): ...
93+
def willdispatch(self) -> None: ...
9494
if sys.version_info >= (3, 12):
9595
def gettrace(self, /) -> _TkinterTraceFunc | None: ...
9696
def settrace(self, func: _TkinterTraceFunc | None, /) -> None: ...
@@ -140,5 +140,5 @@ else:
140140
/,
141141
): ...
142142

143-
def getbusywaitinterval(): ...
144-
def setbusywaitinterval(new_val, /): ...
143+
def getbusywaitinterval() -> int: ...
144+
def setbusywaitinterval(new_val: int, /) -> None: ...

stdlib/tkinter/__init__.pyi

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -333,12 +333,12 @@ class Variable:
333333
@deprecated("Deprecated since Python 3.14. Use `trace_remove()` instead.")
334334
def trace_vdelete(self, mode, cbname) -> None: ...
335335
@deprecated("Deprecated since Python 3.14. Use `trace_info()` instead.")
336-
def trace_vinfo(self): ...
336+
def trace_vinfo(self) -> list[Incomplete]: ...
337337
else:
338338
def trace(self, mode, callback) -> str: ...
339339
def trace_variable(self, mode, callback) -> str: ...
340340
def trace_vdelete(self, mode, cbname) -> None: ...
341-
def trace_vinfo(self): ...
341+
def trace_vinfo(self) -> list[Incomplete]: ...
342342

343343
def __eq__(self, other: object) -> bool: ...
344344
def __del__(self) -> None: ...
@@ -373,7 +373,7 @@ def mainloop(n: int = 0) -> None: ...
373373
getint = int
374374
getdouble = float
375375

376-
def getboolean(s): ...
376+
def getboolean(s) -> bool: ...
377377

378378
_Ts = TypeVarTuple("_Ts")
379379

@@ -403,9 +403,9 @@ class Misc:
403403
def wait_visibility(self, window: Misc | None = None) -> None: ...
404404
def setvar(self, name: str = "PY_VAR", value: str = "1") -> None: ...
405405
def getvar(self, name: str = "PY_VAR"): ...
406-
def getint(self, s): ...
407-
def getdouble(self, s): ...
408-
def getboolean(self, s): ...
406+
def getint(self, s) -> int: ...
407+
def getdouble(self, s) -> float: ...
408+
def getboolean(self, s) -> bool: ...
409409
def focus_set(self) -> None: ...
410410
focus = focus_set
411411
def focus_force(self) -> None: ...
@@ -681,7 +681,7 @@ class XView:
681681
@overload
682682
def xview(self) -> tuple[float, float]: ...
683683
@overload
684-
def xview(self, *args): ...
684+
def xview(self, *args) -> None: ...
685685
def xview_moveto(self, fraction: float) -> None: ...
686686
@overload
687687
def xview_scroll(self, number: int, what: Literal["units", "pages"]) -> None: ...
@@ -692,7 +692,7 @@ class YView:
692692
@overload
693693
def yview(self) -> tuple[float, float]: ...
694694
@overload
695-
def yview(self, *args): ...
695+
def yview(self, *args) -> None: ...
696696
def yview_moveto(self, fraction: float) -> None: ...
697697
@overload
698698
def yview_scroll(self, number: int, what: Literal["units", "pages"]) -> None: ...
@@ -1018,35 +1018,35 @@ class Tk(Misc, Wm):
10181018
# Tk has __getattr__ so that tk_instance.foo falls back to tk_instance.tk.foo
10191019
# Please keep in sync with _tkinter.TkappType.
10201020
# Some methods are intentionally missing because they are inherited from Misc instead.
1021-
def adderrorinfo(self, msg, /): ...
1021+
def adderrorinfo(self, msg: str, /): ...
10221022
def call(self, command: Any, /, *args: Any) -> Any: ...
1023-
def createcommand(self, name, func, /): ...
1023+
def createcommand(self, name: str, func, /): ...
10241024
if sys.platform != "win32":
1025-
def createfilehandler(self, file, mask, func, /): ...
1026-
def deletefilehandler(self, file, /): ...
1025+
def createfilehandler(self, file, mask: int, func, /): ...
1026+
def deletefilehandler(self, file, /) -> None: ...
10271027

1028-
def createtimerhandler(self, milliseconds, func, /): ...
1029-
def dooneevent(self, flags: int = ..., /): ...
1028+
def createtimerhandler(self, milliseconds: int, func, /): ...
1029+
def dooneevent(self, flags: int = 0, /): ...
10301030
def eval(self, script: str, /) -> str: ...
1031-
def evalfile(self, fileName, /): ...
1032-
def exprboolean(self, s, /): ...
1033-
def exprdouble(self, s, /): ...
1034-
def exprlong(self, s, /): ...
1035-
def exprstring(self, s, /): ...
1031+
def evalfile(self, fileName: str, /): ...
1032+
def exprboolean(self, s: str, /): ...
1033+
def exprdouble(self, s: str, /): ...
1034+
def exprlong(self, s: str, /): ...
1035+
def exprstring(self, s: str, /): ...
10361036
def globalgetvar(self, *args, **kwargs): ...
10371037
def globalsetvar(self, *args, **kwargs): ...
10381038
def globalunsetvar(self, *args, **kwargs): ...
10391039
def interpaddr(self) -> int: ...
10401040
def loadtk(self) -> None: ...
1041-
def record(self, script, /): ...
1041+
def record(self, script: str, /): ...
10421042
if sys.version_info < (3, 11):
10431043
@deprecated("Deprecated since Python 3.9; removed in Python 3.11. Use `splitlist()` instead.")
10441044
def split(self, arg, /): ...
10451045

10461046
def splitlist(self, arg, /): ...
10471047
def unsetvar(self, *args, **kwargs): ...
10481048
def wantobjects(self, *args, **kwargs): ...
1049-
def willdispatch(self): ...
1049+
def willdispatch(self) -> None: ...
10501050

10511051
def Tcl(screenName: str | None = None, baseName: str | None = None, className: str = "Tk", useTk: bool = False) -> Tk: ...
10521052

@@ -1170,8 +1170,8 @@ class Grid:
11701170

11711171
class BaseWidget(Misc):
11721172
master: Misc
1173-
widgetName: Incomplete
1174-
def __init__(self, master, widgetName, cnf={}, kw={}, extra=()) -> None: ...
1173+
widgetName: str
1174+
def __init__(self, master, widgetName: str, cnf={}, kw={}, extra=()) -> None: ...
11751175
def destroy(self) -> None: ...
11761176

11771177
# This class represents any widget except Toplevel or Tk.
@@ -3559,7 +3559,7 @@ class Text(Widget, XView, YView):
35593559
fgstipple: str = ...,
35603560
font: _FontDescription = ...,
35613561
foreground: str = ...,
3562-
justify: Literal["left", "right", "center"] = ...,
3562+
justify: Literal["left", "center", "right"] = ...,
35633563
lmargin1: _ScreenUnits = ...,
35643564
lmargin2: _ScreenUnits = ...,
35653565
lmargincolor: str = ...,
@@ -3643,7 +3643,6 @@ class _setit:
36433643

36443644
# manual page: tk_optionMenu
36453645
class OptionMenu(Menubutton):
3646-
widgetName: Incomplete
36473646
menuname: Incomplete
36483647
def __init__(
36493648
# differs from other widgets
@@ -4082,19 +4081,19 @@ class PanedWindow(Widget):
40824081
config = configure
40834082
def add(self, child: Widget, **kw) -> None: ...
40844083
def remove(self, child) -> None: ...
4085-
forget: Incomplete
4084+
forget = remove # type: ignore[assignment]
40864085
def identify(self, x: int, y: int): ...
4087-
def proxy(self, *args): ...
4088-
def proxy_coord(self): ...
4089-
def proxy_forget(self): ...
4090-
def proxy_place(self, x, y): ...
4091-
def sash(self, *args): ...
4092-
def sash_coord(self, index): ...
4093-
def sash_mark(self, index): ...
4094-
def sash_place(self, index, x, y): ...
4086+
def proxy(self, *args) -> tuple[Incomplete, ...]: ...
4087+
def proxy_coord(self) -> tuple[Incomplete, ...]: ...
4088+
def proxy_forget(self) -> tuple[Incomplete, ...]: ...
4089+
def proxy_place(self, x, y) -> tuple[Incomplete, ...]: ...
4090+
def sash(self, *args) -> tuple[Incomplete, ...]: ...
4091+
def sash_coord(self, index) -> tuple[Incomplete, ...]: ...
4092+
def sash_mark(self, index) -> tuple[Incomplete, ...]: ...
4093+
def sash_place(self, index, x, y) -> tuple[Incomplete, ...]: ...
40954094
def panecget(self, child, option): ...
40964095
def paneconfigure(self, tagOrId, cnf=None, **kw): ...
4097-
paneconfig: Incomplete
4096+
paneconfig = paneconfigure
40984097
def panes(self): ...
40994098

41004099
def _test() -> None: ...

0 commit comments

Comments
 (0)