stdlib: add argument default values (#9501)

This commit is contained in:
Jelle Zijlstra
2023-01-18 00:37:34 -08:00
committed by GitHub
parent 6cb934291f
commit ddfaca3200
272 changed files with 2529 additions and 2467 deletions

View File

@@ -106,7 +106,7 @@ class Logger(Filterer):
disabled: bool # undocumented
root: ClassVar[RootLogger] # undocumented
manager: Manager # undocumented
def __init__(self, name: str, level: _Level = ...) -> None: ...
def __init__(self, name: str, level: _Level = 0) -> None: ...
def setLevel(self, level: _Level) -> None: ...
def isEnabledFor(self, level: int) -> bool: ...
def getEffectiveLevel(self) -> int: ...
@@ -161,7 +161,7 @@ class Logger(Filterer):
self,
msg: object,
*args: object,
exc_info: _ExcInfoType = ...,
exc_info: _ExcInfoType = True,
stack_info: bool = ...,
stacklevel: int = ...,
extra: Mapping[str, object] | None = ...,
@@ -190,10 +190,10 @@ class Logger(Filterer):
level: int,
msg: object,
args: _ArgsType,
exc_info: _ExcInfoType | None = ...,
extra: Mapping[str, object] | None = ...,
stack_info: bool = ...,
stacklevel: int = ...,
exc_info: _ExcInfoType | None = None,
extra: Mapping[str, object] | None = None,
stack_info: bool = False,
stacklevel: int = 1,
) -> None: ... # undocumented
else:
def debug(
@@ -274,7 +274,7 @@ class Logger(Filterer):
def addHandler(self, hdlr: Handler) -> None: ...
def removeHandler(self, hdlr: Handler) -> None: ...
if sys.version_info >= (3, 8):
def findCaller(self, stack_info: bool = ..., stacklevel: int = ...) -> tuple[str, int, str, str | None]: ...
def findCaller(self, stack_info: bool = False, stacklevel: int = 1) -> tuple[str, int, str, str | None]: ...
else:
def findCaller(self, stack_info: bool = ...) -> tuple[str, int, str, str | None]: ...
@@ -288,9 +288,9 @@ class Logger(Filterer):
msg: object,
args: _ArgsType,
exc_info: _SysExcInfoType | None,
func: str | None = ...,
extra: Mapping[str, object] | None = ...,
sinfo: str | None = ...,
func: str | None = None,
extra: Mapping[str, object] | None = None,
sinfo: str | None = None,
) -> LogRecord: ...
def hasHandlers(self) -> bool: ...
def callHandlers(self, record: LogRecord) -> None: ... # undocumented
@@ -309,7 +309,7 @@ class Handler(Filterer):
formatter: Formatter | None # undocumented
lock: threading.Lock | None # undocumented
name: str | None # undocumented
def __init__(self, level: _Level = ...) -> None: ...
def __init__(self, level: _Level = 0) -> None: ...
def get_name(self) -> str: ... # undocumented
def set_name(self, name: str) -> None: ... # undocumented
def createLock(self) -> None: ...
@@ -338,12 +338,12 @@ class Formatter:
if sys.version_info >= (3, 10):
def __init__(
self,
fmt: str | None = ...,
datefmt: str | None = ...,
style: _FormatStyle = ...,
validate: bool = ...,
fmt: str | None = None,
datefmt: str | None = None,
style: _FormatStyle = "%",
validate: bool = True,
*,
defaults: Mapping[str, Any] | None = ...,
defaults: Mapping[str, Any] | None = None,
) -> None: ...
elif sys.version_info >= (3, 8):
def __init__(
@@ -353,7 +353,7 @@ class Formatter:
def __init__(self, fmt: str | None = ..., datefmt: str | None = ..., style: _FormatStyle = ...) -> None: ...
def format(self, record: LogRecord) -> str: ...
def formatTime(self, record: LogRecord, datefmt: str | None = ...) -> str: ...
def formatTime(self, record: LogRecord, datefmt: str | None = None) -> str: ...
def formatException(self, ei: _SysExcInfoType) -> str: ...
def formatMessage(self, record: LogRecord) -> str: ... # undocumented
def formatStack(self, stack_info: str) -> str: ...
@@ -361,7 +361,7 @@ class Formatter:
class BufferingFormatter:
linefmt: Formatter
def __init__(self, linefmt: Formatter | None = ...) -> None: ...
def __init__(self, linefmt: Formatter | None = None) -> None: ...
def formatHeader(self, records: Sequence[LogRecord]) -> str: ...
def formatFooter(self, records: Sequence[LogRecord]) -> str: ...
def format(self, records: Sequence[LogRecord]) -> str: ...
@@ -369,7 +369,7 @@ class BufferingFormatter:
class Filter:
name: str # undocumented
nlen: int # undocumented
def __init__(self, name: str = ...) -> None: ...
def __init__(self, name: str = "") -> None: ...
def filter(self, record: LogRecord) -> bool: ...
class LogRecord:
@@ -407,8 +407,8 @@ class LogRecord:
msg: object,
args: _ArgsType | None,
exc_info: _SysExcInfoType | None,
func: str | None = ...,
sinfo: str | None = ...,
func: str | None = None,
sinfo: str | None = None,
) -> None: ...
def getMessage(self) -> str: ...
# Allows setting contextual information on LogRecord objects as per the docs, see #7833
@@ -421,7 +421,7 @@ class LoggerAdapter(Generic[_L]):
manager: Manager # undocumented
if sys.version_info >= (3, 10):
extra: Mapping[str, object] | None
def __init__(self, logger: _L, extra: Mapping[str, object] | None = ...) -> None: ...
def __init__(self, logger: _L, extra: Mapping[str, object] | None = None) -> None: ...
else:
extra: Mapping[str, object]
def __init__(self, logger: _L, extra: Mapping[str, object]) -> None: ...
@@ -482,7 +482,7 @@ class LoggerAdapter(Generic[_L]):
self,
msg: object,
*args: object,
exc_info: _ExcInfoType = ...,
exc_info: _ExcInfoType = True,
stack_info: bool = ...,
stacklevel: int = ...,
extra: Mapping[str, object] | None = ...,
@@ -593,16 +593,16 @@ class LoggerAdapter(Generic[_L]):
level: int,
msg: object,
args: _ArgsType,
exc_info: _ExcInfoType | None = ...,
extra: Mapping[str, object] | None = ...,
stack_info: bool = ...,
exc_info: _ExcInfoType | None = None,
extra: Mapping[str, object] | None = None,
stack_info: bool = False,
) -> None: ... # undocumented
@property
def name(self) -> str: ... # undocumented
if sys.version_info >= (3, 11):
def __class_getitem__(cls, item: Any) -> GenericAlias: ...
def getLogger(name: str | None = ...) -> Logger: ...
def getLogger(name: str | None = None) -> Logger: ...
def getLoggerClass() -> type[Logger]: ...
def getLogRecordFactory() -> Callable[..., LogRecord]: ...
@@ -658,7 +658,7 @@ if sys.version_info >= (3, 8):
def exception(
msg: object,
*args: object,
exc_info: _ExcInfoType = ...,
exc_info: _ExcInfoType = True,
stack_info: bool = ...,
stacklevel: int = ...,
extra: Mapping[str, object] | None = ...,
@@ -706,7 +706,7 @@ else:
fatal = critical
def disable(level: int = ...) -> None: ...
def disable(level: int = 50) -> None: ...
def addLevelName(level: int, levelName: str) -> None: ...
def getLevelName(level: _Level) -> Any: ...
@@ -786,7 +786,7 @@ class FileHandler(StreamHandler[TextIOWrapper]):
if sys.version_info >= (3, 9):
errors: str | None # undocumented
def __init__(
self, filename: StrPath, mode: str = ..., encoding: str | None = ..., delay: bool = ..., errors: str | None = ...
self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False, errors: str | None = None
) -> None: ...
else:
def __init__(self, filename: StrPath, mode: str = ..., encoding: str | None = ..., delay: bool = ...) -> None: ...
@@ -815,7 +815,7 @@ class PercentStyle: # undocumented
validation_pattern: Pattern[str]
_fmt: str
if sys.version_info >= (3, 10):
def __init__(self, fmt: str, *, defaults: Mapping[str, Any] | None = ...) -> None: ...
def __init__(self, fmt: str, *, defaults: Mapping[str, Any] | None = None) -> None: ...
else:
def __init__(self, fmt: str) -> None: ...

View File

@@ -49,9 +49,9 @@ def dictConfig(config: _DictConfigArgs | dict[str, Any]) -> None: ...
if sys.version_info >= (3, 10):
def fileConfig(
fname: StrOrBytesPath | IO[str] | RawConfigParser,
defaults: dict[str, str] | None = ...,
disable_existing_loggers: bool = ...,
encoding: str | None = ...,
defaults: dict[str, str] | None = None,
disable_existing_loggers: bool = True,
encoding: str | None = None,
) -> None: ...
else:
@@ -62,5 +62,5 @@ else:
) -> None: ...
def valid_ident(s: str) -> Literal[True]: ... # undocumented
def listen(port: int = ..., verify: Callable[[bytes], bytes | None] | None = ...) -> Thread: ...
def listen(port: int = 9030, verify: Callable[[bytes], bytes | None] | None = None) -> Thread: ...
def stopListening() -> None: ...

