Skip to content

Commit 710a44f

Browse files
committed
Add coloredlogs typing stub
1 parent 704eecb commit 710a44f

1 file changed

Lines changed: 42 additions & 9 deletions

File tree

typings/coloredlogs.pyi

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import logging
2-
from _typeshed import Incomplete
32
from collections.abc import Generator
4-
from typing import NamedTuple
3+
from typing import Any, Dict, NamedTuple, Optional, TypedDict, Union
4+
5+
from _typeshed import Incomplete
56

67
__version__: str
7-
DEFAULT_LOG_LEVEL: Incomplete
8+
DEFAULT_LOG_LEVEL: int
89
DEFAULT_LOG_FORMAT: str
910
DEFAULT_DATE_FORMAT: str
1011
CHROOT_FILES: Incomplete
@@ -14,7 +15,24 @@ DEFAULT_FORMAT_STYLE: str
1415
FORMAT_STYLE_PATTERNS: Incomplete
1516

1617
def auto_install() -> None: ...
17-
def install(level: Incomplete | None = None, **kw): ...
18+
19+
class InstallOptions(TypedDict, total=False):
20+
logger: logging.Logger
21+
fmt: str
22+
datefmt: str
23+
style: str
24+
milliseconds: bool
25+
level_styles: Dict[str, Dict[str, Union[str, bool, int]]]
26+
field_styles: Dict[str, Dict[str, Union[str, bool, int]]]
27+
stream: Any
28+
isatty: bool
29+
reconfigure: bool
30+
use_chroot: bool
31+
programname: str
32+
username: str
33+
syslog: bool
34+
35+
def install(level: Optional[Union[int, str]] = None, **kw: InstallOptions) -> None: ...
1836
def check_style(value): ...
1937
def increase_verbosity() -> None: ...
2038
def decrease_verbosity() -> None: ...
@@ -41,29 +59,42 @@ class ColoredFormatter(BasicFormatter):
4159
nn: Incomplete
4260
level_styles: Incomplete
4361
field_styles: Incomplete
44-
def __init__(self, fmt: Incomplete | None = None, datefmt: Incomplete | None = None, style=..., level_styles: Incomplete | None = None, field_styles: Incomplete | None = None) -> None: ...
62+
def __init__(
63+
self,
64+
fmt: Incomplete | None = None,
65+
datefmt: Incomplete | None = None,
66+
style=...,
67+
level_styles: Incomplete | None = None,
68+
field_styles: Incomplete | None = None,
69+
) -> None: ...
4570
def colorize_format(self, fmt, style=...): ...
4671
def format(self, record): ...
4772

4873
class Empty: ...
4974

5075
class HostNameFilter(logging.Filter):
5176
@classmethod
52-
def install(cls, handler, fmt: Incomplete | None = None, use_chroot: bool = True, style=...) -> None: ...
77+
def install(
78+
cls, handler, fmt: Incomplete | None = None, use_chroot: bool = True, style=...
79+
) -> None: ...
5380
hostname: Incomplete
5481
def __init__(self, use_chroot: bool = True) -> None: ...
5582
def filter(self, record): ...
5683

5784
class ProgramNameFilter(logging.Filter):
5885
@classmethod
59-
def install(cls, handler, fmt, programname: Incomplete | None = None, style=...) -> None: ...
86+
def install(
87+
cls, handler, fmt, programname: Incomplete | None = None, style=...
88+
) -> None: ...
6089
programname: Incomplete
6190
def __init__(self, programname: Incomplete | None = None) -> None: ...
6291
def filter(self, record): ...
6392

6493
class UserNameFilter(logging.Filter):
6594
@classmethod
66-
def install(cls, handler, fmt, username: Incomplete | None = None, style=...) -> None: ...
95+
def install(
96+
cls, handler, fmt, username: Incomplete | None = None, style=...
97+
) -> None: ...
6798
username: Incomplete
6899
def __init__(self, username: Incomplete | None = None) -> None: ...
69100
def filter(self, record): ...
@@ -87,7 +118,9 @@ class FormatStringParser:
87118
def get_pattern(self, field_name): ...
88119
def get_tokens(self, format_string): ...
89120

90-
class FormatStringToken(NamedTuple('FormatStringToken', [('text', Incomplete), ('name', Incomplete)])): ...
121+
class FormatStringToken(
122+
NamedTuple("FormatStringToken", [("text", Incomplete), ("name", Incomplete)])
123+
): ...
91124

92125
class NameNormalizer:
93126
aliases: Incomplete

0 commit comments

Comments
 (0)