pyzim.constants

module documentation

This module contains various constants.

Constant CHECKSUM_LENGTH the length of the checksum in a ZIM file, in bytes
Constant COMPATIBLE_ZIM_VERSIONS a tuple describing the compatible ZIM major versions
Constant DEFAULT_COMPRESSION default compression type to use
Constant ENCODING (default) encoding to use
Constant ENDIAN a string describing the endian-ness of integers in the ZIM file, see struct
Constant LOG_LEVEL_ALLOCATION log level used for allocation logging
Constant LOG_LEVEL_COMPRESSION_STRATEGY Undocumented
Constant LOG_LEVEL_READ log level for individual read operations
Constant LOG_LEVEL_WRITE log level for individual write operations
Constant MIMETYPE_REDIRECT symbolic mimetype used by internal redirects
Constant MIMETYPE_ZIMLISTING the mimetype used by zim listings (e.g. the title indexes)
Constant URL_ARTICLE_TITLE_INDEX full URL to the v1 title index of all articles
Constant URL_COUNTER Undocumented
Constant URL_ENTRY_TITLE_INDEX full URL to the v0 title index of all entries
Constant URL_MAINPAGE_REDIRECT Undocumented
Constant URL_XAPIAN_FULLTEXT_INDEX full URL to the xapian fulltext index
Constant URL_XAPIAN_TITLE_INDEX full URL to the xapian title index
Constant ZIM_MAJOR_VERSION current major version of the ZIM standard implemented
Constant ZIM_MINOR_VERSION current minor version of the ZIM standard implemented
CHECKSUM_LENGTH: int =

the length of the checksum in a ZIM file, in bytes

Value
16
COMPATIBLE_ZIM_VERSIONS: tuple of int =

a tuple describing the compatible ZIM major versions

Value
(ZIM_MAJOR_VERSION)
DEFAULT_COMPRESSION: pyzim.compression.CompressionType =

default compression type to use

Value
CompressionType.ZSTD
ENCODING: str =

(default) encoding to use

Value
'utf-8'
ENDIAN: str =

a string describing the endian-ness of integers in the ZIM file, see struct

Value
'<'
LOG_LEVEL_ALLOCATION: int =

log level used for allocation logging

Value
5
LOG_LEVEL_COMPRESSION_STRATEGY: int =

Undocumented

Value
7
LOG_LEVEL_READ: int =

log level for individual read operations

Value
4
LOG_LEVEL_WRITE: int =

log level for individual write operations

Value
6
MIMETYPE_REDIRECT: str =

symbolic mimetype used by internal redirects

Value
'<redirect>'
MIMETYPE_ZIMLISTING: str =

the mimetype used by zim listings (e.g. the title indexes)

Value
'application/octet-stream+zimlisting'
URL_ARTICLE_TITLE_INDEX: str =

full URL to the v1 title index of all articles

Value
'Xlisting/titleOrdered/v1'
URL_COUNTER: str =

Undocumented

Value
'MCounter'
URL_ENTRY_TITLE_INDEX: str =

full URL to the v0 title index of all entries

Value
'Xlisting/titleOrdered/v0'
URL_MAINPAGE_REDIRECT: str =

Undocumented

Value
'WmainPage'
URL_XAPIAN_FULLTEXT_INDEX: str =

full URL to the xapian fulltext index

Value
'Xfulltext/xapian'
URL_XAPIAN_TITLE_INDEX: str =

full URL to the xapian title index

Value
'Xtitle/xapian'
ZIM_MAJOR_VERSION: int =

current major version of the ZIM standard implemented

Value
6
ZIM_MINOR_VERSION: int =

current minor version of the ZIM standard implemented

Value
3