Core

Core module. It defines base classes and their interaction interface.

• Context
  • Options
    • UserOptions
  • Content
    • FileContent
    • ModelContent
    • TextureContent
    • ImageContent
    • TextureArrayContent
    • NbtContent
• IO
  • Base
    • StructIO
  • Streams
    • StructBytesIO
    • StructFileIO

Base

Base class for all processable files.

class BaseFile

Bases: ABC

Abstract base class providing interface for encoders/decoders.

format: FileFormat

order: ByteOrder = '<'

signature: Optional[bytes] = None

options: UserOptions

Decoder

Base class for file decoder (parsing).

class FileDecoder(file, options=None)

Bases: BaseFile, StructFileIO, Generic[Content], ABC

Base class for decoding file content into structured data objects.

mode: str = 'rb'

decode(seek=True)

Decode file: prepare, validate signature, parse. Returns parsed data.

Return type:

TypeVar(Content, bound= FileContent)

convert_to(encoder, options=None)

Decode and convert to encoder. Returns encoder with open buffer (must be closed).

Return type:

FileEncoder[TypeVar(Content, bound= FileContent)]

convert(encoder, options=None)

Decode, convert to encoder and return bytes. Closes encoder automatically.

Return type:

bytes

prepare()

Perform file preparation before parsing. (e.g. skip bytes).

Return type:

None

abstractmethod parse()

Parse file content into self.data.

Return type:

None

validate_signature()

Validate file signature. Raises EmptyFileError or InvalidSignatureError on failure.

Return type:

None

close()

Close file buffer. Same as FileIO.close().

Return type:

None

Encoder

Base class for file encoder (serialization).

class FileEncoder(data, options=None)

Bases: BaseFile, StructBytesIO, Generic[Content], ABC

Base class for encoding structured data objects into file content.

property mode: str

property suffix: str

Return standard file extension for this format (with dot).

encode()

Encode data: prepare, add signature, serialize. Returns self.

Return type:

Self

encoded()

Context manager that automatically encodes data on exit.

Return type:

Self

prepare()

Perform preparations before serialization. (e.g. calculations in content).

Return type:

None

add_signature()

Write format signature (magic bytes) to buffer if defined.

Return type:

None

abstractmethod serialize()

Convert structured self.data into bytes and write to buffer.

Return type:

None

save_as(path)

Write buffer content to file. Keeps encoder open.

Return type:

None

export_as(path)

Save to path (without suffix) adding format suffix automatically. Keeps encoder open.

Return type:

None

save(path)

Write buffer content to file. Closes encoder.

Return type:

None

export(path)

Save to path (without suffix) adding format suffix automatically. Closes encoder.

Return type:

None

close()

Close buffer and reset self.ctx state. Same as BytesIO.close().

Return type:

None