mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-06 12:14:27 +08:00
b294782183
This pull request is a follow-up to https://github.com/python/mypy/issues/7214. In short, within that mypy issue, we found it would be helpful to determine between contextmanagers that can "swallow" exceptions vs ones that can't. This helps prevent some false positive when using flags that analyze control flow such as `--warn-unreachable`. To do this, Jelle proposed assuming that only contextmanagers where the `__exit__` returns `bool` are assumed to swallow exceptions. This unfortunately required the following typeshed changes: 1. The typing.IO, threading.Lock, and concurrent.futures.Executor were all modified so `__exit__` returns `Optional[None]` instead of None -- along with all of their subclasses. I believe these three types are meant to be subclassed, so I felt picking the more general type was correct. 2. There were also a few concrete types (e.g. see socketserver, subprocess, ftplib...) that I modified to return `None` -- I checked the source code, and these all seem to return None (and don't appear to be meant to be subclassable). 3. contextlib.suppress was changed to return bool. I also double-checked the unittest modules and modified a subset of those contextmanagers, leaving ones like `_AssertRaisesContext` alone.
88 lines
3.5 KiB
Python
88 lines
3.5 KiB
Python
# Stubs for tempfile
|
|
# Ron Murawski <ron@horizonchess.com>
|
|
|
|
# based on http://docs.python.org/3.3/library/tempfile.html
|
|
|
|
import sys
|
|
from types import TracebackType
|
|
from typing import Any, AnyStr, Generic, IO, Iterable, Iterator, List, Optional, overload, Tuple, Type
|
|
|
|
# global variables
|
|
TMP_MAX: int
|
|
tempdir: Optional[str]
|
|
template: str
|
|
|
|
|
|
def TemporaryFile(
|
|
mode: str = ..., buffering: int = ..., encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ..., suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[AnyStr] = ...
|
|
) -> IO[Any]:
|
|
...
|
|
def NamedTemporaryFile(
|
|
mode: str = ..., buffering: int = ..., encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ..., suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[AnyStr] = ..., delete: bool = ...
|
|
) -> IO[Any]:
|
|
...
|
|
|
|
# It does not actually derive from IO[AnyStr], but it does implement the
|
|
# protocol.
|
|
class SpooledTemporaryFile(IO[AnyStr]):
|
|
def __init__(self, max_size: int = ..., mode: str = ...,
|
|
buffering: int = ..., encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ..., suffix: Optional[str] = ...,
|
|
prefix: Optional[str] = ..., dir: Optional[str] = ...
|
|
) -> None: ...
|
|
def rollover(self) -> None: ...
|
|
def __enter__(self) -> SpooledTemporaryFile: ...
|
|
def __exit__(self, exc_type: Optional[Type[BaseException]],
|
|
exc_val: Optional[BaseException],
|
|
exc_tb: Optional[TracebackType]) -> Optional[bool]: ...
|
|
|
|
# These methods are copied from the abstract methods of IO, because
|
|
# SpooledTemporaryFile implements IO.
|
|
# See also https://github.com/python/typeshed/pull/2452#issuecomment-420657918.
|
|
def close(self) -> None: ...
|
|
def fileno(self) -> int: ...
|
|
def flush(self) -> None: ...
|
|
def isatty(self) -> bool: ...
|
|
def read(self, n: int = ...) -> AnyStr: ...
|
|
def readable(self) -> bool: ...
|
|
def readline(self, limit: int = ...) -> AnyStr: ...
|
|
def readlines(self, hint: int = ...) -> List[AnyStr]: ...
|
|
def seek(self, offset: int, whence: int = ...) -> int: ...
|
|
def seekable(self) -> bool: ...
|
|
def tell(self) -> int: ...
|
|
def truncate(self, size: Optional[int] = ...) -> int: ...
|
|
def writable(self) -> bool: ...
|
|
def write(self, s: AnyStr) -> int: ...
|
|
def writelines(self, lines: Iterable[AnyStr]) -> None: ...
|
|
def __next__(self) -> AnyStr: ...
|
|
def __iter__(self) -> Iterator[AnyStr]: ...
|
|
|
|
class TemporaryDirectory(Generic[AnyStr]):
|
|
name: str
|
|
def __init__(self, suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[AnyStr] = ...) -> None: ...
|
|
def cleanup(self) -> None: ...
|
|
def __enter__(self) -> AnyStr: ...
|
|
def __exit__(self, exc_type: Optional[Type[BaseException]],
|
|
exc_val: Optional[BaseException],
|
|
exc_tb: Optional[TracebackType]) -> None: ...
|
|
|
|
def mkstemp(suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ..., dir: Optional[AnyStr] = ...,
|
|
text: bool = ...) -> Tuple[int, AnyStr]: ...
|
|
@overload
|
|
def mkdtemp() -> str: ...
|
|
@overload
|
|
def mkdtemp(suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[AnyStr] = ...) -> AnyStr: ...
|
|
def mktemp(suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ..., dir: Optional[AnyStr] = ...) -> AnyStr: ...
|
|
|
|
def gettempdirb() -> bytes: ...
|
|
def gettempprefixb() -> bytes: ...
|
|
|
|
def gettempdir() -> str: ...
|
|
def gettempprefix() -> str: ...
|