tivars.types.list.TIList

class documentation

class TIList(TIEntry): (source)

Known subclasses: tivars.types.list.TIComplexList, tivars.types.list.TIRealList

Constructor: TIList(init, name, version, archived, data)

View In Hierarchy

Base class for all list entries

A list entry is a one-dimensional array of RealEntry or ComplexEntry elements. Exact types are supported.

Method __format__ Undocumented
Method __init__ Creates an empty entry with specified meta and data values
Method __iter__ No summary
Method calc_data The data section of the component which is loaded on-calc
Method coerce Coerces this component to a subclass if possible using the component's type ID
Method data The component's user data
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 length The length of the list
Method list No summary
Method load_bytes Loads a byte string or bytestream into this entry
Method load_list Loads a sequence into this list
Method load_string Loads this component from a string representation
Method name The name of the entry
Method summary No summary
Method supported_by Determines whether a given model supports this entry
Class Variable extension The base file extension used for this entry
Class Variable min_calc_data_length The minimum length of this entry's data
Class Variable versions The possible versions of this entry

Inherited from TIEntry:

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 __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 clear Clears this entry's data
Method dict No summary
Method export Exports this entry to a TIVarFile with a specified name and header
Method load_data_section Loads the data of this entry from a bytestream
Method load_dict Loads this component from a JSON dictionary representation
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 save Saves this entry as a var file in the current directory given a filename and optional header and targeted model
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 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
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 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 __str__ No summary
Method json No summary
Method load_json Loads this component from a JSON dictionary representation
Method string No summary
Method update Updates this component's metadata
Property is_empty Whether this component's data is empty
Class Variable _type_id Undocumented

Inherited from Dock (via TIEntry, TIComponent):

Method load Loads data into an instance by delegating to Loader methods based on the input's type
Class Variable loaders Undocumented
def __format__(self, format_spec: str) -> str: (source)
overrides tivars.file.TIComponent.__format__

Undocumented

def __init__(self, init=None, *, name: str = 'L1', version: int = None, archived: bool = None, data: bytes = None): (source)
overrides tivars.var.TIEntry.__init__

Creates an empty entry with specified meta and data values

Parameters
initValues to initialize the entry's data (defaults to None)
name:strThe name of the entry (defaults to a valid default name)
version:intThe entry's version (defaults to None)
archived:boolWhether the entry is archived (defaults to entry's default state on-calc)
data:bytesThe entry's data (defaults to empty)
def __iter__(self) -> Iterator[_E]: (source)
overrides tivars.var.TIEntry.__iter__
Returns
Iterator[_E]If this entry is a container or collection, an iterator over its elements
def calc_data(self) -> bytearray: (source)
overrides tivars.file.TIComponent.calc_data

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

def coerce(self): (source)
overrides tivars.file.TIComponent.coerce

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

Valid types must be registered to be considered for coercion.

def data(self) -> bytes: (source)
overrides tivars.file.TIComponent.data

The component's user data

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
OsVersionThe 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
intThe version byte for this entry
def length(self, value) -> int: (source)

The length of the list

TI-OS imposes a limit of 999.

def list(self) -> list[_E]: (source)
Returns
list[_E]A list of the elements in this list
def load_bytes(self, data: bytes | BytesIO): (source)
overrides tivars.var.TIEntry.load_bytes

Loads a byte string or bytestream into this entry

Parameters
data:bytes | BytesIOThe bytes to load
def load_list(self, lst: Sequence[int | float | str | _E]): (source)

Loads a sequence into this list

Parameters
lst:Sequence[int | float | str | _E]The list to load
def load_string(self, string: str, **kwargs): (source)
overrides tivars.file.TIComponent.load_string

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:strThe string to load
**kwargsUndocumented
def name(self) -> str: (source)
overrides tivars.var.TIEntry.name

The name of the entry

Names must be 1 to 5 characters in length. The name can include any characters A-Z, 0-9, or θ. The name cannot start with a digit; for these lists, use L1 - L6 instead.

def summary(self) -> str: (source)
overrides tivars.var.TIEntry.summary
Returns
strA text summary of this component
def supported_by(self, model: TIModel) -> bool: (source)
overrides tivars.var.TIEntry.supported_by

Determines whether a given model supports this entry

Parameters
model:TIModelThe model to check support for
Returns
boolWhether model supports this entry
extension: str = (source)
overrides tivars.var.TIEntry.extension

The base file extension used for this entry

min_calc_data_length: int = (source)
overrides tivars.var.TIEntry.min_calc_data_length

The minimum length of this entry's data

If an entry's data is fixed in size, this value is necessarily the length of the data

versions: list[int] = (source)
overrides tivars.var.TIEntry.versions

The possible versions of this entry