tivars.types.group.TIGroup

class documentation

class TIGroup(SizedEntry): (source)

Constructors: TIGroup.group(entries, name), TIGroup(init, name, version, archived, data)

Parser for group objects

A group is a collection of entries packaged together for easy transfer and saving in the archive. Each entry is stored with its entry in the VAT followed by its regular data.

The VAT information can be safely ignored since it is redetermined when importing back onto a calculator.

Static Method	`group`	Creates a new `TIGroup` by packaging a sequence of entries using defaulted VAT data
Method	`__init__`	Creates an empty entry with specified meta and data values
Method	`dict`	No summary
Method	`get_min_os`	Determines the minimum OS that supports this entry's data
Method	`get_version`	Determines the version byte corresponding to given data for this entry type
Method	`load_dict`	Loads this component from a JSON dictionary representation
Method	`load_from_entries`	Loads a sequence of entries into this group
Method	`ungroup`	Ungroups a group object into a `list` of its entries
Class Variable	`_type_id`	Undocumented

Inherited from SizedEntry:

Method	`calc_data`	The data section of the component which is loaded on-calc
Method	`clear`	Clears this entry's data
Method	`data`	The component's user data
Method	`get_length`	Determines the length of this entry's user data section
Method	`length`	The length of this entry's user data section
Method	`load_bytes`	Loads a byte string or bytestream into this entry
Method	`load_data_section`	Loads the data of this entry from a bytestream
Class Variable	`min_calc_data_length`	The minimum length of this entry's data

Inherited from TIEntry (via SizedEntry):

Class	`Raw`	No class docstring; 3/3 properties, 0/1 class variable, 1/1 method documented
Class Method	`get_extension`	Determines the file extension for a targeted model based on its contents
Class Method	`get_type`	Gets the subclass corresponding to a type ID, type name, or file extension if one is registered
Class Method	`open`	Creates a new entry from a file given a filename
Static Method	`next_entry_length`	Helper function to determine the length of the next entry in a bytestream
Method	`__iter__`	No summary
Method	`__len__`	No summary
Method	`archive`	Archives this entry
Method	`archived`	Whether the entry is archived
Method	`bytes`	The bytes contained in this entry, without any var file header or metadata.
Method	`export`	Exports this entry to a `TIVarFile` with a specified name and header
Method	`load_from_file`	Loads this entry from a file given a file pointer and offset
Method	`meta_length`	The length of the meta section of the entry
Method	`name`	The name of the entry
Method	`save`	Saves this entry as a var file in the current directory given a filename and optional header and targeted model
Method	`summary`	No summary
Method	`supported_by`	Determines whether a given model supports this entry
Method	`type_id`	The type ID of the entry
Method	`unarchive`	Unarchives this entry
Method	`version`	The version number of the entry
Class Variable	`base_meta_length`	Undocumented
Class Variable	`extension`	The base file extension used for this entry
Class Variable	`flash_meta_length`	Undocumented
Class Variable	`flash_only`	Whether this entry only supports flash chips
Class Variable	`leading_data_bytes`	Bytes that always begin this entry's data
Class Variable	`leading_name_byte`	Byte that always begins the name of this entry
Class Variable	`versions`	The possible versions of this entry
Instance Variable	`raw`	Undocumented
Property	`calc_data_length`	The length of the data section of the entry
Property	`flash_bytes`	The flash bytes of this entry if they exist
Property	`for_flash`	Whether this entry supports flash chips
Property	`meta`	The meta section of this entry
Method	`__init_subclass__`	Undocumented
Class Variable	`_type_ids`	Undocumented

Inherited from TIComponent (via SizedEntry, TIEntry):

Class Method	`get`	Converts `bytes` -> `TIComponent`
Class Method	`register`	Registers a subtype with this class for coercion
Class Method	`set`	Converts `TIComponent` -> `bytes`
Method	`__bool__`	No summary
Method	`__bytes__`	No summary
Method	`__copy__`	No summary
Method	`__eq__`	Determines if two components are the same type and have the same bytes
Method	`__format__`	Undocumented
Method	`__str__`	No summary
Method	`coerce`	Coerces this component to a subclass if possible using the component's type ID
Method	`json`	No summary
Method	`load_json`	Loads this component from a JSON dictionary representation
Method	`load_string`	Loads this component from a string representation
Method	`string`	No summary
Method	`update`	Updates this component's metadata
Property	`is_empty`	Whether this component's data is empty

Inherited from Dock (via SizedEntry, TIEntry, TIComponent):

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

@staticmethod

def group(entries: Sequence[TIEntry], *, name: str = 'GROUP') -> TIGroup: (source) ¶

Creates a new TIGroup by packaging a sequence of entries using defaulted VAT data

Parameters
entries:`Sequence[TIEntry]`	The entries to group
name:`str`	The name of the group (defaults to `GROUP`)

Returns
`TIGroup`	A group containing `entries`

def __init__(self, init=None, *, name: str = 'GROUP', version: int = None, archived: bool = True, data: bytes = None): (source) ¶

overrides tivars.var.TIEntry.__init__

Creates an empty entry with specified meta and data values

Parameters
init	Values to initialize the entry's data (defaults to `None`)
name:`str`	The name of the entry (defaults to a valid default name)
version:`int`	The entry's version (defaults to `None`)
archived:`bool`	Whether the entry is archived (defaults to entry's default state on-calc)
data:`bytes`	The entry's data (defaults to empty)

def dict(self, **kwargs) -> dict: (source) ¶

overrides tivars.var.TIEntry.dict

Returns
`dict`	A JSON dictionary representation of this component

def get_min_os(self) -> OsVersion: (source) ¶

overrides tivars.var.TIEntry.get_min_os

Determines the minimum OS that supports this entry's data

Returns
`OsVersion`	The minimum `OsVersion` this entry supports

def get_version(self) -> int: (source) ¶

overrides tivars.var.TIEntry.get_version

Determines the version byte corresponding to given data for this entry type

Entries which could contain non-backwards compatible data are assigned a version byte. If an entry's version exceeds the "version" of a calculator, transfer to the calculator will fail.

Returns
`int`	The version byte for this entry

@Loader[dict]

def load_dict(self, dct: dict, **kwargs): (source) ¶

overrides tivars.var.TIEntry.load_dict

Loads this component from a JSON dictionary representation

Parameters
dct:`dict`	The dict to load
**kwargs	Undocumented

@Loader[Sequence]

def load_from_entries(self, entries: Sequence[TIEntry]): (source) ¶

Loads a sequence of entries into this group

All VAT data is cleared.

Parameters
entries:`Sequence[TIEntry]`	The entries to group

def ungroup(self) -> list[TIEntry]: (source) ¶

Ungroups a group object into a list of its entries

All VAT data is ignored.

Returns
`list[TIEntry]`	A `list` of the entries stored in this group

_type_id: int = (source) ¶

overrides tivars.file.TIComponent._type_id

Undocumented