neurocarto.views.record

Recording actions, store and replay.

Warning

It is an experimental feature.

class neurocarto.views.record.RecordManager

Record history manger.

Warning

It is an experimental feature.

History file

use ‘history.json’ under cache folder (#user_cache_file()).

If --debug, use .neurocarto.history.json at current working directory.

History json

{
  "name": {
    "frozen": false,
    "steps": [
      {
        "source": "RecordView", // any RecordView[R]
        "time_stamp": 0, // unix_time
        "category": "category",
        "description": "description",
        "record": :attr:`.None` // R
      }
    ]
  }
}
__init__(app, config)
Parameters:
list_history_names()
Return type:

list[str]

property history: NamedHistory
has_history(name)

Does history name exist?

Parameters:

name (str)

Return type:

bool

get_history(name)
Parameters:

name (str) – history name.

Returns:

Raises:

KeyError – history name does not exist.

Return type:

NamedHistory

clear_history(name=None)

Clear history and remove it.

Do nothing if this history is frozen.

Parameters:

name (str | None) – history name.

Returns:

cleared and removed.

Return type:

bool

register(view)

Register a RecordView to be managed.

Parameters:

view (RecordView)

unregister(view)
Parameters:

view (RecordView)

replay(name=None, *, reset=False, index=None)

replay history.

Parameters:

  • name (str | None) – history name

  • reset – Is it a reset replay?

  • index (list[int] | None) – only replay steps on given index.

Raises:

KeyError – history name not exist.

get_history_file()
Return type:

Path

load_history(file=None, *, reset=False)

load histories from file.

Parameters:

  • file (str | Path | None) – history json file.

  • reset – reset history. Otherwise, update it.

Raises:

FileNotFoundError – history file does not exist

See:

get_history_file()

save_history(file=None)

save histories into file.

Parameters:

file (str | Path | None) – history json file.

Raises:

FileExistsError – when the file is a directory.

See:

get_history_file()

class neurocarto.views.record.HistoryView

History viewer, supporting viewing, filtering and replaying.

Warning

It is an experimental feature.

__init__(config)
Parameters:

config (CartoConfig)

history_step_data: ColumnDataSource
history_step_view: CDSView
property name: str

view name

load_history()

load history.

See:

RecordManager. load_history()

save_history()

save history.

See:

RecordManager. save_history()

on_add_record(record)
Parameters:

record (RecordStep)

update_history_table()
history_step_table: DataTable
source_filter: TextInput
category_filter: TextInput
disable_toggle: Toggle
description_filter: TextInput
save_input: AutocompleteInput
delete_btn: Button
clear_btn: Button
on_replay()
on_delete()
on_clear()
start()

Invoked when figure is ready.