python-libzim/libzim/reader.pyi at ff328b07b0e4404e1e85c91ff9470185f63bcf0b · openzim/python-libzim · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
from __future__ import annotations

import pathlib
from uuid import UUID

class Item:
    @property
    def title(self) -> str: ...
    @property
    def path(self) -> str: ...
    @property
    def content(self) -> memoryview: ...
    @property
    def mimetype(self) -> str: ...
    @property
    def _index(self) -> int: ...
    @property
    def size(self) -> int: ...
    def __repr__(self) -> str: ...

class Entry:
    @property
    def title(self) -> str: ...
    @property
    def path(self) -> str: ...
    @property
    def _index(self) -> int: ...
    @property
    def is_redirect(self) -> bool: ...
    def get_redirect_entry(self) -> Entry: ...
    def get_item(self) -> Item: ...
    def __repr__(self) -> str: ...

class Archive:
    def __init__(self, filename: pathlib.Path) -> None: ...
    @property
    def filename(self) -> pathlib.Path: ...
    @property
    def filesize(self) -> int: ...
    def has_entry_by_path(self, path: str) -> bool: ...
    def get_entry_by_path(self, path: str) -> Entry: ...
    def has_entry_by_title(self, title: str) -> bool: ...
    def get_entry_by_title(self, title: str) -> Entry: ...
    def get_random_entry(self) -> Entry: ...
    @property
    def metadata_keys(self) -> list[str]: ...
    def get_metadata_item(self, name: str) -> Item: ...
    def get_metadata(self, name: str) -> bytes: ...
    def _get_entry_by_id(self, entry_id: int) -> Entry: ...
    @property
    def has_main_entry(self) -> bool: ...
    @property
    def main_entry(self) -> Entry: ...
    @property
    def uuid(self) -> UUID: ...
    @property
    def has_new_namespace_scheme(self) -> bool: ...
    @property
    def is_multipart(self) -> bool: ...
    @property
    def has_fulltext_index(self) -> bool: ...
    @property
    def has_title_index(self) -> bool: ...
    @property
    def has_checksum(self) -> str: ...
    @property
    def checksum(self) -> str: ...
    def check(self) -> bool: ...
    @property
    def entry_count(self) -> int: ...
    @property
    def all_entry_count(self) -> int: ...
    @property
    def article_count(self) -> int: ...
    @property
    def media_count(self) -> int: ...
    def get_illustration_sizes(self) -> set[int]: ...
    def has_illustration(self, size: int | None = None) -> bool: ...
    def get_illustration_item(self, size: int | None = None) -> Item: ...
    @property
    def dirent_cache_max_size(self) -> int: ...
    @dirent_cache_max_size.setter
    def dirent_cache_max_size(self, nb_dirents: int): ...
    @property
    def dirent_cache_current_size(self) -> int: ...
    def __repr__(self) -> str: ...

def get_cluster_cache_max_size() -> int: ...
def set_cluster_cache_max_size(nb_clusters: int): ...
def get_cluster_cache_current_size() -> int: ...