tivars.bundle.TIBundle

class documentation

class TIBundle(TIFile): (source)

Constructors: TIBundle.bundle(files, name, model, comment, target_type, ...), TIBundle(name, data)

Interface for TI bundles

A bundle is a zip file with some metadata and a checksum.

Class Method	`get_extension`	Determines the file extension for a targeted model based on its contents
Static Method	`bundle`	Compress a list of `TIFile` objects into a bundle
Method	`__init__`	Creates an empty file with a specified name
Method	`bytes`	No summary
Method	`load_bytes`	Loads a byte string or bytestream into this file
Method	`supported_by`	Determines whether this file supports a given model
Method	`targets`	Determines whether this file targets a given model
Method	`unbundle`	Unzips a bundle into a `list` of its files
Class Variable	`magics`	Undocumented
Instance Variable	`zipfile`	Undocumented
Property	`checksum`	The checksum for the bundle
Property	`comment`	This bundle's comment(s)
Property	`metadata`	The metadata fields of the bundle
Property	`model`	The model this bundle targets
Property	`target_type`	This bundle's target type
Property	`version`	This bundle's format version (which is usually 1)
Instance Variable	`_buffer`	Undocumented

Inherited from TIFile:

Class Method	`get_type`	Gets the subclass corresponding to file magic if one is registered
Class Method	`open`	Creates a new file given a filename
Class Method	`register`	Registers a subtype with this class for coercion
Method	`__bool__`	No summary
Method	`__bytes__`	No summary
Method	`__copy__`	No summary
Method	`__eq__`	Determines if two files are identical
Method	`__format__`	Undocumented
Method	`__len__`	No summary
Method	`get_filename`	Determines the filename based on the instance name and targeted model
Method	`load_file`	Loads this file from a file pointer
Method	`save`	Saves this file given a filename
Method	`summary`	No summary
Instance Variable	`name`	Undocumented
Property	`is_empty`	Whether this file is empty
Method	`__init_subclass__`	Undocumented
Class Variable	`_magics`	Undocumented

Inherited from Dock (via TIFile):

Method	`load`	Loads data into an instance by delegating to `Loader` methods based on the input's type
Class Variable	`loaders`	Undocumented

@classmethod

def get_extension(cls, model: TIModel = TI_84PCE) -> str: (source) ¶

overrides tivars.file.TIFile.get_extension

Determines the file extension for a targeted model based on its contents

Parameters
model:`TIModel`	The model to target (defaults to this file's minimum supported model)

Returns
`str`	The file's extension

@staticmethod

def bundle(files: list[TIFile], *, name: str = 'BUNDLE', model: TIModel = TI_84PCE, comment: str = 'Created with tivars_lib_py v1.1.0', target_type: str = 'CUSTOM', version: int = 1) -> TIBundle: (source) ¶

Compress a list of TIFile objects into a bundle

Parameters
files:`list[TIFile]`	The files to bundle
name:`str`	The name of the bundle (defaults to `BUNDLE`)
model:`TIModel`	The model this bundle should target (defaults to the TI-84+CE)
comment:`str`	A comment to attach to this bundle (defaults to a simple lib message)
target_type:`str`	The target type for the bundle (defaults to `CUSTOM`)
version:`int`	The format version of the bundle (defaults to 1)

Returns
`TIBundle`	A bundle containing `files` with the specified metadata

def __init__(self, *, name: str = 'BUNDLE', data: bytes = None): (source) ¶

overrides tivars.file.TIFile.__init__

Creates an empty file with a specified name

Parameters
name:`str`	The name of the file (defaults to `UNNAMED`)
data:`bytes`	The file's data (defaults to empty)

def bytes(self) -> bytes: (source) ¶

overrides tivars.file.TIFile.bytes

Returns
`bytes`	The bytes contained in this file

@Loader[bytes, bytearray, memoryview, BytesIO]

def load_bytes(self, data: bytes | BytesIO): (source) ¶

overrides tivars.file.TIFile.load_bytes

Loads a byte string or bytestream into this file

Parameters
data:`bytes \| BytesIO`	The bytes to load

def supported_by(self, model: TIModel) -> bool: (source) ¶

overrides tivars.file.TIFile.supported_by

Determines whether this file supports a given model

See .targets to check models this file explicitly targets.

Parameters
model:`TIModel`	The model to check support for

Returns
`bool`	Whether `model` supports this file

def targets(self, model: TIModel) -> bool: (source) ¶

overrides tivars.file.TIFile.targets

Determines whether this file targets a given model

See .supported_by to check models this file _can_ be sent to.

Parameters
model:`TIModel`	The model to check as a target

Returns
`bool`	Whether `model` is targeted by this file

def unbundle(self) -> list[TIFile]: (source) ¶

Unzips a bundle into a list of its files

Returns
`list[TIFile]`	A `list` of the files stored in this bundle

magics: list[str] = (source) ¶

overrides tivars.file.TIFile.magics

Undocumented

zipfile = (source) ¶

Undocumented

@property

checksum: bytes = (source) ¶

overrides tivars.file.TIFile.checksum

The checksum for the bundle

This is given as a sum of the CRC's of its files

@property

comment: str = (source) ¶

This bundle's comment(s)

@property

metadata: dict[str, str] = (source) ¶

The metadata fields of the bundle

@property

model: TIModel = (source) ¶

The model this bundle targets

@property

target_type: str = (source) ¶

This bundle's target type

@property

version: int = (source) ¶

This bundle's format version (which is usually 1)

_buffer = (source) ¶

Undocumented