Skip to content

omnipy.shared.protocols.typing

CLASS DESCRIPTION
IsAbstractSet

Protocol with the same interface as the abstract class typing.AbstractSet.
IsBinaryIO

Protocol with the same interface as the abstract class typing.BinaryIO.
IsHashable
IsIO

Protocol with the same interface as the abstract class typing.IO.
IsItemSequence

Protocol with the same interface as the abstract class typing.Sequence.
IsItemsView

Protocol with the same interface as the abstract class typing.ItemsView.
IsKeysView

Protocol with the same interface as the abstract class typing.KeysView.
IsMapping

Protocol with the same interface as the abstract class typing.Mapping.
IsMappingView

Protocol with the same interface as the abstract class typing.MappingView.
IsMutableMapping

Protocol with the same interface as the abstract class typing.MutableMapping.
IsMutableSequence

Protocol with the same interface as the abstract class typing.MutableSequence.
IsMutableSet

Protocol with the same interface as the abstract class typing.MutableSet.
IsTextIO
IsValuesView

Protocol with the same interface as the abstract class typing.ValuesView.

IsAbstractSet

Bases: Collection[_T_co], Protocol[_T_co]

Protocol with the same interface as the abstract class typing.AbstractSet.

METHOD DESCRIPTION
isdisjoint
Source code in src/omnipy/shared/protocols/typing.py 
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
class IsAbstractSet(Collection[_T_co], Protocol[_T_co]):
    """Protocol with the same interface as the abstract class `typing.AbstractSet`.
    """
    # @abstractmethod
    def __contains__(self, x: object, /) -> bool: raise AssumedToBeImplementedException
    def _hash(self) -> int: raise AssumedToBeImplementedException
    # # Mixin methods
    # @classmethod
    # def _from_iterable(cls, it: Iterable[_S], /) -> IsAbstractSet[_S]: raise AssumedToBeImplementedException
    def __le__(self, other: AbstractSet[Any], /) -> bool: raise AssumedToBeImplementedException
    def __lt__(self, other: AbstractSet[Any], /) -> bool: raise AssumedToBeImplementedException
    def __gt__(self, other: AbstractSet[Any], /) -> bool: raise AssumedToBeImplementedException
    def __ge__(self, other: AbstractSet[Any], /) -> bool: raise AssumedToBeImplementedException
    def __and__(self, other: AbstractSet[Any], /) -> AbstractSet[_T_co]: raise AssumedToBeImplementedException
    def __or__(self, other: AbstractSet[_T], /) -> AbstractSet[_T_co | _T]: raise AssumedToBeImplementedException
    def __sub__(self, other: AbstractSet[Any], /) -> AbstractSet[_T_co]: raise AssumedToBeImplementedException
    def __xor__(self, other: AbstractSet[_T], /) -> AbstractSet[_T_co | _T]: raise AssumedToBeImplementedException
    def __eq__(self, other: object, /) -> bool: raise AssumedToBeImplementedException
    def isdisjoint(self, other: Iterable[Any], /) -> bool: raise AssumedToBeImplementedException

isdisjoint 

isdisjoint(other: Iterable[Any]) -> bool
Source code in src/omnipy/shared/protocols/typing.py 
847
def isdisjoint(self, other: Iterable[Any], /) -> bool: raise AssumedToBeImplementedException

IsBinaryIO

Bases: IsIO[bytes], Protocol

Protocol with the same interface as the abstract class typing.BinaryIO.

METHOD DESCRIPTION
close
fileno
flush
isatty
read
readable
readline
readlines
seek
seekable
tell
truncate
writable
write
writelines
ATTRIBUTE DESCRIPTION
closed

TYPE: bool

mode

TYPE: str

name

TYPE: str | Any

Source code in src/omnipy/shared/protocols/typing.py 
1162
1163
1164
1165
1166
1167
1168
class IsBinaryIO(IsIO[bytes], Protocol):
    """Protocol with the same interface as the abstract class `typing.BinaryIO`.
    """
    # __slots__ = ()
    # @abstractmethod
    # def __enter__(self) -> BinaryIO: ...
    def __enter__(self) -> IsBinaryIO: raise AssumedToBeImplementedException

closed property 

closed: bool

mode property 

mode: str

name property 

name: str | Any

close 

close() -> None
Source code in src/omnipy/shared/protocols/typing.py 
1099
def close(self) -> None: raise AssumedToBeImplementedException

fileno 

fileno() -> int
Source code in src/omnipy/shared/protocols/typing.py 
1103
def fileno(self) -> int: raise AssumedToBeImplementedException

flush 

flush() -> None
Source code in src/omnipy/shared/protocols/typing.py 
1105
def flush(self) -> None: raise AssumedToBeImplementedException

isatty 

isatty() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1107
def isatty(self) -> bool: raise AssumedToBeImplementedException

read 

