tivars.types.tokenized.TIString

class documentation

class TIString(TokenizedEntry): (source)

Constructor: TIString(init, for_flash, name, version, ...)

View In Hierarchy

Parser for strings

A TIString is a stream of tokens.

Method __init__ Creates an empty entry with specified meta and data values
Method load_string Loads this entry from a string representation
Method name The name of the entry
Method string No summary
Class Variable extensions The file extension used for this entry per-model
Class Variable leading_name_byte Byte that always begins the name of this entry
Class Variable _type_id Undocumented

Inherited from TokenizedEntry:

Static Method decode Decodes a byte stream into a string of tokens
Static Method encode Encodes a string of token represented in text into a byte stream
Method __format__ Formats this entry for string representations
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_bytes Loads a byte string or bytestream into this entry
Class Variable clock_tokens Tokens which interface with the RTC
Class Variable min_data_length The minimum length of this entry's data
Class Variable versions The possible versions of this entry

Inherited from SizedEntry (via TokenizedEntry):

Method calc_data The data section of the entry which is loaded on-calc
Method clear Clears this entry's data
Method data The entry's user data
Method length The length of this entry's user data section
Method load_data_section Loads the data of this entry from a bytestream

Inherited from TIEntry (via TokenizedEntry, SizedEntry):

Class Raw Raw bytes container for TIEntry
Class Method get Converts bytes -> TIEntry
Class Method get_type Gets the subclass corresponding to a type ID if one is registered
Class Method open Creates a new entry from a file given a filename
Class Method register Registers a subtype with this class for coercion
Class Method set Converts TIEntry -> bytes
Static Method next_entry_length Helper function to determine the length of the next entry in a bytestream
Method __bool__ No summary
Method __bytes__ No summary
Method __copy__ No summary
Method __eq__ Determines if two entries are the same type and have the same bytes
Method __iter__ No summary
Method __len__ No summary
Method __str__ No summary
Method archive Archives this entry (if supported)
Method archived Whether the entry is archived
Method bytes The bytes contained in this entry, without any var file header or metadata.
Method coerce Coerces this entry to a subclass if possible using the entry's type ID
Method dict No summary
Method export Exports this entry to a TIVar with a specified name, header, and target model
Method load_dict Loads this entry 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 supported_by Determines whether a given model can support this entry
Method type_id The type ID of the entry
Method unarchive Unarchives this entry (if supported)
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
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 is_empty Whether this entry's data is empty
Property meta The meta section of this entry
Method __init_subclass__ Undocumented
Constant _T Undocumented
Class Variable _type_ids Undocumented

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

Method load Loads data into an instance by delegating to Loader methods based on the input's type
Class Variable loaders Undocumented
def __init__(self, init=None, *, for_flash: bool = True, name: str = 'Str1', 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

The entry version and archived flag are invalid if for_flash == False.

Parameters
initValues to initialize the entry's data (defaults to None)
for_flash:boolWhether the entry supports flash chips (defaults to True)
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)
@Loader[str]
def load_string(self, string: str, *, model: TIModel = None, lang: str = None, mode: str = None): (source)
overrides tivars.types.tokenized.TokenizedEntry.load_string

Loads this entry from a string representation

For detailed information on tokenization modes, see tivars.tokenizer.encode.

Parameters
string:strThe string to load
model:TIModelThe model to target when encoding (defaults to no specific model)
lang:strThe language used in string (defaults to English, en)
mode:strThe tokenization mode to use (defaults to smart)
@Section(8, TokenizedString)
def name(self, value) -> str: (source)
overrides tivars.var.TIEntry.name

The name of the entry

Must be one of the string names: Str1 - Str0.

def string(self) -> str: (source)
overrides tivars.var.TIEntry.string
Returns
strA string representation of this entry
extensions = (source)
overrides tivars.var.TIEntry.extensions

The file extension used for this entry per-model

leading_name_byte: bytes = (source)
overrides tivars.var.TIEntry.leading_name_byte

Byte that always begins the name of this entry

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

Undocumented