zimscraperlib.typing

Classes:

• Callback –
• SupportsRead –
• SupportsSeekableRead –
• SupportsSeekableWrite –
• SupportsSeeking –
• SupportsWrite –

  Protocol exposing an expected write method

Callback dataclass

Callback(
    func: Callable[..., Any],
    args: tuple[Any, ...] | None = None,
    kwargs: dict[str, Any] | None = None,
)

Methods:

• call –
• call_with –
• get_args –
• get_kwargs –

Attributes:

• args (tuple[Any, ...] | None) –
• callable (bool) –
• func (Callable[..., Any]) –
• kwargs (dict[str, Any] | None) –

args class-attribute instance-attribute

args: tuple[Any, ...] | None = None

callable property

callable: bool

func instance-attribute

func: Callable[..., Any]

kwargs class-attribute instance-attribute

kwargs: dict[str, Any] | None = None

call

call()

Source code in src/zimscraperlib/typing.py

def call(self):
    self.call_with(*self.get_args(), **self.get_kwargs())

call_with

call_with(*args: Any, **kwargs: Any)

Source code in src/zimscraperlib/typing.py

def call_with(self, *args: Any, **kwargs: Any):
    self.func(*args, **kwargs)

get_args

get_args() -> tuple[Any, ...]

Source code in src/zimscraperlib/typing.py

def get_args(self) -> tuple[Any, ...]:
    return self.args or ()

get_kwargs

get_kwargs() -> dict[str, Any]

Source code in src/zimscraperlib/typing.py

def get_kwargs(self) -> dict[str, Any]:
    return self.kwargs or {}

SupportsRead

Bases: Protocol[_T_co]

Methods:

• read –

read

read(length: int = ...) -> _T_co

Source code in src/zimscraperlib/typing.py

def read(self, length: int = ..., /) -> _T_co: ...

SupportsSeekableRead

Bases: SupportsRead[_T_co], SupportsSeeking, Protocol

Methods:

• read –
• seek –
• seekable –
• tell –
• truncate –

read

read(length: int = ...) -> _T_co

Source code in src/zimscraperlib/typing.py

def read(self, length: int = ..., /) -> _T_co: ...

seek

seek(target: int, whence: int = 0) -> int

Source code in src/zimscraperlib/typing.py

def seek(self, target: int, whence: int = 0) -> int: ...

seekable

seekable() -> bool

Source code in src/zimscraperlib/typing.py

def seekable(self) -> bool: ...

tell

tell() -> int

Source code in src/zimscraperlib/typing.py

def tell(self) -> int: ...

truncate

truncate(pos: int) -> int

Source code in src/zimscraperlib/typing.py

def truncate(self, pos: int) -> int: ...

SupportsSeekableWrite

Bases: SupportsWrite[_T_contra], SupportsSeeking, Protocol

Methods:

• seek –
• seekable –
• tell –
• truncate –
• write –

seek

seek(target: int, whence: int = 0) -> int

Source code in src/zimscraperlib/typing.py

def seek(self, target: int, whence: int = 0) -> int: ...

seekable

seekable() -> bool

Source code in src/zimscraperlib/typing.py

def seekable(self) -> bool: ...

tell

tell() -> int

Source code in src/zimscraperlib/typing.py

def tell(self) -> int: ...

truncate

truncate(pos: int) -> int

Source code in src/zimscraperlib/typing.py

def truncate(self, pos: int) -> int: ...

write

write(s: _T_contra) -> object

Source code in src/zimscraperlib/typing.py

def write(self, s: _T_contra, /) -> object: ...

SupportsSeeking

Bases: Protocol

Methods:

• seek –
• seekable –
• tell –
• truncate –

seek

seek(target: int, whence: int = 0) -> int

Source code in src/zimscraperlib/typing.py

def seek(self, target: int, whence: int = 0) -> int: ...

seekable

seekable() -> bool

Source code in src/zimscraperlib/typing.py

def seekable(self) -> bool: ...

tell

tell() -> int

Source code in src/zimscraperlib/typing.py

def tell(self) -> int: ...

truncate

truncate(pos: int) -> int

Source code in src/zimscraperlib/typing.py

def truncate(self, pos: int) -> int: ...

SupportsWrite

Bases: Protocol[_T_contra]

Protocol exposing an expected write method

Methods:

• write –

write

write(s: _T_contra) -> object

Source code in src/zimscraperlib/typing.py

def write(self, s: _T_contra, /) -> object: ...