read(n: int = -1) -> AnyStr
Source code in src/omnipy/shared/protocols/typing.py 
1109
def read(self, n: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException

readable 

readable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1111
def readable(self) -> bool: raise AssumedToBeImplementedException

readline 

readline(limit: int = -1) -> AnyStr
Source code in src/omnipy/shared/protocols/typing.py 
1113
def readline(self, limit: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException

readlines 

readlines(hint: int = -1) -> list[AnyStr]
Source code in src/omnipy/shared/protocols/typing.py 
1115
def readlines(self, hint: int = -1, /) -> list[AnyStr]: raise AssumedToBeImplementedException

seek 

seek(offset: int, whence: int = 0) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1117
def seek(self, offset: int, whence: int = 0, /) -> int: raise AssumedToBeImplementedException

seekable 

seekable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1119
def seekable(self) -> bool: raise AssumedToBeImplementedException

tell 

tell() -> int
Source code in src/omnipy/shared/protocols/typing.py 
1121
def tell(self) -> int: raise AssumedToBeImplementedException

truncate 

truncate(size: int | None = None) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1123
def truncate(self, size: int | None = None, /) -> int: raise AssumedToBeImplementedException

writable 

writable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1125
def writable(self) -> bool: raise AssumedToBeImplementedException

write 

write(s: ReadableBuffer) -> int

write(s: AnyStr) -> int

write(s: AnyStr | ReadableBuffer) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1134
def write(self, s: AnyStr | ReadableBuffer, /) -> int: raise AssumedToBeImplementedException

writelines 

writelines(lines: Iterable[ReadableBuffer]) -> None

writelines(lines: Iterable[AnyStr]) -> None

writelines(lines: Iterable[AnyStr] | Iterable[ReadableBuffer]) -> None
Source code in src/omnipy/shared/protocols/typing.py 
1143
1144
1145
1146
1147
def writelines(
    self,
    lines: Iterable[AnyStr] | Iterable[ReadableBuffer],
    /,
) -> None: raise AssumedToBeImplementedException

IsHashable

Bases: Protocol

Source code in src/omnipy/shared/protocols/typing.py 
561
562
563
564
565
566
567
568
@runtime_checkable
# class Hashable(Protocol, metaclass=ABCMeta):
class IsHashable(Protocol):
    # TODO: This is special, in that a subclass of a hashable class may not be hashable
    #   (for example, list vs. object). It's not obvious how to represent this. This class
    #   is currently mostly useless for static checking.
    # @abstractmethod
    def __hash__(self) -> int: raise AssumedToBeImplementedException

IsIO

Bases: Protocol[AnyStr]

Protocol with the same interface as the abstract class typing.IO.

METHOD DESCRIPTION
close
fileno
flush
isatty
read
readable
readline
readlines
seek
seekable
tell
truncate
writable
write
writelines
ATTRIBUTE DESCRIPTION
closed

TYPE: bool

mode

TYPE: str

name

TYPE: str | Any

Source code in src/omnipy/shared/protocols/typing.py 
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
class IsIO(Protocol[AnyStr]):
    """Protocol with the same interface as the abstract class `typing.IO`.
    """
    # At runtime these are all abstract properties,
    # but making them abstract in the stub is hugely disruptive, for not much gain.
    # See #8726
    # __slots__ = ()
    @property
    def mode(self) -> str: raise AssumedToBeImplementedException
    # Usually str, but may be bytes if a bytes path was passed to open(). See #10737.
    # If PEP 696 becomes available, we may want to use a defaulted TypeVar here.
    @property
    def name(self) -> str | Any: raise AssumedToBeImplementedException
    # @abstractmethod
    def close(self) -> None: raise AssumedToBeImplementedException
    @property
    def closed(self) -> bool: raise AssumedToBeImplementedException
    # @abstractmethod
    def fileno(self) -> int: raise AssumedToBeImplementedException
    # @abstractmethod
    def flush(self) -> None: raise AssumedToBeImplementedException
    # @abstractmethod
    def isatty(self) -> bool: raise AssumedToBeImplementedException
    # @abstractmethod
    def read(self, n: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException
    # @abstractmethod
    def readable(self) -> bool: raise AssumedToBeImplementedException
    # @abstractmethod
    def readline(self, limit: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException
    # @abstractmethod
    def readlines(self, hint: int = -1, /) -> list[AnyStr]: raise AssumedToBeImplementedException
    # @abstractmethod
    def seek(self, offset: int, whence: int = 0, /) -> int: raise AssumedToBeImplementedException
    # @abstractmethod
    def seekable(self) -> bool: raise AssumedToBeImplementedException
    # @abstractmethod
    def tell(self) -> int: raise AssumedToBeImplementedException
    # @abstractmethod
    def truncate(self, size: int | None = None, /) -> int: raise AssumedToBeImplementedException
    # @abstractmethod
    def writable(self) -> bool: raise AssumedToBeImplementedException

    # @abstractmethod
    @overload
    # def write(self: IO[bytes], s: ReadableBuffer, /) -> int: ...
    def write(self: IsIO[bytes], s: ReadableBuffer, /) -> int: raise AssumedToBeImplementedException
    # @abstractmethod
    @overload
    def write(self, s: AnyStr, /) -> int: raise AssumedToBeImplementedException
    def write(self, s: AnyStr | ReadableBuffer, /) -> int: raise AssumedToBeImplementedException

    # @abstractmethod
    @overload
    # def writelines(self: IO[bytes], lines: Iterable[ReadableBuffer], /) -> None: ...
    def writelines(self: IsIO[bytes], lines: Iterable[ReadableBuffer], /) -> None: raise AssumedToBeImplementedException
    # @abstractmethod
    @overload
    def writelines(self, lines: Iterable[AnyStr], /) -> None: raise AssumedToBeImplementedException
    def writelines(
        self,
        lines: Iterable[AnyStr] | Iterable[ReadableBuffer],
        /,
    ) -> None: raise AssumedToBeImplementedException

    # @abstractmethod
    def __next__(self) -> AnyStr: raise AssumedToBeImplementedException
    # @abstractmethod
    def __iter__(self) -> Iterator[AnyStr]: raise AssumedToBeImplementedException
    # @abstractmethod
    # def __enter__(self) -> IO[AnyStr]: ...
    def __enter__(self) -> IsIO[AnyStr]: raise AssumedToBeImplementedException
    # @abstractmethod
    def __exit__(
        self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None, /
    ) -> None: raise AssumedToBeImplementedException

closed property 

closed: bool

mode property 

mode: str

name property 

name: str | Any

close 

close() -> None
Source code in src/omnipy/shared/protocols/typing.py 
1099
def close(self) -> None: raise AssumedToBeImplementedException

fileno 

fileno() -> int
Source code in src/omnipy/shared/protocols/typing.py 
1103
def fileno(self) -> int: raise AssumedToBeImplementedException

flush 

flush() -> None
Source code in src/omnipy/shared/protocols/typing.py 
1105
def flush(self) -> None: raise AssumedToBeImplementedException

isatty 

isatty() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1107
def isatty(self) -> bool: raise AssumedToBeImplementedException

read 

read(n: int = -1) -> AnyStr
Source code in src/omnipy/shared/protocols/typing.py 
1109
def read(self, n: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException

readable 

readable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1111
def readable(self) -> bool: raise AssumedToBeImplementedException

readline 

readline(limit: int = -1) -> AnyStr
Source code in src/omnipy/shared/protocols/typing.py 
1113
def readline(self, limit: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException

readlines 

readlines(hint: int = -1) -> list[AnyStr]
Source code in src/omnipy/shared/protocols/typing.py 
1115
def readlines(self, hint: int = -1, /) -> list[AnyStr]: raise AssumedToBeImplementedException

seek 

seek(offset: int, whence: int = 0) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1117
def seek(self, offset: int, whence: int = 0, /) -> int: raise AssumedToBeImplementedException

seekable 

seekable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1119
def seekable(self) -> bool: raise AssumedToBeImplementedException

tell 

tell() -> int
Source code in src/omnipy/shared/protocols/typing.py 
1121
def tell(self) -> int: raise AssumedToBeImplementedException

truncate 

truncate(size: int | None = None) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1123
def truncate(self, size: int | None = None, /) -> int: raise AssumedToBeImplementedException

writable 

writable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1125
def writable(self) -> bool: raise AssumedToBeImplementedException

write 

write(s: ReadableBuffer) -> int

write(s: AnyStr) -> int

write(s: AnyStr | ReadableBuffer) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1134
def write(self, s: AnyStr | ReadableBuffer, /) -> int: raise AssumedToBeImplementedException

writelines 

writelines(lines: Iterable[ReadableBuffer]) -> None

writelines(lines: Iterable[AnyStr]) -> None

writelines(lines: Iterable[AnyStr] | Iterable[ReadableBuffer]) -> None
Source code in src/omnipy/shared/protocols/typing.py 
1143
1144
1145
1146
1147
def writelines(
    self,
    lines: Iterable[AnyStr] | Iterable[ReadableBuffer],
    /,
) -> None: raise AssumedToBeImplementedException

IsItemSequence

Bases: Reversible[_T_co], Collection[_T_co], Protocol[_T_co]

Protocol with the same interface as the abstract class typing.Sequence.

Note that with no custom handling, as is typically done in a type checker, the string, bytes, and bytearray types will not be considered Sequences by this protocol, due to differences in the __contains__ method.

METHOD DESCRIPTION
count

S.count(value) -> integer -- return number of occurrences of value
index

S.index(value, [start, [stop]]) -> integer -- return first index of value.
Source code in src/omnipy/shared/protocols/typing.py 
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
class IsItemSequence(Reversible[_T_co], Collection[_T_co], Protocol[_T_co]):
    """Protocol with the same interface as the abstract class `typing.Sequence`.

    Note that with no custom handling, as is typically done in a type
    checker, the `string`, `bytes`, and `bytearray` types will not be
    considered Sequences by this protocol, due to differences in the
    `__contains__` method.
    """
    @overload
    # @abstractmethod
    def __getitem__(self, index: int, /) -> _T_co: raise AssumedToBeImplementedException
    @overload
    # @abstractmethod
    # def __getitem__(self, index: slice[int | None], /) -> Sequence[_T_co]:
    def __getitem__(self, index: slice, /) -> IsItemSequence[_T_co]: raise AssumedToBeImplementedException
    def __getitem__(self, index: int | slice, /) -> _T_co | IsItemSequence[_T_co]: raise AssumedToBeImplementedException

    # Mixin methods
    # def index(self, value: Any, start: int = 0, stop: int = ..., /) -> int:
    # Omnipy: start and stop removed to support range as IsItemSequence
    def index(self, value: Any, /) -> int:
        """
        S.index(value, [start, [stop]]) -> integer -- return first index of value.
        Raises ValueError if the value is not present.

        Supporting start and stop arguments is optional, but recommended.
        """
        raise AssumedToBeImplementedException
    def count(self, value: Any, /) -> int:
        """
        S.count(value) -> integer -- return number of occurrences of value
        """
        raise AssumedToBeImplementedException

    def __contains__(self, value: object, /) -> bool: raise AssumedToBeImplementedException
    def __iter__(self) -> Iterator[_T_co]: raise AssumedToBeImplementedException
    def __reversed__(self) -> Iterator[_T_co]: raise AssumedToBeImplementedException

count 

count(value: Any) -> int

S.count(value) -> integer -- return number of occurrences of value

Source code in src/omnipy/shared/protocols/typing.py 
738
739
740
741
742
def count(self, value: Any, /) -> int:
    """
    S.count(value) -> integer -- return number of occurrences of value
    """
    raise AssumedToBeImplementedException

index 

index(value: Any) -> int

S.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

Source code in src/omnipy/shared/protocols/typing.py 
730
731
732
733
734
735
736
737
def index(self, value: Any, /) -> int:
    """
    S.index(value, [start, [stop]]) -> integer -- return first index of value.
    Raises ValueError if the value is not present.

    Supporting start and stop arguments is optional, but recommended.
    """
    raise AssumedToBeImplementedException

IsItemsView

Bases: IsMappingView, IsAbstractSet[tuple[_KT_co, _VT_co]], Protocol[_KT_co, _VT_co]

Protocol with the same interface as the abstract class typing.ItemsView.

METHOD DESCRIPTION
isdisjoint
Source code in src/omnipy/shared/protocols/typing.py 
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
class IsItemsView(IsMappingView, IsAbstractSet[tuple[_KT_co, _VT_co]], Protocol[_KT_co, _VT_co]):
    """Protocol with the same interface as the abstract class `typing.ItemsView`.
    """
    # def __init__(self, mapping: SupportsGetItemViewable[_KT_co, _VT_co]) -> None: ...  # undocumented
    # @classmethod
    # def _from_iterable(cls, it: Iterable[_S], /) -> set[_S]: ...
    def __and__(self, other: Iterable[Any], /) -> set[tuple[_KT_co, _VT_co]]: raise AssumedToBeImplementedException
    def __rand__(self, other: Iterable[_T], /) -> set[_T]: raise AssumedToBeImplementedException
    def __contains__(self, item: tuple[object, object], /) -> bool: raise AssumedToBeImplementedException  # type: ignore[override]
    def __iter__(self) -> Iterator[tuple[_KT_co, _VT_co]]: raise AssumedToBeImplementedException
    def __or__(self, other: Iterable[_T], /) -> set[tuple[_KT_co, _VT_co] | _T]: raise AssumedToBeImplementedException
    def __ror__(self, other: Iterable[_T], /) -> set[tuple[_KT_co, _VT_co] | _T]: raise AssumedToBeImplementedException
    def __sub__(self, other: Iterable[Any], /) -> set[tuple[_KT_co, _VT_co]]: raise AssumedToBeImplementedException
    def __rsub__(self, other: Iterable[_T], /) -> set[_T]: raise AssumedToBeImplementedException
    def __xor__(self, other: Iterable[_T], /) -> set[tuple[_KT_co, _VT_co] | _T]: raise AssumedToBeImplementedException
    def __rxor__(self, other: Iterable[_T], /) -> set[tuple[_KT_co, _VT_co] | _T]: raise AssumedToBeImplementedException

isdisjoint 

isdisjoint(other: Iterable[Any]) -> bool
Source code in src/omnipy/shared/protocols/typing.py 
847
def isdisjoint(self, other: Iterable[Any], /) -> bool: raise AssumedToBeImplementedException

IsKeysView

Bases: IsMappingView, IsAbstractSet[_KT_co], Protocol[_KT_co]

Protocol with the same interface as the abstract class typing.KeysView.

METHOD DESCRIPTION
isdisjoint
Source code in src/omnipy/shared/protocols/typing.py 
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
class IsKeysView(IsMappingView, IsAbstractSet[_KT_co], Protocol[_KT_co]):  # type: ignore[misc]
    """Protocol with the same interface as the abstract class `typing.KeysView`.
    """
    # def __init__(self, mapping: Viewable[_KT_co]) -> None: ...  # undocumented
    # @classmethod
    # def _from_iterable(cls, it: Iterable[_S], /) -> set[_S]: ...
    def __and__(self, other: Iterable[Any], /) -> set[_KT_co]: raise AssumedToBeImplementedException
    def __rand__(self, other: Iterable[_T], /) -> set[_T]: raise AssumedToBeImplementedException
    def __contains__(self, key: object, /) -> bool: raise AssumedToBeImplementedException
    def __iter__(self) -> Iterator[_KT_co]: raise AssumedToBeImplementedException
    def __or__(self, other: Iterable[_T], /) -> set[_KT_co | _T]: raise AssumedToBeImplementedException
    def __ror__(self, other: Iterable[_T], /) -> set[_KT_co | _T]: raise AssumedToBeImplementedException
    def __sub__(self, other: Iterable[Any], /) -> set[_KT_co]: raise AssumedToBeImplementedException
    def __rsub__(self, other: Iterable[_T], /) -> set[_T]: raise AssumedToBeImplementedException
    def __xor__(self, other: Iterable[_T], /) -> set[_KT_co | _T]: raise AssumedToBeImplementedException
    def __rxor__(self, other: Iterable[_T], /) -> set[_KT_co | _T]: raise AssumedToBeImplementedException

isdisjoint 

isdisjoint(other: Iterable[Any]) -> bool
Source code in src/omnipy/shared/protocols/typing.py 
847
def isdisjoint(self, other: Iterable[Any], /) -> bool: raise AssumedToBeImplementedException

IsMapping

Bases: Collection[_KT], Protocol[_KT, _VT_co]

Protocol with the same interface as the abstract class typing.Mapping.

IsMapping is the protocol of a generic container for associating key/value pairs.

METHOD DESCRIPTION
get

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
keys

D.keys() -> a set-like object providing a view on D's keys
values

D.values() -> an object providing a view on D's values
Source code in src/omnipy/shared/protocols/typing.py 
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
@runtime_checkable
class IsMapping(Collection[_KT], Protocol[_KT, _VT_co]):  # type: ignore[misc]
    """Protocol with the same interface as the abstract class `typing.Mapping`.

    IsMapping is the protocol of a generic container for associating
    key/value pairs.
    """

    # TODO: We wish the key type could also be covariant, but that doesn't work,
    # see discussion in https://github.com/python/typing/pull/273.
    # @abstractmethod
    def __getitem__(self, key: _KT, /) -> _VT_co: raise AssumedToBeImplementedException

    # Mixin methods
    @overload
    def get(self, key: _KT, /) -> _VT_co | None: raise AssumedToBeImplementedException
    @overload
    def get(self, key: _KT, default: _VT_co, /) -> _VT_co: raise AssumedToBeImplementedException  # type: ignore[misc]
    @overload
    def get(self, key: _KT, default: _T, /) -> _VT_co | _T: raise AssumedToBeImplementedException
    def get(self, key: _KT, default: None | _VT_co | _T = None, /) -> _VT_co | _T | None:
        """
        D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
        """
        raise AssumedToBeImplementedException

    # # def items(self) -> ItemsView[_KT, _VT_co]: ...
    # def items(self) -> IsItemsView[_KT, _VT_co]:
    #     """
    #     D.items() -> a set-like object providing a view on D's items
    #     """
    #     raise AssumedToBeImplementedException

    def keys(self) -> IsKeysView[_KT]:
        """
        D.keys() -> a set-like object providing a view on D's keys
        """
        raise AssumedToBeImplementedException

    def values(self) -> IsValuesView[_VT_co]:
        """
        D.values() -> an object providing a view on D's values
        """
        raise AssumedToBeImplementedException

    def __contains__(self, key: object, /) -> bool: raise AssumedToBeImplementedException
    def __eq__(self, other: object, /) -> bool: raise AssumedToBeImplementedException

get 

get(key: _KT) -> _VT_co | None

get(key: _KT, default: _VT_co) -> _VT_co

get(key: _KT, default: _T) -> _VT_co | _T

get(key: _KT, default: None | _VT_co | _T = None) -> _VT_co | _T | None

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

Source code in src/omnipy/shared/protocols/typing.py 
949
950
951
952
953
def get(self, key: _KT, default: None | _VT_co | _T = None, /) -> _VT_co | _T | None:
    """
    D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
    """
    raise AssumedToBeImplementedException

keys 

keys() -> IsKeysView[_KT]

D.keys() -> a set-like object providing a view on D's keys

Source code in src/omnipy/shared/protocols/typing.py 
962
963
964
965
966
def keys(self) -> IsKeysView[_KT]:
    """
    D.keys() -> a set-like object providing a view on D's keys
    """
    raise AssumedToBeImplementedException

values 

values() -> IsValuesView[_VT_co]

D.values() -> an object providing a view on D's values

Source code in src/omnipy/shared/protocols/typing.py 
968
969
970
971
972
def values(self) -> IsValuesView[_VT_co]:
    """
    D.values() -> an object providing a view on D's values
    """
    raise AssumedToBeImplementedException

IsMappingView

Bases: Protocol

Protocol with the same interface as the abstract class typing.MappingView.

Source code in src/omnipy/shared/protocols/typing.py 
869
870
871
872
873
874
class IsMappingView(Protocol):
    """Protocol with the same interface as the abstract class `typing.MappingView`.
    """
    # __slots__ = ("_mapping",)
    # def __init__(self, mapping: Sized) -> None: ...  # undocumented
    def __len__(self) -> int: raise AssumedToBeImplementedException

IsMutableMapping

Bases: IsMapping[_KT, _VT], Protocol[_KT, _VT]

Protocol with the same interface as the abstract class typing.MutableMapping.

IsMutableMapping is the protocol of a generic mutable container for associating key/value pairs.

METHOD DESCRIPTION
clear

D.clear() -> None. Remove all items from D.
get

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
keys

D.keys() -> a set-like object providing a view on D's keys
pop

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
popitem

D.popitem() -> (k, v), remove and return some (key, value) pair
setdefault

D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
update

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.
values

D.values() -> an object providing a view on D's values
Source code in src/omnipy/shared/protocols/typing.py 
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
class IsMutableMapping(IsMapping[_KT, _VT], Protocol[_KT, _VT]):
    """Protocol with the same interface as the abstract class `typing.MutableMapping`.

    IsMutableMapping is the protocol of a generic mutable container for
    associating key/value pairs.
    """

    # @abstractmethod
    def __setitem__(self, key: _KT, value: _VT, /) -> None: raise AssumedToBeImplementedException
    # @abstractmethod
    def __delitem__(self, key: _KT, /) -> None: raise AssumedToBeImplementedException

    def clear(self) -> None:
        """
        D.clear() -> None.  Remove all items from D.
        """
        raise AssumedToBeImplementedException

    @overload
    def pop(self, key: _KT, /) -> _VT: raise AssumedToBeImplementedException
    @overload
    def pop(self, key: _KT, default: _VT, /) -> _VT: raise AssumedToBeImplementedException
    @overload
    def pop(self, key: _KT, default: _T, /) -> _VT | _T: raise AssumedToBeImplementedException
    def pop(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None:
        """
        D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
        If key is not found, d is returned if given, otherwise KeyError is raised.
        """
        raise AssumedToBeImplementedException

    def popitem(self) -> tuple[_KT, _VT]:
        """
        D.popitem() -> (k, v), remove and return some (key, value) pair
           as a 2-tuple; but raise KeyError if D is empty.
        """
        raise AssumedToBeImplementedException

    # This overload should be allowed only if the value type is compatible with None.
    #
    # Keep the following methods in line with MutableMapping.setdefault, modulo positional-only differences:
    # -- collections.OrderedDict.setdefault
    # -- collections.ChainMap.setdefault
    # -- weakref.WeakKeyDictionary.setdefault
    # @overload
    # def setdefault(self: MutableMapping[_KT, _T | None], key: _KT, default: None = None, /) -> _T | None: ...
    # @overload
    def setdefault(self, key: _KT, default: _VT, /) -> _VT:
        """
        D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
        """
        raise AssumedToBeImplementedException
    # def setdefault(self: IsMutableMapping[_KT, _VT] | IsMutableMapping[_KT, _T | None], key: _KT, default: _VT | None = None, /) -> _VT | _T | None: raise AssumedToBeImplementedException

    # 'update' used to take a Union, but using overloading is better.
    # The second overloaded type here is a bit too general, because
    # Mapping[tuple[_KT, _VT], W] is a subclass of Iterable[tuple[_KT, _VT]],
    # but will always have the behavior of the first overloaded type
    # at runtime, leading to keys of a mix of types _KT and tuple[_KT, _VT].
    # We don't currently have any way of forcing all Mappings to use
    # the first overload, but by using overloading rather than a Union,
    # mypy will commit to using the first overload when the argument is
    # known to be a Mapping with unknown type parameters, which is closer
    # to the behavior we want. See mypy issue  #1430.
    #
    # Various mapping classes have __ior__ methods that should be kept roughly in line with .update():
    # -- dict.__ior__
    # -- os._Environ.__ior__
    # -- collections.UserDict.__ior__
    # -- collections.ChainMap.__ior__
    # -- peewee.attrdict.__add__
    # -- peewee.attrdict.__iadd__
    # -- weakref.WeakValueDictionary.__ior__
    # -- weakref.WeakKeyDictionary.__ior__
    @overload
    def update(self, m: SupportsKeysAndGetItem[_KT, _VT], /) -> None: raise AssumedToBeImplementedException
    @overload
    def update(self: SupportsGetItem[str, _VT], m: SupportsKeysAndGetItem[str, _VT], /, **kwargs: _VT) -> None:  raise AssumedToBeImplementedException
    @overload
    def update(self, m: Iterable[tuple[_KT, _VT]], /) -> None: raise AssumedToBeImplementedException
    @overload
    def update(self: SupportsGetItem[str, _VT], m: Iterable[tuple[str, _VT]], /, **kwargs: _VT) -> None: raise AssumedToBeImplementedException
    @overload
    def update(self: SupportsGetItem[str, _VT], /, **kwargs: _VT) -> None: raise AssumedToBeImplementedException
    def update(
        self,
        m: (SupportsKeysAndGetItem[_KT, _VT] | SupportsKeysAndGetItem[str, _VT]
            | Iterable[tuple[_KT, _VT]] | Iterable[tuple[str, _VT]] | None) = None,
        /,
        **kwargs: _VT,
    ) -> None:
        """
        D.update([E, ]**F) -> None.  Update D from mapping/iterable E and F.
        If E present and has a .keys() method, does:     for k in E: D[k] = E[k]
        If E present and lacks .keys() method, does:     for (k, v) in E: D[k] = v
        In either case, this is followed by: for k, v in F.items(): D[k] = v
        """
        raise AssumedToBeImplementedException

clear 

clear() -> None

D.clear() -> None. Remove all items from D.

Source code in src/omnipy/shared/protocols/typing.py 
990
991
992
993
994
def clear(self) -> None:
    """
    D.clear() -> None.  Remove all items from D.
    """
    raise AssumedToBeImplementedException

get 

get(key: _KT) -> _VT_co | None

get(key: _KT, default: _VT_co) -> _VT_co

get(key: _KT, default: _T) -> _VT_co | _T

get(key: _KT, default: None | _VT_co | _T = None) -> _VT_co | _T | None

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

Source code in src/omnipy/shared/protocols/typing.py 
949
950
951
952
953
def get(self, key: _KT, default: None | _VT_co | _T = None, /) -> _VT_co | _T | None:
    """
    D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
    """
    raise AssumedToBeImplementedException

keys 

keys() -> IsKeysView[_KT]

D.keys() -> a set-like object providing a view on D's keys

Source code in src/omnipy/shared/protocols/typing.py 
962
963
964
965
966
def keys(self) -> IsKeysView[_KT]:
    """
    D.keys() -> a set-like object providing a view on D's keys
    """
    raise AssumedToBeImplementedException

pop 

pop(key: _KT) -> _VT

pop(key: _KT, default: _VT) -> _VT

pop(key: _KT, default: _T) -> _VT | _T

pop(key: _KT, default: None | _VT | _T = None) -> _VT | _T | None

D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

Source code in src/omnipy/shared/protocols/typing.py 
1002
1003
1004
1005
1006
1007
def pop(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None:
    """
    D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
    If key is not found, d is returned if given, otherwise KeyError is raised.
    """
    raise AssumedToBeImplementedException

popitem 

popitem() -> tuple[_KT, _VT]

D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

Source code in src/omnipy/shared/protocols/typing.py 
1009
1010
1011
1012
1013
1014
def popitem(self) -> tuple[_KT, _VT]:
    """
    D.popitem() -> (k, v), remove and return some (key, value) pair
       as a 2-tuple; but raise KeyError if D is empty.
    """
    raise AssumedToBeImplementedException

setdefault 

setdefault(key: _KT, default: _VT) -> _VT

D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

Source code in src/omnipy/shared/protocols/typing.py 
1025
1026
1027
1028
1029
def setdefault(self, key: _KT, default: _VT, /) -> _VT:
    """
    D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
    """
    raise AssumedToBeImplementedException

update 

update(m: SupportsKeysAndGetItem[_KT, _VT]) -> None

update(m: SupportsKeysAndGetItem[str, _VT], /, **kwargs: _VT) -> None

update(m: Iterable[tuple[_KT, _VT]]) -> None

update(m: Iterable[tuple[str, _VT]], /, **kwargs: _VT) -> None

update(**kwargs: _VT) -> None

update(
    m: SupportsKeysAndGetItem[_KT, _VT]
    | SupportsKeysAndGetItem[str, _VT]
    | Iterable[tuple[_KT, _VT]]
    | Iterable[tuple[str, _VT]]
    | None = None,
    /,
    **kwargs: _VT,
) -> None

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

Source code in src/omnipy/shared/protocols/typing.py 
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
def update(
    self,
    m: (SupportsKeysAndGetItem[_KT, _VT] | SupportsKeysAndGetItem[str, _VT]
        | Iterable[tuple[_KT, _VT]] | Iterable[tuple[str, _VT]] | None) = None,
    /,
    **kwargs: _VT,
) -> None:
    """
    D.update([E, ]**F) -> None.  Update D from mapping/iterable E and F.
    If E present and has a .keys() method, does:     for k in E: D[k] = E[k]
    If E present and lacks .keys() method, does:     for (k, v) in E: D[k] = v
    In either case, this is followed by: for k, v in F.items(): D[k] = v
    """
    raise AssumedToBeImplementedException

values 

values() -> IsValuesView[_VT_co]

D.values() -> an object providing a view on D's values

Source code in src/omnipy/shared/protocols/typing.py 
968
969
970
971
972
def values(self) -> IsValuesView[_VT_co]:
    """
    D.values() -> an object providing a view on D's values
    """
    raise AssumedToBeImplementedException

IsMutableSequence

Bases: IsItemSequence[_T], Protocol[_T]

Protocol with the same interface as the abstract class typing.MutableSequence.

METHOD DESCRIPTION
append

S.append(value) -- append value to the end of the sequence
clear

S.clear() -> None -- remove all items from S
count

S.count(value) -> integer -- return number of occurrences of value
extend

S.extend(iterable) -- extend sequence by appending elements from the iterable
index

S.index(value, [start, [stop]]) -> integer -- return first index of value.
insert

S.insert(index, value) -- insert value before index
pop

S.pop([index]) -> item -- remove and return item at index (default last).
remove

S.remove(value) -- remove first occurrence of value.
reverse

S.reverse() -- reverse IN PLACE
Source code in src/omnipy/shared/protocols/typing.py 
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
class IsMutableSequence(IsItemSequence[_T], Protocol[_T]):
    """Protocol with the same interface as the abstract class `typing.MutableSequence`.
    """

    # @abstractmethod
    def insert(self, index: int, value: _T, /) -> None:
        """
        S.insert(index, value) -- insert value before index
        """
        raise AssumedToBeImplementedException

    @overload
    # @abstractmethod
    def __getitem__(self, index: int, /) -> _T: raise AssumedToBeImplementedException
    @overload
    # @abstractmethod
    # def __getitem__(self, index: slice[int | None], /) -> MutableSequence[_T]: ...
    def __getitem__(self, index: slice, /) -> IsMutableSequence[_T]: raise AssumedToBeImplementedException
    def __getitem__(self, index: int | slice, /) -> _T | IsMutableSequence[_T_co]: raise AssumedToBeImplementedException

    @overload
    # @abstractmethod
    def __setitem__(self, index: int, value: _T, /) -> None: raise AssumedToBeImplementedException
    @overload
    # @abstractmethod
    # def __setitem__(self, index: slice[int | None], value: Iterable[_T], /) -> None: ...
    def __setitem__(self, index: slice, value: Iterable[_T], /) -> None: raise AssumedToBeImplementedException
    def __setitem__(self, index: int | slice, value: _T | Iterable[_T], /) -> None: raise AssumedToBeImplementedException

    @overload
    # @abstractmethod
    def __delitem__(self, index: int, /) -> None: raise AssumedToBeImplementedException
    @overload
    # @abstractmethod
    # def __delitem__(self, index: slice[int | None], /) -> None: ...
    def __delitem__(self, index: slice, /) -> None: raise AssumedToBeImplementedException
    def __delitem__(self, index: int | slice, /) -> None: raise AssumedToBeImplementedException

    # Mixin methods
    def append(self, value: _T, /) -> None:
        """
        S.append(value) -- append value to the end of the sequence
        """
        raise AssumedToBeImplementedException

    def clear(self) -> None:
        """
        S.clear() -> None -- remove all items from S
        """
        raise AssumedToBeImplementedException

    def extend(self, values: Iterable[_T], /) -> None:
        """
        S.extend(iterable) -- extend sequence by appending elements from the iterable
        """
        raise AssumedToBeImplementedException

    def reverse(self) -> None:
        """
        S.reverse() -- reverse *IN PLACE*
        """
        raise AssumedToBeImplementedException

    def pop(self, index: int = -1, /) -> _T:
        """
        S.pop([index]) -> item -- remove and return item at index (default last).
        Raise IndexError if list is empty or index is out of range.
        """
        raise AssumedToBeImplementedException

    def remove(self, value: _T, /) -> None:
        """
        S.remove(value) -- remove first occurrence of value.
        Raise ValueError if the value is not present.
        """
        raise AssumedToBeImplementedException

    def __iadd__(self, values: Iterable[_T], /) -> Self: raise AssumedToBeImplementedException

append 

append(value: _T) -> None

S.append(value) -- append value to the end of the sequence

Source code in src/omnipy/shared/protocols/typing.py 
788
789
790
791
792
def append(self, value: _T, /) -> None:
    """
    S.append(value) -- append value to the end of the sequence
    """
    raise AssumedToBeImplementedException

clear 

clear() -> None

S.clear() -> None -- remove all items from S

Source code in src/omnipy/shared/protocols/typing.py 
794
795
796
797
798
def clear(self) -> None:
    """
    S.clear() -> None -- remove all items from S
    """
    raise AssumedToBeImplementedException

count 

count(value: Any) -> int

S.count(value) -> integer -- return number of occurrences of value

Source code in src/omnipy/shared/protocols/typing.py 
738
739
740
741
742
def count(self, value: Any, /) -> int:
    """
    S.count(value) -> integer -- return number of occurrences of value
    """
    raise AssumedToBeImplementedException

extend 

extend(values: Iterable[_T]) -> None

S.extend(iterable) -- extend sequence by appending elements from the iterable

Source code in src/omnipy/shared/protocols/typing.py 
800
801
802
803
804
def extend(self, values: Iterable[_T], /) -> None:
    """
    S.extend(iterable) -- extend sequence by appending elements from the iterable
    """
    raise AssumedToBeImplementedException

index 

index(value: Any) -> int

S.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

Source code in src/omnipy/shared/protocols/typing.py 
730
731
732
733
734
735
736
737
def index(self, value: Any, /) -> int:
    """
    S.index(value, [start, [stop]]) -> integer -- return first index of value.
    Raises ValueError if the value is not present.

    Supporting start and stop arguments is optional, but recommended.
    """
    raise AssumedToBeImplementedException

insert 

insert(index: int, value: _T) -> None

S.insert(index, value) -- insert value before index

Source code in src/omnipy/shared/protocols/typing.py 
754
755
756
757
758
def insert(self, index: int, value: _T, /) -> None:
    """
    S.insert(index, value) -- insert value before index
    """
    raise AssumedToBeImplementedException

pop 

pop(index: int = -1) -> _T

S.pop([index]) -> item -- remove and return item at index (default last). Raise IndexError if list is empty or index is out of range.

Source code in src/omnipy/shared/protocols/typing.py 
812
813
814
815
816
817
def pop(self, index: int = -1, /) -> _T:
    """
    S.pop([index]) -> item -- remove and return item at index (default last).
    Raise IndexError if list is empty or index is out of range.
    """
    raise AssumedToBeImplementedException

remove 

remove(value: _T) -> None

S.remove(value) -- remove first occurrence of value. Raise ValueError if the value is not present.

Source code in src/omnipy/shared/protocols/typing.py 
819
820
821
822
823
824
def remove(self, value: _T, /) -> None:
    """
    S.remove(value) -- remove first occurrence of value.
    Raise ValueError if the value is not present.
    """
    raise AssumedToBeImplementedException

reverse 

reverse() -> None

S.reverse() -- reverse IN PLACE

Source code in src/omnipy/shared/protocols/typing.py 
806
807
808
809
810
def reverse(self) -> None:
    """
    S.reverse() -- reverse *IN PLACE*
    """
    raise AssumedToBeImplementedException

IsMutableSet

Bases: IsAbstractSet[_T], Protocol[_T]

Protocol with the same interface as the abstract class typing.MutableSet.

METHOD DESCRIPTION
add
clear
discard
isdisjoint
pop
remove
Source code in src/omnipy/shared/protocols/typing.py 
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
class IsMutableSet(IsAbstractSet[_T], Protocol[_T]):
    """Protocol with the same interface as the abstract class `typing.MutableSet`.
    """
    # @abstractmethod
    def add(self, value: _T, /) -> None: raise AssumedToBeImplementedException
    # @abstractmethod
    def discard(self, value: _T, /) -> None: raise AssumedToBeImplementedException
    # Mixin methods
    def clear(self) -> None: raise AssumedToBeImplementedException
    def pop(self) -> _T: raise AssumedToBeImplementedException
    def remove(self, value: _T, /) -> None: raise AssumedToBeImplementedException
    def __ior__(self, it: AbstractSet[_T], /) -> Self: raise AssumedToBeImplementedException  # type: ignore[misc, override]
    # def __iand__(self, it: AbstractSet[Any], /) -> typing_extensions.Self: ...
    def __iand__(self, it: AbstractSet[Any], /) -> Self: raise AssumedToBeImplementedException
    def __ixor__(self, it: AbstractSet[_T], /) -> Self: raise AssumedToBeImplementedException  # type: ignore[misc, override]
    # def __isub__(self, it: AbstractSet[Any], /) -> typing_extensions.Self: ...
    def __isub__(self, it: AbstractSet[Any], /) -> Self: raise AssumedToBeImplementedException

add 

add(value: _T) -> None
Source code in src/omnipy/shared/protocols/typing.py 
854
def add(self, value: _T, /) -> None: raise AssumedToBeImplementedException

clear 

clear() -> None
Source code in src/omnipy/shared/protocols/typing.py 
858
def clear(self) -> None: raise AssumedToBeImplementedException

discard 

discard(value: _T) -> None
Source code in src/omnipy/shared/protocols/typing.py 
856
def discard(self, value: _T, /) -> None: raise AssumedToBeImplementedException

isdisjoint 

isdisjoint(other: Iterable[Any]) -> bool
Source code in src/omnipy/shared/protocols/typing.py 
847
def isdisjoint(self, other: Iterable[Any], /) -> bool: raise AssumedToBeImplementedException

pop 

pop() -> _T
Source code in src/omnipy/shared/protocols/typing.py 
859
def pop(self) -> _T: raise AssumedToBeImplementedException

remove 

remove(value: _T) -> None
Source code in src/omnipy/shared/protocols/typing.py 
860
def remove(self, value: _T, /) -> None: raise AssumedToBeImplementedException

IsTextIO

Bases: IsIO[str], Protocol

METHOD DESCRIPTION
close
fileno
flush
isatty
read
readable
readline
readlines
seek
seekable
tell
truncate
writable
write
writelines
ATTRIBUTE DESCRIPTION
buffer

TYPE: IsBinaryIO

closed

TYPE: bool

encoding

TYPE: str

errors

TYPE: str | None

line_buffering

TYPE: int

mode

TYPE: str

name

TYPE: str | Any

newlines

TYPE: Any

Source code in src/omnipy/shared/protocols/typing.py 
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
class IsTextIO(IsIO[str], Protocol):
    # See comment regarding the @properties in the `IO` class
    # __slots__ = ()
    @property
    # def buffer(self) -> BinaryIO: ...
    def buffer(self) -> IsBinaryIO: raise AssumedToBeImplementedException
    @property
    def encoding(self) -> str: raise AssumedToBeImplementedException
    @property
    def errors(self) -> str | None: raise AssumedToBeImplementedException
    @property
    def line_buffering(self) -> int: raise AssumedToBeImplementedException  # int on PyPy, bool on CPython
    @property
    def newlines(self) -> Any: raise AssumedToBeImplementedException  # None, str or tuple
    # @abstractmethod
    # def __enter__(self) -> TextIO: ...
    def __enter__(self) -> IsTextIO: raise AssumedToBeImplementedException

buffer property 

buffer: IsBinaryIO

closed property 

closed: bool

encoding property 

encoding: str

errors property 

errors: str | None

line_buffering property 

line_buffering: int

mode property 

mode: str

name property 

name: str | Any

newlines property 

newlines: Any

close 

close() -> None
Source code in src/omnipy/shared/protocols/typing.py 
1099
def close(self) -> None: raise AssumedToBeImplementedException

fileno 

fileno() -> int
Source code in src/omnipy/shared/protocols/typing.py 
1103
def fileno(self) -> int: raise AssumedToBeImplementedException

flush 

flush() -> None
Source code in src/omnipy/shared/protocols/typing.py 
1105
def flush(self) -> None: raise AssumedToBeImplementedException

isatty 

isatty() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1107
def isatty(self) -> bool: raise AssumedToBeImplementedException

read 

read(n: int = -1) -> AnyStr
Source code in src/omnipy/shared/protocols/typing.py 
1109
def read(self, n: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException

readable 

readable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1111
def readable(self) -> bool: raise AssumedToBeImplementedException

readline 

readline(limit: int = -1) -> AnyStr
Source code in src/omnipy/shared/protocols/typing.py 
1113
def readline(self, limit: int = -1, /) -> AnyStr: raise AssumedToBeImplementedException

readlines 

readlines(hint: int = -1) -> list[AnyStr]
Source code in src/omnipy/shared/protocols/typing.py 
1115
def readlines(self, hint: int = -1, /) -> list[AnyStr]: raise AssumedToBeImplementedException

seek 

seek(offset: int, whence: int = 0) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1117
def seek(self, offset: int, whence: int = 0, /) -> int: raise AssumedToBeImplementedException

seekable 

seekable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1119
def seekable(self) -> bool: raise AssumedToBeImplementedException

tell 

tell() -> int
Source code in src/omnipy/shared/protocols/typing.py 
1121
def tell(self) -> int: raise AssumedToBeImplementedException

truncate 

truncate(size: int | None = None) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1123
def truncate(self, size: int | None = None, /) -> int: raise AssumedToBeImplementedException

writable 

writable() -> bool
Source code in src/omnipy/shared/protocols/typing.py 
1125
def writable(self) -> bool: raise AssumedToBeImplementedException

write 

write(s: ReadableBuffer) -> int

write(s: AnyStr) -> int

write(s: AnyStr | ReadableBuffer) -> int
Source code in src/omnipy/shared/protocols/typing.py 
1134
def write(self, s: AnyStr | ReadableBuffer, /) -> int: raise AssumedToBeImplementedException

writelines 

writelines(lines: Iterable[ReadableBuffer]) -> None

writelines(lines: Iterable[AnyStr]) -> None

writelines(lines: Iterable[AnyStr] | Iterable[ReadableBuffer]) -> None
Source code in src/omnipy/shared/protocols/typing.py 
1143
1144
1145
1146
1147
def writelines(
    self,
    lines: Iterable[AnyStr] | Iterable[ReadableBuffer],
    /,
) -> None: raise AssumedToBeImplementedException

IsValuesView

Bases: IsMappingView, Collection[_VT_co], Protocol[_VT_co]

Protocol with the same interface as the abstract class typing.ValuesView.

Source code in src/omnipy/shared/protocols/typing.py 
914
915
916
917
918
919
class IsValuesView(IsMappingView, Collection[_VT_co], Protocol[_VT_co]):
    """Protocol with the same interface as the abstract class `typing.ValuesView`.
    """
    # def __init__(self, mapping: SupportsGetItemViewable[Any, _VT_co]) -> None: ...  # undocumented
    def __contains__(self, value: object, /) -> bool: raise AssumedToBeImplementedException
    def __iter__(self) -> Iterator[_VT_co]: raise AssumedToBeImplementedException