tivars 1.0.0

A library for interacting with TI-(e)z80 (82/83/84 series) calculator files

tivars_lib_py

tivars_lib_py is a Python package for interacting with TI-(e)z80 (82/83/84 series) calculator files, i.e. lists, programs, matrices, appvars, etc.

Much of the functionality of this package has been ported over from tivars_lib_cpp. However, a number of changes have been made to the API to better suit Python's strengths and capabilities as a language (e.g. scripting, dynamic typing).

• Installation
  • As a Package
  • As a Submodule
  • Unit Testing
• How to Use
  • Entries
  • Vars & Headers
  • Other Files
  • Models
• Documentation
  • API
  • Formatting Output
• Other Functionalities
  • PIL
  • Tokenization
• Examples

Installation

The current release version is v0.9.2. All versions require Python 3.10+ to run.

As a Package

Install the tivars package from PyPI using pip:

pip install tivars

Alternatively, you can clone this repository or download a release and extract the tivars directory to include it in your next project. Once downloaded, you can also use pip to install it locally.

[!IMPORTANT] When cloning, use the --recursive or --recurse-submodules flag to fetch all submodule dependencies. The GitHub ZIP download does not include submodules.

As a Submodule

Include this repository in your next project as a submodule using the git submodule command. Then, add the following to any file which imports tivars:

import sys

sys.path.insert(1, 'tivars_lib_py/')

Check out this tool for an example.

Unit Testing

You can run the test suite via __main__.py, or run individual tests found in tests/ with unittest. Tests for optional package extensions (e.g. PIL) will be skipped if the package cannot be found.

[!WARNING] The PyPI distribution does not include the test suite.

How to Use

Every var file has two parts: a header and a number of entries, where a single entry contains the data for a single variable.

Most var files you might encounter in the wild or need to create programmatically contain just one entry holding all relevant variable data, so the library provides a convenient interface for loading, manipulating, and saving entries by themselves.

[!TIP] If you do need to mess about with headers or entire files at once (including flash files), head down to the Vars & Headers section.

Entries

Creating entries

To create an empty entry, instantiate its corresponding type from tivars.types. You can specify additional parameters as you like:

from tivars.models import *
from tivars.types import *

my_program = TIProgram(name="HELLO")

[!TIP] If you're not sure of an entry's type, you can instantiate a base TIEntry.

Loading entries

Entries can be loaded from files or raw bytes. When loading from a file, you may specify which entry to load if there are multiple:

# Raises an error if the var has multiple entries
my_program = TIProgram.open("HELLO.8xp")

with open("HELLO.8xp", 'rb') as file:
    # Offset counts the number of entries to skip; defaults to zero
    my_program.load_from_file(file, offset=1)
    
    file.seek(0)
    my_program.load_bytes(file.read())

[!IMPORTANT] When loading from a file object, make sure the file is opened in binary mode.

Most entry types also support loading from other natural data types. Any data can be passed to the constructor directly and be delegated to the correct loader:

my_program = TIProgram("Disp \"HELLO WORLD!\"")
my_program.load_string("Disp \"HELLO WORLD!\"")

my_real = TIReal(1.23)
my_real.load_float(1.23)

Base TIEntry objects, as well other parent types like TIGDB, will be automatically coerced to the correct type:

# Coerces to a TIProgram
my_entry = TIEntry.open("HELLO.8xp")

[!TIP] Any entry type can be cast to any other by setting the object's __class__.

Exporting entries

Entries can be saved directly to a file:

my_program.save("HELLO.8xp")

# Infer the filename and extension
my_program.save()

# Target the TI-83+
my_program.save("HELLO.8xp", model=TI_83P)

[!IMPORTANT] .save() uses the var's name as the filename, saving to the current working directory.

To package an entry into a var file, use .export:

my_var = my_program.export()

# This is just the entry's data
my_program.bytes()

# This is a complete var file
my_var.bytes()

You can also export entries to any of their input data types:

assert my_program.string() == "Disp \"HELLO WORLD!\""

assert my_real.float() == 1.23

[!TIP] Built-in types can be exported to using the standard constructors, e.g. str(my_program).

Data sections

Entries are comprised of individual sections which represent different forms of data. You can read and write to individual sections of an entry as their "canonical" type:

my_program.named = "MYGAME"
my_program.archived = True

assert my_program.type_id == 0x05

Data sections can also be other entry types:

my_gdb = TIGDB()
my_gdb.Xmin = TIReal(0)

assert my_gdb.Xmax == TIReal(10)

Each section is annotated with the expected type.

[!TIP] Data sections can accept any subtype of their expected type.

Raw containers

All entries store their data sections as raw bytes in the format interpreted by the calculator. Access any data section as a member of the .raw attribute to view and edit these bytes directly.

my_header.raw.name = "MYGAME".encode('utf-8')
my_program.raw.archived = b'\x80'

assert my_program.raw.type_id == b'\x05'

Vars & Headers

