tivars.file.TIComponent

class documentation

class TIComponent(Dock, Converter): (source)

Known subclasses: tivars.flash.TIFlashHeader, tivars.var.TIEntry

Constructor: TIComponent(init, name, data)

Base class for data components of TI files

The subclasses of TIComponent are TIEntry (for var files) and TIFlashHeader (for flash files). Note that TIHeader is not a TIComponent due to not having proper attached data.

Class	`Raw`	Raw bytes container for this component
Class Method	`get`	Converts `bytes` -> `TIComponent`
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 component from a file given a filename
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	`__init__`	Creates an empty component with specified data
Method	`__len__`	No summary
Method	`__str__`	No summary
Method	`bytes`	No summary
Method	`calc_data`	The data section of the component which is loaded on-calc
Method	`clear`	Clears this component's data
Method	`coerce`	Coerces this component to a subclass if possible using the component's type ID
Method	`data`	The component's user data
Method	`dict`	No summary
Method	`get_extension`	Determines the file extension for a targeted model based on its contents
Method	`json`	No summary
Method	`load_bytes`	Loads a byte string or bytestream into this component
Method	`load_dict`	Loads this component from a JSON dictionary representation
Method	`load_from_file`	Loads this component from a file given a file pointer and offset
Method	`load_json`	Loads this component from a JSON dictionary representation
Method	`load_string`	Loads this component from a string representation
Method	`name`	The name of the component
Method	`save`	Saves this component as a complete file in the current directory given a filename and optional targeted model
Method	`string`	No summary
Method	`summary`	No summary
Method	`type_id`	The (first) type ID of the component
Method	`update`	Updates this component's metadata
Property	`is_empty`	Whether this component's data is empty
Class Variable	`_type_id`	Undocumented
Class Variable	`_type_ids`	Undocumented

Inherited from Dock:

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(cls, data: bytes, **kwargs) -> Self: (source) ¶

overrides tivars.data.Converter.get

Converts bytes -> TIComponent

Parameters
data:`bytes`	The raw bytes to convert
**kwargs	Undocumented

Returns
`Self`	A `TIComponent` instance with data equal to `data`

@classmethod

