trame

From v1 to v2

Trame v2 has arrived, introducing several breaking changes. Some features of trame v1 have been removed but in general the migration is straightforward by tweaking imports and variables definitions. The following example code shows how v1 code is implemented in v2.

Main code change

Before

from trame import state, controller
from trame.layouts import SinglePage
from trame.html import vuetify, Div

[...]

tab_title = "Hello world"
layout = SinglePage(tab_title, on_ready=_fn)

[...]

if __name__ == "__main__":
    layout.start()

After

from trame.app import get_server
from trame.ui.vuetify import SinglePageLayout
from trame.widgets import vuetify, html

server = get_server()
state, ctrl = server.state, server.controller

[...]

tab_title = "Hello world"
state.trame__title = tab_title
ctrl.on_server_ready.add(_fn)

with SinglePageLayout(server) as layout:
    html.Div("Hello")

[...]

if __name__ == "__main__":
    server.start()

Command Line Interface parser

Before

from trame import get_cli_parser

parser = get_cli_parser()

After

from trame.app import get_server

server = get_server()
parser = server.cli

Client side download util

Before

vuetify.VBtn(
    "Download",
    click="download('my_file_name.csv', file_content, 'text/csv')",
)

After

vuetify.VBtn(
    "Download",
    click="utils.download('my_file_name.csv', file_content, 'text/csv')",
)

All the client helper functions are now nested under a utils.* namespace object to allow better extensibility and prevent possible state variables conflict.

Busy

The state variable busy has been renamed to trame__busy.

StateChange => ClientStateChange

Before

from trame.html import StateChange

StateChange("var_name", change=fn_)

After

from trame.widgets.trame import ClientStateChange


ClientStateChange(value="var_name", change=fn_)

Triggers

Before

layout.triggers.add("mounted", "pixel_ratio = window.devicePixelRatio")

After

with layout:
    trame.ClientTriggers(
        mounted="pixel_ratio = window.devicePixelRatio",
        created=_fn,
        ...
    )

Size Observer

Before

from trame.html import observer

observer.SizeObserver(...)

After

from trame.widgets import trame

trame.SizeObserver(...)

Remote files

Before

from trame import RemoteFile

dataset_file = RemoteFile(
    "./data/disk_out_ref.vtu",
    "https://github.com/Kitware/trame/raw/master/examples/data/disk_out_ref.vtu",
    __file__,
)

After

from trame.assets.remote import HttpFile

dataset_file = HttpFile(
    "./data/disk_out_ref.vtu",
    "https://github.com/Kitware/trame/raw/master/examples/data/disk_out_ref.vtu",
    __file__,
)