If you want to create an entire var or just a header, use TIVarFile or TIHeader:

from tivars.var import *

my_var = TIVarFile()
my_var_for84pce = TIVarFile(model=TI_84PCE)

my_header = TIHeader()
my_header_with_a_cool_comment = TIHeader(comment="Wow! I'm a comment!")

Vars can be loaded from files or raw bytes:

my_var = TIVar.open("HELLO.8xp")

with open("HELLO.8xp", 'rb') as file:
    my_var.load_var_file(file)
    
    file.seek(0)
    my_var.load_bytes(file.read())

An entry can be exported to a var, with an optional attached header; likewise, a var is made up of its header and entries:

my_var = my_program.export(header=my_header)

assert my_header == my_var.header
assert my_program == my_var.entries[0]

Pipe syntax is supported for forming a var with multiple entries:

my_big_var = TIHeader(comment="muy grande") | [TIEntry(name="A"), TIEntry(name="B")]

Export a var as bytes or straight to a file:

my_var.save("HELLO.8xp")
my_var.save()

with open("HELLO.8xp", 'wb+') as file:
    file.write(my_var.bytes())

Vars and headers, like entries, are composed of data sections, and contain packaging metadata not found in entries, such as the total entry length and file checksum.

[!WARNING] Edits to read-only bytes like the checksum are reset whenever any other data in the var is updated.

Other Files

Flash Files

Flash files such as apps, OSes, and certificates can be loaded using the TIFlashHeader base class or its children. A flash file is composed of one to three headers (though usually only one); these are not to be confused with var headers.

A flash header does not need to be "packaged" into a larger file format like an entry in a regular var; see TIFlashHeader.open and TIFlashHeader.save. If you do want to stitch multiple together, though, or need to load a source with multiple headers, use a TIFlashFile.

[!TIP] Loading flash files into a TIEntry probably won't work very well.

Bundles

Bundles can be loaded and unpacked using the TIBundle type.

Generic Loaders

All file types are children of the TIFile base type, and entries and flash headers are children of the TIComponent type. Use either of these to load files or portions thereof whose identities are completely unknown to you, and they will be coerced to the correct type. Methods such as TIComponent.get_type can additionally be used to identify unknown files from partial information, such as a file extension, without delegating to the type handlers.

Models

All TI-82/83/84 series calcs are represented as TIModel objects stored in tivars.models. Each model contains its name, metadata, and features; use has on a TIFeature to check that a model has a given a feature. Models are also used to determine var file extensions and token sheets (see Tokenization).

Documentation

API

Library documentation can be found on GitHub Pages.

The var file format(s) and data sections can be found in a readable format on the repository wiki. Much of the information is copied from the TI-83 Link Guide, though has been updated to account for color models.

[!NOTE] The wiki is still a work-in-progress. Why not contribute a page?

Formatting Output

All entry types support string formatting using Python's f-strings.

• All entries support hex formatting of their data: {width}?{case}{sep}?
  • width: how many digits to group together; negative values group from the end (default: no groups)
  • case: the case of the hex digits
    • x: lowercase
    • X: uppercase
  • sep: a single character to separate groups of hex digits (default: none)
• Tokenized entries support formatting of their tokens into readable lines: {line_spec}?{sep}?{type}{lang}?
  • line_spec: format specifier for line numbers (default: no line numbers)
  • sep: a string to separate lines and line numbers (required for line numbering)
  • type: how to format each token
    • a: use accessible names
    • d: use display names (default)
  • lang: language code of the desired translation language (default: en)
• Numerical entries support float-style formatting, whose complete details can be found in the Python docs.
• Lists and matrices support float-style formatting, applied to their elements.

Additionally, the t type is supported for types which can be made from tokens, composing the object out of typeable (accessible) token names. For example, -2 + 5i is presented as ~2+5[i].

Other Functionalities

PIL

The tivars.PIL package can be used to interface with PIL, the Python Imaging Library. Simply import the package to register codecs for each of the TI image types. You can then open such images directly into a PIL Image:

from PIL import Image
from tivars.PIL import *

img = Image.open("Pic1.8ci")
img.show()

Tokenization

Functions to transcode between strings and TI-BASIC tokens can be found in tivars.tokenizer. These functions utilize the TI-Toolkit token sheets, which are kept as a submodule in tivars.tokens. Support currently exists for all models in the 82/83/84 series; PR's concerning the sheets themselves should be directed upstream.

These functions operate on sequences of TIToken objects, which store relevant translation and transcoding information. TIModel instances (see Models) track a TITokens container of all tokens available on that model and a TITokenTrie for encoding those tokens.

[!TIP] If you find yourself holding an IllegalToken after decoding, the source program is either malformed, not written in TI-BASIC, or engaging in deep shenanigans.

Examples

You can find more sample code in examples that details common operations on each of the entry types. There are also examples for interfacing with popular external libraries (e.g. NumPy, PIL). Contributions welcome!