def get_type(cls, *, type_id: int = None, name: str = None, extension: str = None) -> type[Self] | None: (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Gets the subclass corresponding to a type ID, type name, or file extension if one is registered

Parameters
type_id:`int`	The type ID to search by, or
name:`str`	The type name to search by, or
extension:`str`	The file extension to search by

Returns
`type[Self] \| None`	A subclass of this component with corresponding type ID or extension, or `None`

@classmethod

def open(cls, filename: str) -> Self: (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Creates a new component from a file given a filename

Parameters
filename:`str`	A filename to open

Returns
`Self`	The (first) component stored in the file

@classmethod

def register(cls, var_type: type[Self], override: int = None): (source) ¶

Registers a subtype with this class for coercion

Parameters
var_type:`type[Self]`	The component subtype to register
override:`int`	A type ID to use for registry that differs from that of the var type (defaults to no override)

@classmethod

def set(cls, value: Self, **kwargs) -> bytes: (source) ¶

overrides tivars.data.Converter.set

Converts TIComponent -> bytes

Parameters
value:`Self`	The value to convert
**kwargs	Undocumented

Returns
`bytes`	The data of `value`

def __bool__(self) -> bool: (source) ¶

Returns
`bool`	Whether this component's data is empty

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

Returns
`bytes`	The bytes contained in this component

def __copy__(self) -> Self: (source) ¶

Returns
`Self`	A copy of this component

def __eq__(self, other) -> bool: (source) ¶

Determines if two components are the same type and have the same bytes

Parameters
other	The component to check against

Returns
`bool`	Whether this component is equal to `other`

def __format__(self, format_spec: str) -> str: (source) ¶

overridden in tivars.types.complex.ComplexEntry, tivars.types.gdb.TIMonoGDB, tivars.types.list.TIList, tivars.types.matrix.TIMatrix, tivars.types.real.RealEntry, tivars.types.settings.SettingsEntry, tivars.types.tokenized.TokenizedEntry

Undocumented

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

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Creates an empty component with specified data

Parameters
init	Values to initialize the component's data (defaults to `None`)
name:`str`	Undocumented
data:`bytes`	The component's data (defaults to empty)

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

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Returns
`int`	The total length of this component's bytes

def __str__(self) -> str: (source) ¶

Returns
`str`	A string representation of this component

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

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Returns
`bytes`	The bytes contained in this component

@Section()

def calc_data(self) -> bytearray: (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.types.complex.ComplexEntry, tivars.types.list.TIList, tivars.types.matrix.TIMatrix, tivars.types.real.RealEntry, tivars.var.SizedEntry

The data section of the component which is loaded on-calc

def clear(self): (source) ¶

overridden in tivars.var.TIEntry

Clears this component's data

def coerce(self): (source) ¶

overridden in tivars.types.complex.ComplexEntry, tivars.types.gdb.TIGraphedEquation, tivars.types.gdb.TIMonoGDB, tivars.types.list.TIList, tivars.types.picture.PictureEntry, tivars.types.real.RealEntry, tivars.types.tokenized.TIProgram

Coerces this component to a subclass if possible using the component's type ID

Valid types must be registered to be considered for coercion.

@View(calc_data, Data)[:]

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

overridden in tivars.flash.TIFlashHeader, tivars.types.list.TIList, tivars.types.matrix.TIMatrix, tivars.var.SizedEntry

The component's user data

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

overridden in tivars.var.TIEntry

Returns
`dict`	A JSON dictionary representation of this component

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

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

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

Parameters
model:`TIModel`	The model to target (defaults to `TI_84PCE`)

Returns
`str`	The file's extension

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

Returns
`dict`	A JSON dictionary representation of this component

@Loader[bytes, bytearray, memoryview, BytesIO]

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

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Loads a byte string or bytestream into this component

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

@Loader[dict]

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

overridden in tivars.var.TIEntry

Loads this component from a JSON dictionary representation

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

@Loader[BinaryIO]

def load_from_file(self, file: BinaryIO, *, offset: int = 0): (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Loads this component from a file given a file pointer and offset

Parameters
file:`BinaryIO`	A binary file to read from
offset:`int`	The offset of the component to read

@Loader[dict]

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

Loads this component from a JSON dictionary representation

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

@Loader[str]

def load_string(self, string: str, **kwargs): (source) ¶

overridden in tivars.types.complex.ComplexEntry, tivars.types.gdb.TIMonoGDB, tivars.types.list.TIList, tivars.types.matrix.TIMatrix, tivars.types.real.TIReal, tivars.types.real.TIRealRadical, tivars.types.settings.SettingsEntry, tivars.types.tokenized.TokenizedEntry

Loads this component from a string representation

If there is no dedicated handler for a component type, all subclasses of the type will be considered.

Parameters
string:`str`	The string to load
**kwargs	Undocumented

@Section()

def name(self) -> str: (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

The name of the component

def save(self, filename: str = None, *, model: TIModel = TI_84PCE): (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Saves this component as a complete file in the current directory given a filename and optional targeted model

Parameters
filename:`str`	A filename to save to (defaults to the component's name and extension)
model:`TIModel`	A `TIModel` to target (defaults to `TI_84PCE`)

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

overridden in tivars.types.tokenized.TokenizedEntry

Returns
`str`	A string representation of this component

def summary(self) -> str: (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Returns
`str`	A text summary of this component

@Section()

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

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

The (first) type ID of the component

def update(self): (source) ¶

Updates this component's metadata

All attributes self.<name> are set to self.get_<name>() if possible.

@property

is_empty: bool = (source) ¶

Whether this component's data is empty

_type_id: int = (source) ¶

overridden in tivars.types.appvar.TIAppVar, tivars.types.complex.TIComplex, tivars.types.complex.TIComplexRadical, tivars.types.flash.TIApp, tivars.types.flash.TICertificate, tivars.types.flash.TILicense, tivars.types.flash.TIOperatingSystem, tivars.types.gdb.TIMonoGDB, tivars.types.group.TIGroup, tivars.types.list.TIComplexList, tivars.types.list.TIRealList, tivars.types.matrix.TIMatrix, tivars.types.picture.TIImage, tivars.types.picture.TIMonoPicture, tivars.types.picture.TIPicture, tivars.types.real.TIReal, tivars.types.real.TIRealRadical, tivars.types.settings.TIRecallWindow, tivars.types.settings.TITableSettings, tivars.types.settings.TIWindowSettings, tivars.types.tokenized.TIEquation, tivars.types.tokenized.TIProgram, tivars.types.tokenized.TIString

Undocumented

_type_ids: dict[int, type[Self]] = (source) ¶

overridden in tivars.flash.TIFlashHeader, tivars.var.TIEntry

Undocumented