Files
typeshed/stdlib/tkinter/font.pyi
Alex Waygood 33a62ae42d Add more defaults to the stdlib (#9606)
Continuing work towards #8988.

The first five commits were created using stubdefaulter on various Python versions; the following commits were all created manually by me to fix various problems. The main things this adds that weren't present in #9501 are:

- Defaults in Windows-only modules and Windows-only branches (because I'm running a Windows machine)
- Defaults in non-py311 branches
- Defaults for float parameters
- Defaults for overloads
2023-01-29 01:51:23 +00:00

113 lines
4.0 KiB
Python

import _tkinter
import sys
import tkinter
from typing import Any, overload
from typing_extensions import Literal, TypeAlias, TypedDict
if sys.version_info >= (3, 9):
__all__ = ["NORMAL", "ROMAN", "BOLD", "ITALIC", "nametofont", "Font", "families", "names"]
NORMAL: Literal["normal"]
ROMAN: Literal["roman"]
BOLD: Literal["bold"]
ITALIC: Literal["italic"]
_FontDescription: TypeAlias = (
str # "Helvetica 12"
| Font # A font object constructed in Python
| list[Any] # ("Helvetica", 12, BOLD)
| tuple[Any, ...]
| _tkinter.Tcl_Obj # A font object constructed in Tcl
)
class _FontDict(TypedDict):
family: str
size: int
weight: Literal["normal", "bold"]
slant: Literal["roman", "italic"]
underline: bool
overstrike: bool
class _MetricsDict(TypedDict):
ascent: int
descent: int
linespace: int
fixed: bool
class Font:
name: str
delete_font: bool
def __init__(
self,
# In tkinter, 'root' refers to tkinter.Tk by convention, but the code
# actually works with any tkinter widget so we use tkinter.Misc.
root: tkinter.Misc | None = None,
font: _FontDescription | None = None,
name: str | None = None,
exists: bool = False,
*,
family: str = ...,
size: int = ...,
weight: Literal["normal", "bold"] = ...,
slant: Literal["roman", "italic"] = ...,
underline: bool = ...,
overstrike: bool = ...,
) -> None: ...
def __setitem__(self, key: str, value: Any) -> None: ...
@overload
def cget(self, option: Literal["family"]) -> str: ...
@overload
def cget(self, option: Literal["size"]) -> int: ...
@overload
def cget(self, option: Literal["weight"]) -> Literal["normal", "bold"]: ...
@overload
def cget(self, option: Literal["slant"]) -> Literal["roman", "italic"]: ...
@overload
def cget(self, option: Literal["underline", "overstrike"]) -> bool: ...
@overload
def cget(self, option: str) -> Any: ...
__getitem__ = cget
@overload
def actual(self, option: Literal["family"], displayof: tkinter.Misc | None = None) -> str: ...
@overload
def actual(self, option: Literal["size"], displayof: tkinter.Misc | None = None) -> int: ...
@overload
def actual(self, option: Literal["weight"], displayof: tkinter.Misc | None = None) -> Literal["normal", "bold"]: ...
@overload
def actual(self, option: Literal["slant"], displayof: tkinter.Misc | None = None) -> Literal["roman", "italic"]: ...
@overload
def actual(self, option: Literal["underline", "overstrike"], displayof: tkinter.Misc | None = None) -> bool: ...
@overload
def actual(self, option: None, displayof: tkinter.Misc | None = None) -> _FontDict: ...
@overload
def actual(self, *, displayof: tkinter.Misc | None = None) -> _FontDict: ...
def config(
self,
*,
family: str = ...,
size: int = ...,
weight: Literal["normal", "bold"] = ...,
slant: Literal["roman", "italic"] = ...,
underline: bool = ...,
overstrike: bool = ...,
) -> _FontDict | None: ...
configure = config
def copy(self) -> Font: ...
@overload
def metrics(self, __option: Literal["ascent", "descent", "linespace"], *, displayof: tkinter.Misc | None = ...) -> int: ...
@overload
def metrics(self, __option: Literal["fixed"], *, displayof: tkinter.Misc | None = ...) -> bool: ...
@overload
def metrics(self, *, displayof: tkinter.Misc | None = ...) -> _MetricsDict: ...
def measure(self, text: str, displayof: tkinter.Misc | None = None) -> int: ...
def __eq__(self, other: object) -> bool: ...
def families(root: tkinter.Misc | None = None, displayof: tkinter.Misc | None = None) -> tuple[str, ...]: ...
def names(root: tkinter.Misc | None = None) -> tuple[str, ...]: ...
if sys.version_info >= (3, 10):
def nametofont(name: str, root: tkinter.Misc | None = None) -> Font: ...
else:
def nametofont(name: str) -> Font: ...