model.model.*

The model contains the core data structures of pyspread and is divided into the following layers.

• Layer 3: CodeArray

• Layer 2: DataArray

• Layer 1: DictGrid

• Layer 0: KeyValueStore

Provides

• DefaultCellAttributeDict

• CellAttribute

• CellAttributes

• KeyValueStore

• DictGrid

• DataArray

• CodeArray

class model.model.CellAttribute(selection: Selection, table: int, attr: AttrDict)

Bases: NamedTuple

Single cell attribute

Create new instance of CellAttribute(selection, table, attr)

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}

_fields = ('selection', 'table', 'attr')

classmethod _make(iterable)

Make a new CellAttribute object from a sequence or iterable

_replace(**kwds)

Return a new CellAttribute object replacing specified fields with new values

attr: AttrDict

Alias for field number 2

selection: Selection

Alias for field number 0

table: int

Alias for field number 1

class model.model.CellAttributes(*args, **kwargs)

Bases: list

Stores cell formatting attributes in a list of CellAttribute instances

The class stores cell attributes as a list of layers. Each layer describes attributes for one selection in one table. Ultimately, a cell’s attributes are determined by going through all elements of an CellAttributes instance. A default AttrDict is updated with the one in the list element if it is relevant for the respective cell. Therefore, attributes are efficiently stored for large sets of cells.

The class provides attribute read access to single cells via __getitem__(). Otherwise it behaves similar to a list.

_attr_cache = {}

_len_table_cache()

Returns the length of the table cache

Return type:

int

_table_cache = {}

_update_table_cache()

Clears and updates the table cache to be in sync with self

append(cell_attribute)

append that clears caches

Parameters:

cell_attribute (CellAttribute) – Cell attribute to be appended

for_table(table)

Return cell attributes for a given table

Return type should be CellAttributes. The list return type is provided because PEP 563 is unavailable in Python 3.6.

Note that the table’s presence in the grid is not checked.

Parameters:

table (int) – Table for which cell attributes are returned

Return type:

list

get_merging_cell(key)

Returns key of cell that merges the cell key

Retuns None if cell key not merged.

Parameters:

key (Tuple[int, int, int]) – Key of the cell that is merged

Return type:

Tuple[int, int, int]

class model.model.CodeArray(shape, settings)

Bases: DataArray

CodeArray provides objects when accessing cells via __getitem__

Cell code can be accessed via function call

This class represents layer 3 of the model.

Parameters:

• shape (Tuple[int, int, int]) – Shape of the grid

• settings (Settings) – Pyspread settings

_eval_cell(key, code)

Evaluates one cell and returns its result

Parameters:

• key (Tuple[int, int, int]) – Key of cell to be evaled

• code (str) – Code to be evaled

Return type:

Any

_get_updated_environment(env_dict=None)

Returns globals environment with ‘magic’ variable

Parameters:

env_dict (dict) – Maps global variable name to value, None: {‘S’: self}

Return type:

dict

_make_nested_list(gen)

Makes nested list from generator for creating numpy.array

Return type:

Union[Sequence, Sequence[Sequence], Sequence[Sequence[Sequence]]]

_sorted_keys(keys, startkey, reverse=False)

Generator that yields sorted keys starting with startkey

Parameters:

• keys (Iterable[Tuple[int, int, int]]) – Key sequence that is sorted

• startkey (Tuple[int, int, int]) – First key to be yielded

• reverse (bool) – Sort direction reversed if True

Return type:

Iterable[Tuple[int, int, int]]

clear_globals()

Clears all newly assigned globals

exec_then_eval(code, _globals=None, _locals=None)

execs multiline code and returns eval of last code line

Parameters:

• code (str) – Code to be executed / evaled

• _globals (dict) – Globals dict for code execution and eval

• _locals (dict) – Locals dict for code execution and eval

execute_macros()

Executes all macros and returns result string and error string

Executes macros only when not in safe_mode

Return type:

Tuple[str, str]

findnextmatch(startkey, find_string, up=False, word=False, case=False, regexp=False, results=True)

Returns tuple with position of the next match of find_string or None

Parameters:

• startkey (Tuple[int, int, int]) – Start position of search

• find_string (str) – String to be searched for

• up (bool) – Search up instead of down if True

• word (bool) – Search full words only if True

• case (bool) – Search case sensitively if True

• regexp (bool) – Regular expression search if True

• results (bool) – Search includes result string if True (slower)

Return type:

Tuple[int, int, int]

frozen_cache = {}

get_globals()

Returns globals dict

Return type:

dict

handler(signum, frame)

Signal handler for timeout

Parameters:

• signum (Any) – Ignored

• frame (Any) – Ignored

pop(key)

pop with cache support

Parameters:

key (Tuple[int, int, int]) – Cell key that shall be popped

reload_modules()

Reloads modules that are available in cells

result_cache = {}

safe_mode = False

string_match(datastring, findstring, word, case, regexp)

Returns position of findstring in datastring or None if not found

Parameters:

• datastring (str) – String to be searched

• findstring (str) – Search string

• word (bool) – Search full words only if True

• case (bool) – Search case sensitively if True

• regexp (bool) – Regular expression search if True

Return type:

int

class model.model.DataArray(shape, settings)

Bases: object

DataArray provides enhanced grid read/write access.

Enhancements comprise:

• Slicing

• Multi-dimensional operations such as insertion and deletion along one axis

This class represents layer 2 of the model.

Parameters:

• shape (Tuple[int, int, int]) – Shape of the grid

• settings (Settings) – Pyspread settings