View File

@@ -22,7 +22,7 @@ class WatchedFileHandler(FileHandler):
ino: int # undocumented
if sys.version_info >= (3, 9):
def __init__(
self, filename: StrPath, mode: str = ..., encoding: str | None = ..., delay: bool = ..., errors: str | None = ...
self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False, errors: str | None = None
) -> None: ...
else:
def __init__(self, filename: StrPath, mode: str = ..., encoding: str | None = ..., delay: bool = ...) -> None: ...
@@ -35,7 +35,7 @@ class BaseRotatingHandler(FileHandler):
rotator: Callable[[str, str], None] | None
if sys.version_info >= (3, 9):
def __init__(
self, filename: StrPath, mode: str, encoding: str | None = ..., delay: bool = ..., errors: str | None = ...
self, filename: StrPath, mode: str, encoding: str | None = None, delay: bool = False, errors: str | None = None
) -> None: ...
else:
def __init__(self, filename: StrPath, mode: str, encoding: str | None = ..., delay: bool = ...) -> None: ...
@@ -50,12 +50,12 @@ class RotatingFileHandler(BaseRotatingHandler):
def __init__(
self,
filename: StrPath,
mode: str = ...,
maxBytes: int = ...,
backupCount: int = ...,
encoding: str | None = ...,
delay: bool = ...,
errors: str | None = ...,
mode: str = "a",
maxBytes: int = 0,
backupCount: int = 0,
encoding: str | None = None,
delay: bool = False,
errors: str | None = None,
) -> None: ...
else:
def __init__(
@@ -85,14 +85,14 @@ class TimedRotatingFileHandler(BaseRotatingHandler):
def __init__(
self,
filename: StrPath,
when: str = ...,
interval: int = ...,
backupCount: int = ...,
encoding: str | None = ...,
delay: bool = ...,
utc: bool = ...,
atTime: datetime.time | None = ...,
errors: str | None = ...,
when: str = "h",
interval: int = 1,
backupCount: int = 0,
encoding: str | None = None,
delay: bool = False,
utc: bool = False,
atTime: datetime.time | None = None,
errors: str | None = None,
) -> None: ...
else:
def __init__(
@@ -123,7 +123,7 @@ class SocketHandler(Handler):
retryFactor: float # undocumented
retryMax: float # undocumented
def __init__(self, host: str, port: int | None) -> None: ...
def makeSocket(self, timeout: float = ...) -> socket: ... # timeout is undocumented
def makeSocket(self, timeout: float = 1) -> socket: ... # timeout is undocumented
def makePickle(self, record: LogRecord) -> bytes: ...
def send(self, s: ReadableBuffer) -> None: ...
def createSocket(self) -> None: ...
@@ -177,7 +177,7 @@ class SysLogHandler(Handler):
priority_names: ClassVar[dict[str, int]] # undocumented
facility_names: ClassVar[dict[str, int]] # undocumented
priority_map: ClassVar[dict[str, str]] # undocumented
def __init__(self, address: tuple[str, int] | str = ..., facility: int = ..., socktype: SocketKind | None = ...) -> None: ...
def __init__(self, address: tuple[str, int] | str = ..., facility: int = 1, socktype: SocketKind | None = None) -> None: ...
if sys.version_info >= (3, 11):
def createSocket(self) -> None: ...
@@ -185,7 +185,7 @@ class SysLogHandler(Handler):
def mapPriority(self, levelName: str) -> str: ...
class NTEventLogHandler(Handler):
def __init__(self, appname: str, dllname: str | None = ..., logtype: str = ...) -> None: ...
def __init__(self, appname: str, dllname: str | None = None, logtype: str = "Application") -> None: ...
def getEventCategory(self, record: LogRecord) -> int: ...
# TODO correct return value?
def getEventType(self, record: LogRecord) -> int: ...
@@ -208,8 +208,8 @@ class SMTPHandler(Handler):
fromaddr: str,
toaddrs: str | list[str],
subject: str,
credentials: tuple[str, str] | None = ...,
secure: tuple[()] | tuple[str] | tuple[str, str] | None = ...,
credentials: tuple[str, str] | None = None,
secure: tuple[()] | tuple[str] | tuple[str, str] | None = None,
timeout: float = ...,
) -> None: ...
def getSubject(self, record: LogRecord) -> str: ...
@@ -224,7 +224,7 @@ class MemoryHandler(BufferingHandler):
flushLevel: int # undocumented
target: Handler | None # undocumented
flushOnClose: bool # undocumented
def __init__(self, capacity: int, flushLevel: int = ..., target: Handler | None = ..., flushOnClose: bool = ...) -> None: ...
def __init__(self, capacity: int, flushLevel: int = 40, target: Handler | None = None, flushOnClose: bool = True) -> None: ...
def setTarget(self, target: Handler | None) -> None: ...
class HTTPHandler(Handler):
@@ -238,10 +238,10 @@ class HTTPHandler(Handler):
self,
host: str,
url: str,
method: str = ...,
secure: bool = ...,
credentials: tuple[str, str] | None = ...,
context: ssl.SSLContext | None = ...,
method: str = "GET",
secure: bool = False,
credentials: tuple[str, str] | None = None,
context: ssl.SSLContext | None = None,
) -> None: ...
def mapLogRecord(self, record: LogRecord) -> dict[str, Any]: ...
if sys.version_info >= (3, 9):
@@ -257,7 +257,7 @@ class QueueListener:
handlers: tuple[Handler, ...] # undocumented
respect_handler_level: bool # undocumented
queue: SimpleQueue[Any] | Queue[Any] # undocumented
def __init__(self, queue: SimpleQueue[Any] | Queue[Any], *handlers: Handler, respect_handler_level: bool = ...) -> None: ...
def __init__(self, queue: SimpleQueue[Any] | Queue[Any], *handlers: Handler, respect_handler_level: bool = False) -> None: ...
def dequeue(self, block: bool) -> LogRecord: ...
def prepare(self, record: LogRecord) -> Any: ...
def start(self) -> None: ...