Skip to content

omnipy.shared.protocols.content

CLASS DESCRIPTION
IsBoolContent
IsBytesContent
IsDictContent
IsDictOfConcatenableItemSequenceLike
IsDictOfDictsContent
IsDictOfListsContent
IsFloatContent
IsIntContent
IsListContent
IsListOfDictsContent
IsListOfListsContent
IsPairTupleContent

Protocol for paired-type tuples as Model content, e.g. Model[tuple[int, str]]
IsSameTypeTupleContent

Protocol for single-type tuples as Model content, e.g. Model[tuple[int, ...]]
IsSetContent
IsStrContent

IsBoolContent

Bases: IsBool, Protocol

METHOD DESCRIPTION
as_integer_ratio
bit_count
bit_length
conjugate
from_bytes
is_integer
to_bytes
ATTRIBUTE DESCRIPTION
denominator

TYPE: Literal[1]

imag

TYPE: Literal[0]

numerator

TYPE: int

real

TYPE: int

Source code in src/omnipy/shared/protocols/content.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
class IsBoolContent(IsBool, Protocol):
    @overload  # type: ignore [override]
    def __and__(self, value: IsBool, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __and__(self, value: int, /) -> int:  # type: ignore [overload-overlap]
        raise AssumedToBeImplementedException

    @overload
    def __and__(self, value: ConvertibleToInt, /) -> Self:
        raise AssumedToBeImplementedException

    def __and__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: ConvertibleToInt | IsBool,
        /,
    ) -> int | Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __or__(self, value: IsBool, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __or__(self, value: int, /) -> int:  # type: ignore [overload-overlap]
        raise AssumedToBeImplementedException

    @overload
    def __or__(self, value: ConvertibleToInt, /) -> Self:
        raise AssumedToBeImplementedException

    def __or__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: ConvertibleToInt | IsBool,
        /,
    ) -> int | Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __xor__(self, value: IsBool, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __xor__(self, value: int, /) -> int:  # type: ignore [overload-overlap]
        raise AssumedToBeImplementedException

    @overload
    def __xor__(self, value: ConvertibleToInt, /) -> Self:
        raise AssumedToBeImplementedException

    def __xor__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: ConvertibleToInt | IsBool,
        /,
    ) -> int | Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __rand__(self, value: IsBool, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __rand__(self, value: int, /) -> int:  # type: ignore [overload-overlap]
        raise AssumedToBeImplementedException

    @overload
    def __rand__(self, value: ConvertibleToInt, /) -> Self:
        raise AssumedToBeImplementedException

    def __rand__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: ConvertibleToInt | IsBool,
        /,
    ) -> int | Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __ror__(self, value: IsBool, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __ror__(self, value: int, /) -> int:  # type: ignore [overload-overlap]
        raise AssumedToBeImplementedException

    @overload
    def __ror__(self, value: ConvertibleToInt, /) -> Self:
        raise AssumedToBeImplementedException

    def __ror__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: ConvertibleToInt | IsBool,
        /,
    ) -> int | Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __rxor__(self, value: IsBool, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __rxor__(self, value: int, /) -> int:  # type: ignore [overload-overlap]
        raise AssumedToBeImplementedException

    @overload
    def __rxor__(self, value: ConvertibleToInt, /) -> Self:
        raise AssumedToBeImplementedException

    def __rxor__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: ConvertibleToInt | IsBool,
        /,
    ) -> int | Self:
        raise AssumedToBeImplementedException

denominator property 

denominator: Literal[1]

imag property 

imag: Literal[0]

numerator property 

numerator: int

real property 

real: int

as_integer_ratio 

as_integer_ratio() -> tuple[int, Literal[1]]
Source code in src/omnipy/shared/protocols/builtins.py 
283
def as_integer_ratio(self) -> tuple[int, Literal[1]]: raise AssumedToBeImplementedException

bit_count 

bit_count() -> int
Source code in src/omnipy/shared/protocols/builtins.py 
294
def bit_count(self) -> int: raise AssumedToBeImplementedException

bit_length 

bit_length() -> int
Source code in src/omnipy/shared/protocols/builtins.py 
293
def bit_length(self) -> int: raise AssumedToBeImplementedException

conjugate 

conjugate() -> int
Source code in src/omnipy/shared/protocols/builtins.py 
292
def conjugate(self) -> int: raise AssumedToBeImplementedException

from_bytes classmethod 

from_bytes(
    bytes: Iterable[SupportsIndex] | SupportsBytes | ReadableBuffer,
    byteorder: Literal["little", "big"],
    *,
    signed: bool = False,
) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
310
311
312
313
314
315
316
317
@classmethod
def from_bytes(
    cls,
    bytes: Iterable[SupportsIndex] | SupportsBytes | ReadableBuffer,
    byteorder: Literal["little", "big"],
    *, 
    signed: bool = False,
) -> Self: raise AssumedToBeImplementedException

is_integer 

is_integer() -> Literal[True]
Source code in src/omnipy/shared/protocols/builtins.py 
320
def is_integer(self) -> Literal[True]: raise AssumedToBeImplementedException

to_bytes 

to_bytes(
    length: SupportsIndex, byteorder: Literal["little", "big"], *, signed: bool = False
) -> bytes
Source code in src/omnipy/shared/protocols/builtins.py 
309
def to_bytes(self, length: SupportsIndex, byteorder: Literal["little", "big"], *, signed: bool = False) -> bytes: raise AssumedToBeImplementedException

IsBytesContent

Bases: IsBytes, Protocol