_adjust_cell_attributes(insertion_point, no_to_insert, axis, tab=None, cell_attrs=None)

Adjusts cell attributes on insertion/deletion

Parameters:

• insertion_point (int) – Point on axis at which insertion takes place

• no_to_insert (int) – Number of rows/cols/tabs to be inserted (>=0)

• axis (int) – Row insertion if 0, column insertion if 1, must be in 0, 1

• tab (int) – Table at which insertion takes place, None means all tables

• cell_attrs (AttrDict) – If given replaces the existing cell attributes

_adjust_merge_area(attrs, insertion_point, no_to_insert, axis)

Returns an updated merge area

Parameters:

• attrs (AttrDict) – Cell attribute dictionary that shall be adjusted

• insertion_point (int) – Point on axis at which insertion takes place

• no_to_insert (int) – Number of rows/cols/tabs to be inserted (>=0)

• axis (int) – Row insertion if 0, column insertion if 1, must be in 0, 1

Return type:

Tuple[int, int, int, int]

_adjust_rowcol(insertion_point, no_to_insert, axis, tab=None)

Adjusts row and column sizes on insertion/deletion

Parameters:

• insertion_point (int) – Point on axis at which insertion takes place

• no_to_insert (int) – Number of rows or columns that are inserted

• axis (int) – Row insertion if 0, column insertion if 1, must be in 0, 1

• tab (int) – Table at which insertion takes place, None means all tables

_shift_rowcol(insertion_point, no_to_insert)

Shifts row and column sizes when a table is inserted or deleted

Parameters:

• insertion_point (int) – Table at which a new table is inserted

• no_to_insert (int) – Number of tables that are inserted

cell_array_generator(key)

Generator traversing cells specified in key

Yields cells’ contents.

Parameters:

key (Tuple[Union[int, slice], Union[int, slice], Union[int, slice]]) – Specifies the cell keys of the generator

Return type:

Iterable[str]

property cell_attributes: CellAttributes

cell_attributes interface to dict_grid

property col_widths: defaultdict

col_widths interface to dict_grid

property data: dict

Returns dict of data content.

• Data is the central content interface for loading / saving data.

• It shall be used for loading and saving from and to .pys and other files.

• It shall be used for loading and saving macros.

• However, it is not used for importing and exporting data because these operations are partial to the grid.

Content of returned dict

Parameters:

• shape (Tuple[int, int, int]) – Grid shape

• grid (Dict[Tuple[int, int, int], str]) – Cell content

• attributes (CellAttribute) – Cell attributes

• row_heights (defaultdict[Tuple[int, int], float]) – Row heights

• col_widths (defaultdict[Tuple[int, int], float]) – Column widths

• macros (str) – Macros

delete(deletion_point, no_to_delete, axis, tab=None)

Deletes no_to_delete rows/cols/… starting with deletion_point

Parameters:

• deletion_point (int) – Point on axis at which deletion takes place

• no_to_delete (int) – Number of rows/cols/tabs to be deleted (>=0)

• axis (int) – Row/Column/Table deletion if 0/1/2, must be in 0, 1, 2

• tab (int) – Table at which insertion takes place, None means all tables

get_col_width(col, tab)

Returns column width

Parameters:

• col (int) – Column for which width is retrieved

• tab (int) – Table for which for which column width is retrieved

Return type:

float

get_last_filled_cell(table=None)

Returns key for the bottommost rightmost cell with content

Parameters:

table (int) – Limit search to this table

Return type:

Tuple[int, int, int]

get_row_height(row, tab)

Returns row height

Parameters:

• row (int) – Row for which height is retrieved

• tab (int) – Table for which for which row height is retrieved

Return type:

float

insert(insertion_point, no_to_insert, axis, tab=None)

Inserts no_to_insert rows/cols/tabs/… before insertion_point

Parameters:

• insertion_point (int) – Point on axis at which insertion takes place

• no_to_insert (int) – Number of rows/cols/tabs to be inserted (>=0)

• axis (int) – Row/Column/Table insertion if 0/1/2 must be in 0, 1, 2

• tab (int) – Table at which insertion takes place, None means all tables

keys()

Returns keys in self.dict_grid

Return type:

List[Tuple[int, int, int]]

property macros: str

macros interface to dict_grid

pop(key)

dict_grid pop wrapper

Parameters:

key (Tuple[int, int, int]) – Cell key

Return type:

Any

property row_heights: defaultdict

row_heights interface to dict_grid

set_col_width(col, tab, width)

Sets column width

Parameters:

• col (int) – Column for width setting

• tab (int) – Table, in which column width is set

• width (float) – Column width to be set

set_row_height(row, tab, height)

Sets row height

Parameters:

• row (int) – Row for height setting

• tab (int) – Table, in which row height is set

• height (float) – Row height to be set

property shape: Tuple[int, int, int]

Returns dict_grid shape

class model.model.DefaultCellAttributeDict

Bases: AttrDict

Holds default values for all cell attributes

class model.model.DictGrid(shape)

Bases: KeyValueStore

Core data class with all information that is stored in a .pys file.

Besides grid code access via standard dict operations, it provides the following attributes:

• cell_attributes - Stores cell formatting attributes

• macros - String of all macros

This class represents layer 1 of the model.

Parameters:

shape (Tuple[int, int, int]) – Shape of the grid

class model.model.KeyValueStore(default_value=None)

Bases: dict

Key-Value store in memory. Currently a dict with default value None.

This class represents layer 0 of the model.

Parameters:

default_value – Value that is provided for missing keys