Files
typeshed/stdlib/shelve.pyi
2023-07-26 16:37:32 +01:00

46 lines
1.9 KiB
Python

from collections.abc import Iterator, MutableMapping
from dbm import _TFlags
from types import TracebackType
from typing import Any, TypeVar, overload
from typing_extensions import Self
__all__ = ["Shelf", "BsdDbShelf", "DbfilenameShelf", "open"]
_T = TypeVar("_T")
_VT = TypeVar("_VT")
class Shelf(MutableMapping[str, _VT]):
def __init__(
self, dict: MutableMapping[bytes, bytes], protocol: int | None = None, writeback: bool = False, keyencoding: str = "utf-8"
) -> None: ...
def __iter__(self) -> Iterator[str]: ...
def __len__(self) -> int: ...
@overload # type: ignore[override]
def get(self, key: str, default: None = None) -> _VT | None: ... # type: ignore[misc] # overlapping overloads
@overload
def get(self, key: str, default: _VT) -> _VT: ...
@overload
def get(self, key: str, default: _T) -> _VT | _T: ...
def __getitem__(self, key: str) -> _VT: ...
def __setitem__(self, key: str, value: _VT) -> None: ...
def __delitem__(self, key: str) -> None: ...
def __contains__(self, key: str) -> bool: ... # type: ignore[override]
def __enter__(self) -> Self: ...
def __exit__(
self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
) -> None: ...
def close(self) -> None: ...
def sync(self) -> None: ...
class BsdDbShelf(Shelf[_VT]):
def set_location(self, key: str) -> tuple[str, _VT]: ...
def next(self) -> tuple[str, _VT]: ...
def previous(self) -> tuple[str, _VT]: ...
def first(self) -> tuple[str, _VT]: ...
def last(self) -> tuple[str, _VT]: ...
class DbfilenameShelf(Shelf[_VT]):
def __init__(self, filename: str, flag: _TFlags = "c", protocol: int | None = None, writeback: bool = False) -> None: ...
def open(filename: str, flag: _TFlags = "c", protocol: int | None = None, writeback: bool = False) -> Shelf[Any]: ...