METHOD DESCRIPTION
capitalize
center
count
decode
endswith
expandtabs
find
fromhex
hex
index
isalnum
isalpha
isascii
isdigit
islower
isspace
istitle
isupper
join
ljust
lower
lstrip
maketrans
partition
removeprefix
removesuffix
replace
rfind
rindex
rjust
rpartition
rsplit
rstrip
split
splitlines
startswith
strip
swapcase
title
translate
upper
zfill
Source code in src/omnipy/shared/protocols/content.py 
327
328
329
class IsBytesContent(IsBytes, Protocol):
    def __add__(self, value: IsBytes, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

capitalize 

capitalize() -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
853
def capitalize(self) -> Self: raise AssumedToBeImplementedException

center 

center(width: SupportsIndex, fillchar: bytes = b' ') -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
855
def center(self, width: SupportsIndex, fillchar: bytes = b' ', /) -> Self: raise AssumedToBeImplementedException

count 

count(
    sub: ReadableBuffer | SupportsIndex,
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
856
857
858
def count(
    self, sub: ReadableBuffer | SupportsIndex, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /
) -> int: raise AssumedToBeImplementedException

decode 

decode(encoding: str = 'utf-8', errors: str = 'strict') -> str
Source code in src/omnipy/shared/protocols/builtins.py 
859
def decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str: raise AssumedToBeImplementedException

endswith 

endswith(
    suffix: ReadableBuffer | tuple[ReadableBuffer, ...],
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
860
861
862
863
864
865
866
def endswith(
    self,
    suffix: ReadableBuffer | tuple[ReadableBuffer, ...],
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
    /,
    ) -> bool: raise AssumedToBeImplementedException

expandtabs 

expandtabs(tabsize: SupportsIndex = 8) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
868
def expandtabs(self, tabsize: SupportsIndex = 8) -> Self: raise AssumedToBeImplementedException

find 

find(
    sub: ReadableBuffer | SupportsIndex,
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
869
870
871
def find(
    self, sub: ReadableBuffer | SupportsIndex, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /
) -> int: raise AssumedToBeImplementedException

fromhex classmethod 

fromhex(string: str) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
949
950
@classmethod
def fromhex(cls, string: str, /) -> Self: raise AssumedToBeImplementedException

hex 

hex(sep: str | bytes = '', bytes_per_sep: SupportsIndex = 1) -> str
Source code in src/omnipy/shared/protocols/builtins.py 
873
def hex(self, sep: str | bytes = '', bytes_per_sep: SupportsIndex = 1) -> str: raise AssumedToBeImplementedException

index 

index(
    sub: ReadableBuffer | SupportsIndex,
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
874
875
876
def index(
    self, sub: ReadableBuffer | SupportsIndex, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /
) -> int: raise AssumedToBeImplementedException

isalnum 

isalnum() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
877
def isalnum(self) -> bool: raise AssumedToBeImplementedException

isalpha 

isalpha() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
878
def isalpha(self) -> bool: raise AssumedToBeImplementedException

isascii 

isascii() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
879
def isascii(self) -> bool: raise AssumedToBeImplementedException

isdigit 

isdigit() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
880
def isdigit(self) -> bool: raise AssumedToBeImplementedException

islower 

islower() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
881
def islower(self) -> bool: raise AssumedToBeImplementedException

isspace 

isspace() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
882
def isspace(self) -> bool: raise AssumedToBeImplementedException

istitle 

istitle() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
883
def istitle(self) -> bool: raise AssumedToBeImplementedException

isupper 

isupper() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
884
def isupper(self) -> bool: raise AssumedToBeImplementedException

join 

join(iterable_of_bytes: Iterable[ReadableBuffer]) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
886
def join(self, iterable_of_bytes: Iterable[ReadableBuffer], /) -> Self: raise AssumedToBeImplementedException

ljust 

ljust(width: SupportsIndex, fillchar: bytes | bytearray = b' ') -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
888
def ljust(self, width: SupportsIndex, fillchar: bytes | bytearray = b" ", /) -> Self: raise AssumedToBeImplementedException

lower 

lower() -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
890
def lower(self) -> Self: raise AssumedToBeImplementedException

lstrip 

lstrip(bytes: ReadableBuffer | None = None) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
892
def lstrip(self, bytes: ReadableBuffer | None = None, /) -> Self: raise AssumedToBeImplementedException

maketrans staticmethod 

maketrans(frm: ReadableBuffer, to: ReadableBuffer) -> bytes
Source code in src/omnipy/shared/protocols/builtins.py 
952
953
@staticmethod
def maketrans(frm: ReadableBuffer, to: ReadableBuffer, /) -> bytes: raise AssumedToBeImplementedException

partition 

partition(sep: ReadableBuffer) -> tuple[Self, Self, Self]
Source code in src/omnipy/shared/protocols/builtins.py 
894
def partition(self, sep: ReadableBuffer, /) -> tuple[Self, Self, Self]: raise AssumedToBeImplementedException

removeprefix 

removeprefix(prefix: ReadableBuffer) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
903
def removeprefix(self, prefix: ReadableBuffer, /) -> Self: raise AssumedToBeImplementedException

removesuffix 

removesuffix(suffix: ReadableBuffer) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
905
def removesuffix(self, suffix: ReadableBuffer, /) -> Self: raise AssumedToBeImplementedException

replace 

replace(old: ReadableBuffer, new: ReadableBuffer, count: SupportsIndex = -1) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
900
def replace(self, old: ReadableBuffer, new: ReadableBuffer, count: SupportsIndex = -1, /) -> Self: raise AssumedToBeImplementedException

rfind 

rfind(
    sub: ReadableBuffer | SupportsIndex,
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
906
907
908
def rfind(
    self, sub: ReadableBuffer | SupportsIndex, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /
) -> int: raise AssumedToBeImplementedException

rindex 

rindex(
    sub: ReadableBuffer | SupportsIndex,
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
909
910
911
def rindex(
    self, sub: ReadableBuffer | SupportsIndex, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /
) -> int: raise AssumedToBeImplementedException

rjust 

rjust(width: SupportsIndex, fillchar: bytes | bytearray = b' ') -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
913
def rjust(self, width: SupportsIndex, fillchar: bytes | bytearray = b' ', /) -> Self: raise AssumedToBeImplementedException

rpartition 

rpartition(sep: ReadableBuffer) -> tuple[Self, Self, Self]
Source code in src/omnipy/shared/protocols/builtins.py 
915
def rpartition(self, sep: ReadableBuffer, /) -> tuple[Self, Self, Self]: raise AssumedToBeImplementedException

rsplit 

rsplit(sep: ReadableBuffer | None = None, maxsplit: SupportsIndex = -1) -> list[Self]
Source code in src/omnipy/shared/protocols/builtins.py 
917
def rsplit(self, sep: ReadableBuffer | None = None, maxsplit: SupportsIndex = -1) -> list[Self]: raise AssumedToBeImplementedException

rstrip 

rstrip(bytes: ReadableBuffer | None = None) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
919
def rstrip(self, bytes: ReadableBuffer | None = None, /) -> Self: raise AssumedToBeImplementedException

split 

split(sep: ReadableBuffer | None = None, maxsplit: SupportsIndex = -1) -> list[Self]
Source code in src/omnipy/shared/protocols/builtins.py 
921
def split(self, sep: ReadableBuffer | None = None, maxsplit: SupportsIndex = -1) -> list[Self]: raise AssumedToBeImplementedException

splitlines 

splitlines(keepends: bool = False) -> list[Self]
Source code in src/omnipy/shared/protocols/builtins.py 
923
def splitlines(self, keepends: bool = False) -> list[Self]: raise AssumedToBeImplementedException

startswith 

startswith(
    prefix: ReadableBuffer | tuple[ReadableBuffer, ...],
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
924
925
926
927
928
929
930
931
def startswith(
    self,
    prefix: ReadableBuffer | tuple[ReadableBuffer, ...],
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
    /,
) -> bool:
    raise AssumedToBeImplementedException

strip 

strip(bytes: ReadableBuffer | None = None) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
933
def strip(self, bytes: ReadableBuffer | None = None, /) -> Self: raise AssumedToBeImplementedException

swapcase 

swapcase() -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
935
def swapcase(self) -> Self: raise AssumedToBeImplementedException

title 

title() -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
937
def title(self) -> Self: raise AssumedToBeImplementedException

translate 

translate(table: ReadableBuffer | None, /, delete: ReadableBuffer = b'') -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
939
def translate(self, table: ReadableBuffer | None, /, delete: ReadableBuffer = b'') -> Self: raise AssumedToBeImplementedException

upper 

upper() -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
941
def upper(self) -> Self: raise AssumedToBeImplementedException

zfill 

zfill(width: SupportsIndex) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
943
def zfill(self, width: SupportsIndex, /) -> Self: raise AssumedToBeImplementedException

IsDictContent

Bases: IsDict[_KeyT, _ValT], Protocol[_KeyT, _ValT]

METHOD DESCRIPTION
clear

D.clear() -> None. Remove all items from D.
fromkeys
get
items
keys
pop
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
Source code in src/omnipy/shared/protocols/content.py 
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
class IsDictContent(IsDict[_KeyT, _ValT], Protocol[_KeyT, _ValT]):
    @override
    @classmethod
    def fromkeys(  # type: ignore [override]
        cls,
        iterable: Iterable[_KeyT],
        value: _ValT | None = None,
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __or__(self, value: SupportsKeysAndGetItem[_KeyT, _ValT], /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __or__(self, value: Iterable[tuple[_KeyT, _ValT]], /) -> Self:
        raise AssumedToBeImplementedException

    @override
    def __or__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: SupportsKeysAndGetItem[_KeyT, _ValT] | Iterable[tuple[_KeyT, _ValT]],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __ror__(self, value: SupportsKeysAndGetItem[_KeyT, _ValT], /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __ror__(self, value: Iterable[tuple[_KeyT, _ValT]], /) -> Self:
        raise AssumedToBeImplementedException

    @override
    def __ror__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: SupportsKeysAndGetItem[_KeyT, _ValT] | Iterable[tuple[_KeyT, _ValT]],
        /,
    ) -> Self:
        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

fromkeys classmethod 

fromkeys(iterable: Iterable[_KeyT], value: _ValT | None = None) -> Self
Source code in src/omnipy/shared/protocols/content.py 
619
620
621
622
623
624
625
626
627
@override
@classmethod
def fromkeys(  # type: ignore [override]
    cls,
    iterable: Iterable[_KeyT],
    value: _ValT | None = None,
    /,
) -> Self:
    raise AssumedToBeImplementedException

get 

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

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

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

get(key: _KT, default: None | _VT | _T = None) -> _VT | _T | None
Source code in src/omnipy/shared/protocols/builtins.py 
1531
def get(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: raise AssumedToBeImplementedException

items 

items() -> IsDictItems[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1508
def items(self) -> IsDictItems[_KT, _VT]: raise AssumedToBeImplementedException

keys 

keys() -> IsDictKeys[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1504
def keys(self) -> IsDictKeys[_KT, _VT]: 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
Source code in src/omnipy/shared/protocols/builtins.py 
1539
def pop(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: 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() -> IsDictValues[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1506
def values(self) -> IsDictValues[_KT, _VT]: raise AssumedToBeImplementedException

IsDictOfConcatenableItemSequenceLike

Bases: IsDictContent[str, _ConcatColumnModelT | IsItemSequenceLike[_ValT] | Generator[_ValT, None, None]], Protocol[_ConcatColumnModelT, _ValT]

METHOD DESCRIPTION
clear

D.clear() -> None. Remove all items from D.
fromkeys
get
items
keys
pop
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
Source code in src/omnipy/shared/protocols/content.py 
681
682
683
684
685
686
687
688
689
class IsDictOfConcatenableItemSequenceLike(
        IsDictContent[str,
                      _ConcatColumnModelT | IsItemSequenceLike[_ValT]
                      | Generator[_ValT, None, None]],
        Protocol[_ConcatColumnModelT, _ValT],
):
    @override
    def __getitem__(self, key: str, /) -> _ConcatColumnModelT:
        ...

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

fromkeys classmethod 

fromkeys(iterable: Iterable[_KeyT], value: _ValT | None = None) -> Self
Source code in src/omnipy/shared/protocols/content.py 
619
620
621
622
623
624
625
626
627
@override
@classmethod
def fromkeys(  # type: ignore [override]
    cls,
    iterable: Iterable[_KeyT],
    value: _ValT | None = None,
    /,
) -> Self:
    raise AssumedToBeImplementedException

get 

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

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

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

get(key: _KT, default: None | _VT | _T = None) -> _VT | _T | None
Source code in src/omnipy/shared/protocols/builtins.py 
1531
def get(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: raise AssumedToBeImplementedException

items 

items() -> IsDictItems[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1508
def items(self) -> IsDictItems[_KT, _VT]: raise AssumedToBeImplementedException

keys 

keys() -> IsDictKeys[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1504
def keys(self) -> IsDictKeys[_KT, _VT]: 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
Source code in src/omnipy/shared/protocols/builtins.py 
1539
def pop(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: 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() -> IsDictValues[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1506
def values(self) -> IsDictValues[_KT, _VT]: raise AssumedToBeImplementedException

IsDictOfDictsContent

Bases: IsDictContent[_KeyT, _ValMappingT | SupportsKeysAndGetItem[_NestedKeyT, _NestedValT] | Iterable[tuple[_NestedKeyT, _NestedValT]]], Protocol[_KeyT, _ValMappingT, _NestedKeyT, _NestedValT]

METHOD DESCRIPTION
clear

D.clear() -> None. Remove all items from D.
fromkeys
get
items
keys
pop
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
Source code in src/omnipy/shared/protocols/content.py 
671
672
673
674
675
676
677
678
class IsDictOfDictsContent(IsDictContent[_KeyT,
                                         (_ValMappingT
                                          | SupportsKeysAndGetItem[_NestedKeyT, _NestedValT]
                                          | Iterable[tuple[_NestedKeyT, _NestedValT]])],
                           Protocol[_KeyT, _ValMappingT, _NestedKeyT, _NestedValT]):
    @override
    def __getitem__(self, key: _KeyT, /) -> _ValMappingT:
        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

fromkeys classmethod 

fromkeys(iterable: Iterable[_KeyT], value: _ValT | None = None) -> Self
Source code in src/omnipy/shared/protocols/content.py 
619
620
621
622
623
624
625
626
627
@override
@classmethod
def fromkeys(  # type: ignore [override]
    cls,
    iterable: Iterable[_KeyT],
    value: _ValT | None = None,
    /,
) -> Self:
    raise AssumedToBeImplementedException

get 

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

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

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

get(key: _KT, default: None | _VT | _T = None) -> _VT | _T | None
Source code in src/omnipy/shared/protocols/builtins.py 
1531
def get(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: raise AssumedToBeImplementedException

items 

items() -> IsDictItems[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1508
def items(self) -> IsDictItems[_KT, _VT]: raise AssumedToBeImplementedException

keys 

keys() -> IsDictKeys[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1504
def keys(self) -> IsDictKeys[_KT, _VT]: 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
Source code in src/omnipy/shared/protocols/builtins.py 
1539
def pop(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: 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() -> IsDictValues[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1506
def values(self) -> IsDictValues[_KT, _VT]: raise AssumedToBeImplementedException

IsDictOfListsContent

Bases: IsDictContent[_KeyT, _ValSeqOrGenT | IsItemSequenceLike[_NestedValT] | Generator[_NestedValT]], Protocol[_KeyT, _ValSeqOrGenT, _NestedValT]

METHOD DESCRIPTION
clear

D.clear() -> None. Remove all items from D.
fromkeys
get
items
keys
pop
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
Source code in src/omnipy/shared/protocols/content.py 
662
663
664
665
666
667
668
class IsDictOfListsContent(IsDictContent[_KeyT,
                                         _ValSeqOrGenT | IsItemSequenceLike[_NestedValT]
                                         | Generator[_NestedValT]],
                           Protocol[_KeyT, _ValSeqOrGenT, _NestedValT]):
    @override
    def __getitem__(self, key: _KeyT, /) -> _ValSeqOrGenT:
        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

fromkeys classmethod 

fromkeys(iterable: Iterable[_KeyT], value: _ValT | None = None) -> Self
Source code in src/omnipy/shared/protocols/content.py 
619
620
621
622
623
624
625
626
627
@override
@classmethod
def fromkeys(  # type: ignore [override]
    cls,
    iterable: Iterable[_KeyT],
    value: _ValT | None = None,
    /,
) -> Self:
    raise AssumedToBeImplementedException

get 

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

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

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

get(key: _KT, default: None | _VT | _T = None) -> _VT | _T | None
Source code in src/omnipy/shared/protocols/builtins.py 
1531
def get(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: raise AssumedToBeImplementedException

items 

items() -> IsDictItems[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1508
def items(self) -> IsDictItems[_KT, _VT]: raise AssumedToBeImplementedException

keys 

keys() -> IsDictKeys[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1504
def keys(self) -> IsDictKeys[_KT, _VT]: 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
Source code in src/omnipy/shared/protocols/builtins.py 
1539
def pop(self, key: _KT, default: None | _VT | _T = None, /) -> _VT | _T | None: 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() -> IsDictValues[_KT, _VT]
Source code in src/omnipy/shared/protocols/builtins.py 
1506
def values(self) -> IsDictValues[_KT, _VT]: raise AssumedToBeImplementedException

IsFloatContent

Bases: IsFloat, Protocol

METHOD DESCRIPTION
as_integer_ratio
conjugate
from_number
fromhex
hex
is_integer
ATTRIBUTE DESCRIPTION
imag

TYPE: float

real

TYPE: float

Source code in src/omnipy/shared/protocols/content.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
class IsFloatContent(IsFloat, Protocol):
    def __add__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __sub__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __mul__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __floordiv__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __truediv__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __mod__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __divmod__(self, value: ConvertibleToFloat, /) -> tuple[float, float]:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __pow__(self, value: ConvertibleToFloat, mod: None = None, /) -> Any:
        raise AssumedToBeImplementedException

    @overload
    def __pow__(self, value: ConvertibleToInt, mod: None = None, /) -> Self:
        raise AssumedToBeImplementedException

    # positive __value -> float; negative __value -> complex
    # return type must be Any as `float | complex` causes too many false-positive errors

    def __pow__(self, value: ConvertibleToFloat | ConvertibleToInt, mod: None = None, /) -> Any:
        raise AssumedToBeImplementedException

    def __radd__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rsub__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rmul__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rfloordiv__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rtruediv__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rmod__(self, value: ConvertibleToFloat, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rdivmod__(self, value: ConvertibleToFloat, /) -> tuple[float, float]:
        raise AssumedToBeImplementedException

    def __rpow__(self, value: ConvertibleToInt | ConvertibleToFloat, mod: None = None, /) -> Any:
        raise AssumedToBeImplementedException

imag property 

imag: float

real property 

real: float

as_integer_ratio 

as_integer_ratio() -> tuple[int, int]
Source code in src/omnipy/shared/protocols/builtins.py 
397
def as_integer_ratio(self) -> tuple[int, int]: raise AssumedToBeImplementedException

conjugate 

conjugate() -> float
Source code in src/omnipy/shared/protocols/builtins.py 
406
def conjugate(self) -> float: raise AssumedToBeImplementedException

from_number classmethod 

from_number(number: float | SupportsIndex | SupportsFloat) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
466
467
@classmethod
def from_number(cls, number: float | SupportsIndex | SupportsFloat, /) -> Self: raise AssumedToBeImplementedException

fromhex classmethod 

fromhex(string: str) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
400
401
@classmethod
def fromhex(cls, string: str, /) -> Self: raise AssumedToBeImplementedException

hex 

hex() -> str
Source code in src/omnipy/shared/protocols/builtins.py 
398
def hex(self) -> str: raise AssumedToBeImplementedException

is_integer 

is_integer() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
399
def is_integer(self) -> bool: raise AssumedToBeImplementedException

IsIntContent

Bases: IsInt, Protocol

METHOD DESCRIPTION
as_integer_ratio
bit_count
bit_length
conjugate
from_bytes
is_integer
to_bytes
ATTRIBUTE DESCRIPTION
denominator

TYPE: Literal[1]

imag

TYPE: Literal[0]

numerator

TYPE: int

real

TYPE: int

Source code in src/omnipy/shared/protocols/content.py 
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
class IsIntContent(IsInt, Protocol):
    def __add__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __sub__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __mul__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __floordiv__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __truediv__(self, value: ConvertibleToInt, /) -> float:
        raise AssumedToBeImplementedException

    def __mod__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __divmod__(self, value: ConvertibleToInt, /) -> tuple[int, int]:
        raise AssumedToBeImplementedException

    def __radd__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rsub__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rmul__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rfloordiv__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rtruediv__(self, value: ConvertibleToInt, /) -> float:
        raise AssumedToBeImplementedException

    def __rmod__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rdivmod__(self, value: ConvertibleToInt, /) -> tuple[int, int]:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __pow__(self, x: Literal[0], /) -> Literal[1]:
        raise AssumedToBeImplementedException

    @overload
    def __pow__(self, value: Literal[0], mod: None, /) -> Literal[1]:
        raise AssumedToBeImplementedException

    @overload
    def __pow__(self, value: _PositiveInteger, mod: None = None, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __pow__(self, value: _NegativeInteger, mod: None = None, /) -> float:
        raise AssumedToBeImplementedException

    # positive __value -> int; negative __value -> float
    # return type must be Any as `int | float` causes too many false-positive errors
    @overload
    def __pow__(self, value: ConvertibleToInt, mod: None = None, /) -> Any:
        raise AssumedToBeImplementedException

    @overload
    def __pow__(self, value: ConvertibleToInt, mod: ConvertibleToInt, /) -> Self:
        raise AssumedToBeImplementedException

    def __pow__(  # pyright: ignore[reportIncompatibleMethodOverride]
            self,
            value: ConvertibleToInt,
            mod: ConvertibleToInt | None = None,
            /) -> Self | float:
        raise AssumedToBeImplementedException

    def __rpow__(self, value: ConvertibleToInt, mod: ConvertibleToInt | None = None, /) -> Any:
        raise AssumedToBeImplementedException

    def __and__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __or__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __xor__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __lshift__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rshift__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rand__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __ror__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rxor__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rlshift__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    def __rrshift__(self, value: ConvertibleToInt, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

denominator property 

denominator: Literal[1]

imag property 

imag: Literal[0]

numerator property 

numerator: int

real property 

real: int

as_integer_ratio 

as_integer_ratio() -> tuple[int, Literal[1]]
Source code in src/omnipy/shared/protocols/builtins.py 
283
def as_integer_ratio(self) -> tuple[int, Literal[1]]: raise AssumedToBeImplementedException

bit_count 

bit_count() -> int
Source code in src/omnipy/shared/protocols/builtins.py 
294
def bit_count(self) -> int: raise AssumedToBeImplementedException

bit_length 

bit_length() -> int
Source code in src/omnipy/shared/protocols/builtins.py 
293
def bit_length(self) -> int: raise AssumedToBeImplementedException

conjugate 

conjugate() -> int
Source code in src/omnipy/shared/protocols/builtins.py 
292
def conjugate(self) -> int: raise AssumedToBeImplementedException

from_bytes classmethod 

from_bytes(
    bytes: Iterable[SupportsIndex] | SupportsBytes | ReadableBuffer,
    byteorder: Literal["little", "big"],
    *,
    signed: bool = False,
) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
310
311
312
313
314
315
316
317
@classmethod
def from_bytes(
    cls,
    bytes: Iterable[SupportsIndex] | SupportsBytes | ReadableBuffer,
    byteorder: Literal["little", "big"],
    *, 
    signed: bool = False,
) -> Self: raise AssumedToBeImplementedException

is_integer 

is_integer() -> Literal[True]
Source code in src/omnipy/shared/protocols/builtins.py 
320
def is_integer(self) -> Literal[True]: raise AssumedToBeImplementedException

to_bytes 

to_bytes(
    length: SupportsIndex, byteorder: Literal["little", "big"], *, signed: bool = False
) -> bytes
Source code in src/omnipy/shared/protocols/builtins.py 
309
def to_bytes(self, length: SupportsIndex, byteorder: Literal["little", "big"], *, signed: bool = False) -> bytes: raise AssumedToBeImplementedException

IsListContent

Bases: IsList[_ValT], Protocol[_ValT]

METHOD DESCRIPTION
append
clear

S.clear() -> None -- remove all items from S
count
extend
index
insert
pop
remove
reverse

S.reverse() -- reverse IN PLACE
sort
Source code in src/omnipy/shared/protocols/content.py 
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
class IsListContent(IsList[_ValT], Protocol[_ValT]):
    @override
    def __add__(  # type: ignore [override]
        self,
        values: IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __getitem__(self, i: SupportsIndex, /) -> _ValT:
        raise AssumedToBeImplementedException

    @overload
    def __getitem__(self, s: slice, /) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __getitem__(self, s: slice | SupportsIndex, /) -> Self | _ValT:
        raise AssumedToBeImplementedException

    @override
    def __getitem__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        index: SupportsIndex | slice,
        /,
    ) -> Self | _ValT:
        raise AssumedToBeImplementedException

    @override
    def __mul__(self, value: SupportsIndex, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    @override
    def __rmul__(self, value: SupportsIndex, /) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

append 

append(object: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1405
def append(self, object: _T, /) -> None: 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: _T) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1411
def count(self, value: _T, /) -> int: raise AssumedToBeImplementedException

extend 

extend(iterable: Iterable[_T]) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1406
def extend(self, iterable: Iterable[_T], /) -> None: raise AssumedToBeImplementedException

index 

index(value: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1410
def index(self, value: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: raise AssumedToBeImplementedException

insert 

insert(index: SupportsIndex, object: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1412
def insert(self, index: SupportsIndex, object: _T, /) -> None: raise AssumedToBeImplementedException

pop 

pop(index: SupportsIndex = -1) -> _T
Source code in src/omnipy/shared/protocols/builtins.py 
1407
def pop(self, index: SupportsIndex = -1, /) -> _T: raise AssumedToBeImplementedException

remove 

remove(value: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1413
def remove(self, value: _T, /) -> None: 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

sort 

sort(*, key: None = None, reverse: bool = False) -> None

sort(*, key: Callable[[_T], SupportsRichComparison], reverse: bool = False) -> None

sort(*, key: Callable[[_T], SupportsRichComparison] | None = None, reverse: bool = False) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1424
def sort(self: IsList[_T] | IsList[SupportsRichComparisonT], *, key: Callable[[_T], SupportsRichComparison] | None = None, reverse: bool = False) -> None: raise AssumedToBeImplementedException

IsListOfDictsContent

Bases: IsListContent[_ValMappingT | SupportsKeysAndGetItem[_NestedKeyT, _NestedValT] | Iterable[tuple[_NestedKeyT, _NestedValT]]], Protocol[_ValMappingT, _NestedKeyT, _NestedValT]

METHOD DESCRIPTION
append
clear

S.clear() -> None -- remove all items from S
count
extend
index
insert
pop
remove
reverse

S.reverse() -- reverse IN PLACE
sort
Source code in src/omnipy/shared/protocols/content.py 
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
class IsListOfDictsContent(IsListContent[(_ValMappingT
                                          | SupportsKeysAndGetItem[_NestedKeyT, _NestedValT]
                                          | Iterable[tuple[_NestedKeyT, _NestedValT]])],
                           Protocol[_ValMappingT, _NestedKeyT, _NestedValT]):
    @overload  # type: ignore [override]
    def __getitem__(self, index: SupportsIndex, /) -> _ValMappingT:
        raise AssumedToBeImplementedException

    @overload
    def __getitem__(self, index: slice, /) -> IsListContent[_ValMappingT]:
        raise AssumedToBeImplementedException

    @override
    def __getitem__(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        index: SupportsIndex | slice,
        /,
    ) -> _ValMappingT | IsListContent[_ValMappingT]:
        raise AssumedToBeImplementedException

    @override
    def __mul__(  # type: ignore [override]
            self, value: SupportsIndex, /) -> IsListContent[_ValMappingT]:
        raise AssumedToBeImplementedException

    @override
    def __rmul__(  # type: ignore [override]
            self, value: SupportsIndex, /) -> IsListContent[_ValMappingT]:
        raise AssumedToBeImplementedException

append 

append(object: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1405
def append(self, object: _T, /) -> None: 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: _T) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1411
def count(self, value: _T, /) -> int: raise AssumedToBeImplementedException

extend 

extend(iterable: Iterable[_T]) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1406
def extend(self, iterable: Iterable[_T], /) -> None: raise AssumedToBeImplementedException

index 

index(value: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1410
def index(self, value: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: raise AssumedToBeImplementedException

insert 

insert(index: SupportsIndex, object: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1412
def insert(self, index: SupportsIndex, object: _T, /) -> None: raise AssumedToBeImplementedException

pop 

pop(index: SupportsIndex = -1) -> _T
Source code in src/omnipy/shared/protocols/builtins.py 
1407
def pop(self, index: SupportsIndex = -1, /) -> _T: raise AssumedToBeImplementedException

remove 

remove(value: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1413
def remove(self, value: _T, /) -> None: 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

sort 

sort(*, key: None = None, reverse: bool = False) -> None

sort(*, key: Callable[[_T], SupportsRichComparison], reverse: bool = False) -> None

sort(*, key: Callable[[_T], SupportsRichComparison] | None = None, reverse: bool = False) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1424
def sort(self: IsList[_T] | IsList[SupportsRichComparisonT], *, key: Callable[[_T], SupportsRichComparison] | None = None, reverse: bool = False) -> None: raise AssumedToBeImplementedException

IsListOfListsContent

Bases: IsListContent[_ValSeqOrGenT | IsItemSequence[_NestedValT] | Generator[_NestedValT]], Protocol[_ValSeqOrGenT, _NestedValT]

METHOD DESCRIPTION
append
clear

S.clear() -> None -- remove all items from S
count
extend
index
insert
pop
remove
reverse

S.reverse() -- reverse IN PLACE
sort
Source code in src/omnipy/shared/protocols/content.py 
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
class IsListOfListsContent(IsListContent[_ValSeqOrGenT | IsItemSequence[_NestedValT]
                                         | Generator[_NestedValT]],
                           Protocol[_ValSeqOrGenT, _NestedValT]):
    @overload  # type: ignore [override]
    def __getitem__(self, index: SupportsIndex, /) -> _ValSeqOrGenT:
        raise AssumedToBeImplementedException

    @overload
    def __getitem__(
        self,
        index: slice,
        /,
    ) -> IsListContent[_ValSeqOrGenT]:
        raise AssumedToBeImplementedException

    @override
    def __getitem__(  # pyright: ignore[reportIncompatibleMethodOverride]
            self, index: SupportsIndex | slice, /) -> _ValSeqOrGenT | IsListContent[_ValSeqOrGenT]:
        raise AssumedToBeImplementedException

    @override
    def __mul__(  # type: ignore [override]
            self, value: SupportsIndex, /) -> IsListContent[_ValSeqOrGenT]:
        raise AssumedToBeImplementedException

    @override
    def __rmul__(  # type: ignore [override]
            self, value: SupportsIndex, /) -> IsListContent[_ValSeqOrGenT]:
        raise AssumedToBeImplementedException

append 

append(object: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1405
def append(self, object: _T, /) -> None: 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: _T) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1411
def count(self, value: _T, /) -> int: raise AssumedToBeImplementedException

extend 

extend(iterable: Iterable[_T]) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1406
def extend(self, iterable: Iterable[_T], /) -> None: raise AssumedToBeImplementedException

index 

index(value: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1410
def index(self, value: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: raise AssumedToBeImplementedException

insert 

insert(index: SupportsIndex, object: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1412
def insert(self, index: SupportsIndex, object: _T, /) -> None: raise AssumedToBeImplementedException

pop 

pop(index: SupportsIndex = -1) -> _T
Source code in src/omnipy/shared/protocols/builtins.py 
1407
def pop(self, index: SupportsIndex = -1, /) -> _T: raise AssumedToBeImplementedException

remove 

remove(value: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1413
def remove(self, value: _T, /) -> None: 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

sort 

sort(*, key: None = None, reverse: bool = False) -> None

sort(*, key: Callable[[_T], SupportsRichComparison], reverse: bool = False) -> None

sort(*, key: Callable[[_T], SupportsRichComparison] | None = None, reverse: bool = False) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1424
def sort(self: IsList[_T] | IsList[SupportsRichComparisonT], *, key: Callable[[_T], SupportsRichComparison] | None = None, reverse: bool = False) -> None: raise AssumedToBeImplementedException

IsPairTupleContent

Bases: IsHashable, IsTuple[_ValT | _SecondValT], Protocol[_ValT, _SecondValT]

Protocol for paired-type tuples as Model content, e.g. Model[tuple[int, str]]

IsPairTupleContent is a protocol with the same interface as the builtin class tuple, with exactly two elements (e.g. tuple[int, str]). As it is meant to annotate Omnipy Models for static typing, it does not support + and * operators (other than for empty tuples and multiplying by 1), as these operations would cause validation to fail.

METHOD DESCRIPTION
count
index
Source code in src/omnipy/shared/protocols/content.py 
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
class IsPairTupleContent(IsHashable, IsTuple[_ValT | _SecondValT], Protocol[_ValT, _SecondValT]):
    """Protocol for paired-type tuples as Model content, e.g. `Model[tuple[int, str]]`

    IsPairTupleContent is a protocol with the same interface as the builtin class
    tuple, with exactly two elements (e.g. tuple[int, str]). As it is meant
    to annotate Omnipy Models for static typing, it does not support `+`
    and `*` operators (other than for empty tuples and multiplying by 1),
    as these operations would cause validation to fail.
    """
    @override
    def __add__(  # type: ignore [override]
            self, value: tuple[()], /) -> Self:
        raise AssumedToBeImplementedException

    @override
    def __mul__(  # type: ignore [override]
            self, value: Literal[1], /) -> Self:
        raise AssumedToBeImplementedException

    @override
    def __rmul__(  # type: ignore [override]
            self, value: Literal[1], /) -> Self:
        raise AssumedToBeImplementedException

count 

count(value: Any) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1339
def count(self, value: Any, /) -> int: raise AssumedToBeImplementedException

index 

index(value: Any, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1340
def index(self, value: Any, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: raise AssumedToBeImplementedException

IsSameTypeTupleContent

Bases: IsHashable, IsTuple[_ValT], Protocol[_ValT]

Protocol for single-type tuples as Model content, e.g. Model[tuple[int, ...]]

IsSameTypeTupleContent has the same interface as the builtin class tuple, but where all elements of the same type (e.g. tuple[int, ...]). As it is meant to annotate Omnipy Models for static typing, it supports broader interoperability with other iterables of the same element type.

METHOD DESCRIPTION
count
index
Source code in src/omnipy/shared/protocols/content.py 
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
class IsSameTypeTupleContent(IsHashable, IsTuple[_ValT], Protocol[_ValT]):
    """Protocol for single-type tuples as Model content, e.g. `Model[tuple[int, ...]]`

    IsSameTypeTupleContent has the same interface as the builtin class
    `tuple`, but where all elements of the same type (e.g. `tuple[int,
    ...]`). As it is meant to annotate Omnipy Models for static typing, it
    supports broader interoperability with other iterables of the same
    element type.
    """
    @override
    def __add__(  # type: ignore [override]
        self,
        value: IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

count 

count(value: Any) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1339
def count(self, value: Any, /) -> int: raise AssumedToBeImplementedException

index 

index(value: Any, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
1340
def index(self, value: Any, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: raise AssumedToBeImplementedException

IsSetContent

Bases: IsSet[_ValT], Protocol[_ValT]

METHOD DESCRIPTION
add
clear
difference
difference_update
discard
intersection
intersection_update
isdisjoint
issubset
issuperset
pop
remove
symmetric_difference
symmetric_difference_update
union
update
Source code in src/omnipy/shared/protocols/content.py 
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
class IsSetContent(IsSet[_ValT], Protocol[_ValT]):
    @override
    def difference(self, *s: Iterable[object]) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    @override
    def difference_update(self, *s: Iterable[object]) -> None:
        raise AssumedToBeImplementedException

    @override
    def intersection(self, *s: Iterable[object]) -> Self:  # type: ignore [override]
        raise AssumedToBeImplementedException

    @override
    def intersection_update(self, *s: Iterable[object]) -> None:
        raise AssumedToBeImplementedException

    @overload
    def symmetric_difference(  # pyright: ignore[reportOverlappingOverload]
            self,
            value: Iterable[_ValT],
            /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def symmetric_difference(self, value: Iterable[_OtherT], /) -> set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @override
    def symmetric_difference(self, value: Iterable[object], /) -> Self | set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def union(  # pyright: ignore[reportOverlappingOverload]
            self,
            value: Iterable[_ValT],
            /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def union(self, value: Iterable[_OtherT], /) -> set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @override
    def union(  # pyright: ignore[reportIncompatibleMethodOverride]
        self,
        value: Iterable[object],
        /,
    ) -> Self | set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @override
    def __and__(  # type: ignore [override]
        self,
        value: IsAbstractSet[object] | IsItemSequence[object] | Generator[object],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @override
    def __iand__(  # type: ignore [override]
        self,
        value: IsAbstractSet[object] | IsItemSequence[object] | Generator[object],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __or__(
        self,
        value: IsAbstractSet[_ValT] | IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __or__(self, value: IsAbstractSet[_OtherT], /) -> set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @override
    def __or__(
        self,
        value: IsAbstractSet[object] | IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self | set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @override
    def __ior__(  # type: ignore [override]
        self,
        value: IsAbstractSet[_ValT] | IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @override
    def __sub__(  # type: ignore [override]
        self,
        value: (IsAbstractSet[_ValT | None] | IsItemSequence[_ValT | None]
                | Generator[_ValT | None]),
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @override
    def __isub__(  # type: ignore [override]
        self,
        value: IsAbstractSet[object] | IsItemSequence[object] | Generator[object],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload  # type: ignore [override]
    def __xor__(
        self,
        value: IsAbstractSet[_ValT] | IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

    @overload
    def __xor__(self, value: IsAbstractSet[_OtherT], /) -> set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @override
    def __xor__(
        self,
        value: IsAbstractSet[object] | IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self | set[_ValT | _OtherT]:
        raise AssumedToBeImplementedException

    @override
    def __ixor__(  # type: ignore [override]
        self,
        value: IsAbstractSet[_ValT] | IsItemSequence[_ValT] | Generator[_ValT],
        /,
    ) -> Self:
        raise AssumedToBeImplementedException

add 

add(element: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1634
def add(self, element: _T, /) -> None: raise AssumedToBeImplementedException

clear 

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

difference 

difference(*s: Iterable[object]) -> Self
Source code in src/omnipy/shared/protocols/content.py 
333
334
335
@override
def difference(self, *s: Iterable[object]) -> Self:  # type: ignore [override]
    raise AssumedToBeImplementedException

difference_update 

difference_update(*s: Iterable[object]) -> None
Source code in src/omnipy/shared/protocols/content.py 
337
338
339
@override
def difference_update(self, *s: Iterable[object]) -> None:
    raise AssumedToBeImplementedException

discard 

discard(element: object) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1638
def discard(self, element: object, /) -> None: raise AssumedToBeImplementedException

intersection 

intersection(*s: Iterable[object]) -> Self
Source code in src/omnipy/shared/protocols/content.py 
341
342
343
@override
def intersection(self, *s: Iterable[object]) -> Self:  # type: ignore [override]
    raise AssumedToBeImplementedException

intersection_update 

intersection_update(*s: Iterable[object]) -> None
Source code in src/omnipy/shared/protocols/content.py 
345
346
347
@override
def intersection_update(self, *s: Iterable[object]) -> None:
    raise AssumedToBeImplementedException

isdisjoint 

isdisjoint(s: Iterable[object]) -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
1641
def isdisjoint(self, s: Iterable[object], /) -> bool: raise AssumedToBeImplementedException

issubset 

issubset(s: Iterable[object]) -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
1642
def issubset(self, s: Iterable[object], /) -> bool: raise AssumedToBeImplementedException

issuperset 

issuperset(s: Iterable[object]) -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
1643
def issuperset(self, s: Iterable[object], /) -> bool: raise AssumedToBeImplementedException

pop 

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

remove 

remove(element: _T) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1644
def remove(self, element: _T, /) -> None: raise AssumedToBeImplementedException

symmetric_difference 

symmetric_difference(value: Iterable[_ValT]) -> Self

symmetric_difference(value: Iterable[_OtherT]) -> set[_ValT | _OtherT]

symmetric_difference(value: Iterable[object]) -> Self | set[_ValT | _OtherT]
Source code in src/omnipy/shared/protocols/content.py 
361
362
363
@override
def symmetric_difference(self, value: Iterable[object], /) -> Self | set[_ValT | _OtherT]:
    raise AssumedToBeImplementedException

symmetric_difference_update 

symmetric_difference_update(s: Iterable[_T]) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1646
def symmetric_difference_update(self, s: Iterable[_T], /) -> None: raise AssumedToBeImplementedException

union 

union(value: Iterable[_ValT]) -> Self

union(value: Iterable[_OtherT]) -> set[_ValT | _OtherT]

union(value: Iterable[object]) -> Self | set[_ValT | _OtherT]
Source code in src/omnipy/shared/protocols/content.py 
377
378
379
380
381
382
383
@override
def union(  # pyright: ignore[reportIncompatibleMethodOverride]
    self,
    value: Iterable[object],
    /,
) -> Self | set[_ValT | _OtherT]:
    raise AssumedToBeImplementedException

update 

update(*s: Iterable[_T]) -> None
Source code in src/omnipy/shared/protocols/builtins.py 
1648
def update(self, *s: Iterable[_T]) -> None: raise AssumedToBeImplementedException

IsStrContent

Bases: IsStr, Protocol

METHOD DESCRIPTION
capitalize
casefold
center
count
encode
endswith
expandtabs
find
format
format_map
index
isalnum
isalpha
isascii
isdecimal
isdigit
isidentifier
islower
isnumeric
isprintable
isspace
istitle
isupper
join
ljust
lower
lstrip
maketrans
partition
removeprefix
removesuffix
replace
rfind
rindex
rjust
rpartition
rsplit
rstrip
split
splitlines
startswith
strip
swapcase
title
translate
upper
zfill
Source code in src/omnipy/shared/protocols/content.py 
322
323
324
class IsStrContent(IsStr, Protocol):
    def __add__(self, value: IsStr, /) -> Self:
        raise AssumedToBeImplementedException

capitalize 

capitalize() -> LiteralString

capitalize() -> Self

capitalize() -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
536
def capitalize(self) -> Self | LiteralString: raise AssumedToBeImplementedException

casefold 

casefold() -> LiteralString

casefold() -> Self

casefold() -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
543
def casefold(self) -> Self | LiteralString: raise AssumedToBeImplementedException

center 

center(width: SupportsIndex, fillchar: LiteralString = ' ') -> LiteralString

center(width: SupportsIndex, fillchar: str = ' ') -> Self

center(width: SupportsIndex, fillchar: str | LiteralString = ' ') -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
550
def center(self, width: SupportsIndex, fillchar: str | LiteralString = ' ', /) -> Self | LiteralString: raise AssumedToBeImplementedException

count 

count(sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
552
def count(self, sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> int: raise AssumedToBeImplementedException

encode 

encode(encoding: str = 'utf-8', errors: str = 'strict') -> bytes
Source code in src/omnipy/shared/protocols/builtins.py 
553
def encode(self, encoding: str = "utf-8", errors: str = "strict") -> bytes: raise AssumedToBeImplementedException

endswith 

endswith(
    suffix: str | tuple[str, ...],
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
554
555
556
def endswith(
    self, suffix: str | tuple[str, ...], start: SupportsIndex | None = None, end: SupportsIndex | None = None, /
) -> bool: raise AssumedToBeImplementedException

expandtabs 

expandtabs(tabsize: SupportsIndex = 8) -> LiteralString

expandtabs(tabsize: SupportsIndex = 8) -> Self

expandtabs(tabsize: SupportsIndex = 8) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
563
def expandtabs(self, tabsize: SupportsIndex = 8) -> Self | LiteralString: raise AssumedToBeImplementedException

find 

find(sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
565
def find(self, sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> int: raise AssumedToBeImplementedException

format 

format(*args: LiteralString, **kwargs: LiteralString) -> LiteralString

format(*args: object, **kwargs: object) -> Self

format(*args: object | LiteralString, **kwargs: object | LiteralString) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
572
def format(self, *args: object | LiteralString, **kwargs: object | LiteralString) -> Self | LiteralString: raise AssumedToBeImplementedException

format_map 

format_map(mapping: _FormatMapMapping) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
575
def format_map(self, mapping: _FormatMapMapping, /) -> Self: raise AssumedToBeImplementedException

index 

index(sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
577
def index(self, sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> int: raise AssumedToBeImplementedException

isalnum 

isalnum() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
578
def isalnum(self) -> bool: raise AssumedToBeImplementedException

isalpha 

isalpha() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
579
def isalpha(self) -> bool: raise AssumedToBeImplementedException

isascii 

isascii() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
580
def isascii(self) -> bool: raise AssumedToBeImplementedException

isdecimal 

isdecimal() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
581
def isdecimal(self) -> bool: raise AssumedToBeImplementedException

isdigit 

isdigit() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
582
def isdigit(self) -> bool: raise AssumedToBeImplementedException

isidentifier 

isidentifier() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
583
def isidentifier(self) -> bool: raise AssumedToBeImplementedException

islower 

islower() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
584
def islower(self) -> bool: raise AssumedToBeImplementedException

isnumeric 

isnumeric() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
585
def isnumeric(self) -> bool: raise AssumedToBeImplementedException

isprintable 

isprintable() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
586
def isprintable(self) -> bool: raise AssumedToBeImplementedException

isspace 

isspace() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
587
def isspace(self) -> bool: raise AssumedToBeImplementedException

istitle 

istitle() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
588
def istitle(self) -> bool: raise AssumedToBeImplementedException

isupper 

isupper() -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
589
def isupper(self) -> bool: raise AssumedToBeImplementedException

join 

join(iterable: Iterable[LiteralString]) -> LiteralString

join(iterable: Iterable[str]) -> Self

join(iterable: Iterable[str] | Iterable[LiteralString]) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
596
def join(self, iterable: Iterable[str] | Iterable[LiteralString], /) -> Self | LiteralString: raise AssumedToBeImplementedException

ljust 

ljust(width: SupportsIndex, fillchar: LiteralString = ' ') -> LiteralString

ljust(width: SupportsIndex, fillchar: str = ' ') -> Self

ljust(width: SupportsIndex, fillchar: str | LiteralString = ' ') -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
603
def ljust(self, width: SupportsIndex, fillchar: str | LiteralString = ' ', /) -> Self | LiteralString: raise AssumedToBeImplementedException

lower 

lower() -> LiteralString

lower() -> Self

lower() -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
610
def lower(self) -> Self | LiteralString: raise AssumedToBeImplementedException

lstrip 

lstrip(chars: LiteralString | None = None) -> LiteralString

lstrip(chars: str | None = None) -> Self

lstrip(chars: str | LiteralString | None = None) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
617
def lstrip(self, chars: str | LiteralString | None = None, /) -> Self | LiteralString: raise AssumedToBeImplementedException

maketrans staticmethod 

maketrans(
    x: dict[int, _T" optional hover>_T]
    | dict[str, _T" optional hover>_T]
    | dict[str | int, _T]
    | frozendict[int, _T]
    | frozendict[str, _T]
    | frozendict[str | int, _T],
) -> dict[int, _T]

maketrans(x: dict[int, _T] | dict[str, _T] | dict[str | int, _T]) -> dict[int, _T]

maketrans(x: str, y: str) -> dict[int, int]

maketrans(x: str, y: str, z: str) -> dict[int, int | None]

maketrans(
    x: str | dict[int, _T] | dict[str, _T] | dict[str | int, _T],
    y: str | None = None,
    z: str | None = None,
) -> dict[int, _T] | dict[int, int] | dict[int, int | None]
Source code in src/omnipy/shared/protocols/builtins.py 
773
774
@staticmethod
def maketrans(x: str | dict[int, _T] | dict[str, _T] | dict[str | int, _T], y: str | None = None, z: str | None = None, /) -> dict[int, _T] | dict[int, int] | dict[int, int | None]: raise AssumedToBeImplementedException

partition 

partition(sep: LiteralString) -> tuple[LiteralString, LiteralString, LiteralString]

partition(sep: str) -> tuple[Self, Self, Self]

partition(
    sep: str | LiteralString,
) -> tuple[Self, Self, Self] | tuple[LiteralString, LiteralString, LiteralString]
Source code in src/omnipy/shared/protocols/builtins.py 
624
def partition(self, sep: str | LiteralString, /) -> tuple[Self, Self, Self] | tuple[LiteralString, LiteralString, LiteralString]: raise AssumedToBeImplementedException

removeprefix 

removeprefix(prefix: LiteralString) -> LiteralString

removeprefix(prefix: str) -> Self

removeprefix(prefix: str | LiteralString) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
650
def removeprefix(self, prefix: str | LiteralString, /) -> Self | LiteralString: raise AssumedToBeImplementedException

removesuffix 

removesuffix(suffix: LiteralString) -> LiteralString

removesuffix(suffix: str) -> Self

removesuffix(suffix: str | LiteralString) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
657
def removesuffix(self, suffix: str | LiteralString, /) -> Self | LiteralString: raise AssumedToBeImplementedException

replace 

replace(old: LiteralString, new: LiteralString, count: SupportsIndex = -1) -> LiteralString

replace(old: str, new: str, count: SupportsIndex = -1) -> Self

replace(
    old: str | LiteralString, new: str | LiteralString, count: SupportsIndex = -1
) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
643
def replace(self, old: str | LiteralString, new: str | LiteralString, count: SupportsIndex = -1, /) -> Self | LiteralString: raise AssumedToBeImplementedException

rfind 

rfind(sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
659
def rfind(self, sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> int: raise AssumedToBeImplementedException

rindex 

rindex(sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None) -> int
Source code in src/omnipy/shared/protocols/builtins.py 
660
def rindex(self, sub: str, start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> int: raise AssumedToBeImplementedException

rjust 

rjust(width: SupportsIndex, fillchar: LiteralString = ' ') -> LiteralString

rjust(width: SupportsIndex, fillchar: str = ' ') -> Self

rjust(width: SupportsIndex, fillchar: str | LiteralString = ' ') -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
667
def rjust(self, width: SupportsIndex, fillchar: str | LiteralString = " ", /) -> Self | LiteralString: raise AssumedToBeImplementedException

rpartition 

rpartition(sep: LiteralString) -> tuple[LiteralString, LiteralString, LiteralString]

rpartition(sep: str) -> tuple[Self, Self, Self]

rpartition(
    sep: str | LiteralString,
) -> tuple[Self, Self, Self] | tuple[LiteralString, LiteralString, LiteralString]
Source code in src/omnipy/shared/protocols/builtins.py 
674
def rpartition(self, sep: str | LiteralString, /) -> tuple[Self, Self, Self] | tuple[LiteralString, LiteralString, LiteralString]: raise AssumedToBeImplementedException

rsplit 

rsplit(sep: LiteralString | None = None, maxsplit: SupportsIndex = -1) -> list[LiteralString]

rsplit(sep: str | None = None, maxsplit: SupportsIndex = -1) -> list[Self]

rsplit(
    sep: str | LiteralString | None = None, maxsplit: SupportsIndex = -1
) -> list[Self] | list[LiteralString]
Source code in src/omnipy/shared/protocols/builtins.py 
681
def rsplit(self, sep: str | LiteralString | None = None, maxsplit: SupportsIndex = -1) -> list[Self] | list[LiteralString]: raise AssumedToBeImplementedException

rstrip 

rstrip(chars: LiteralString | None = None) -> LiteralString

rstrip(chars: str | None = None) -> Self

rstrip(chars: str | None = None) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
688
def rstrip(self, chars: str | None = None, /) -> Self | LiteralString: raise AssumedToBeImplementedException

split 

split(sep: LiteralString | None = None, maxsplit: SupportsIndex = -1) -> list[LiteralString]

split(sep: str | None = None, maxsplit: SupportsIndex = -1) -> list[Self]

split(
    sep: str | LiteralString | None = None, maxsplit: SupportsIndex = -1
) -> list[Self] | list[LiteralString]
Source code in src/omnipy/shared/protocols/builtins.py 
695
def split(self, sep: str | LiteralString | None = None, maxsplit: SupportsIndex = -1) -> list[Self] | list[LiteralString]: raise AssumedToBeImplementedException

splitlines 

splitlines(keepends: bool = False) -> list[LiteralString]

splitlines(keepends: bool = False) -> list[Self]

splitlines(keepends: bool = False) -> list[Self] | list[LiteralString]
Source code in src/omnipy/shared/protocols/builtins.py 
702
def splitlines(self, keepends: bool = False) -> list[Self] | list[LiteralString]: raise AssumedToBeImplementedException

startswith 

startswith(
    prefix: str | tuple[str, ...],
    start: SupportsIndex | None = None,
    end: SupportsIndex | None = None,
) -> bool
Source code in src/omnipy/shared/protocols/builtins.py 
704
705
706
def startswith(
    self, prefix: str | tuple[str, ...], start: SupportsIndex | None = None, end: SupportsIndex | None = None, /
) -> bool: raise AssumedToBeImplementedException

strip 

strip(chars: LiteralString | None = None) -> LiteralString

strip(chars: str | None = None) -> Self

strip(chars: str | LiteralString | None = None) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
714
def strip(self, chars: str | LiteralString | None = None, /) -> Self | LiteralString: raise AssumedToBeImplementedException

swapcase 

swapcase() -> LiteralString

swapcase() -> Self

swapcase() -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
721
def swapcase(self) -> Self | LiteralString: raise AssumedToBeImplementedException

title 

title() -> LiteralString

title() -> Self

title() -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
728
def title(self) -> Self | LiteralString: raise AssumedToBeImplementedException

translate 

translate(table: _TranslateTable) -> Self
Source code in src/omnipy/shared/protocols/builtins.py 
731
def translate(self, table: _TranslateTable, /) -> Self: raise AssumedToBeImplementedException

upper 

upper() -> LiteralString

upper() -> Self

upper() -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
738
def upper(self) -> Self | LiteralString: raise AssumedToBeImplementedException

zfill 

zfill(width: SupportsIndex) -> LiteralString

zfill(width: SupportsIndex) -> Self

zfill(width: SupportsIndex) -> Self | LiteralString
Source code in src/omnipy/shared/protocols/builtins.py 
746
def zfill(self, width: SupportsIndex, /) -> Self | LiteralString: raise AssumedToBeImplementedException