parse_switchmatrix¶

Parser functions for switch matrix and list file configurations.

This module provides utilities for parsing switch matrix CSV files and list files used in fabric definition. It handles expansion of port definitions, connection mappings, and validation of port configurations.

Functions¶

`expandListPorts`(port)	Expand the .list file entry into a list of port strings.
`parseList`(…)	Parse a list file and expand the list file information into a list of tuples.
`parseMatrix`(fileName[, preserve_list_order])	Parse the matrix CSV into a dictionary from destination to source.

Module Contents¶

expandListPorts(port) → list[str][source]¶

Expand the .list file entry into a list of port strings.

Parameters:: port (str) – The port entry to expand. If it contains “[”, it’s split into multiple entries based on “|”.
Raises:: ValueError – If the port entry contains “[” or “{” without matching closing bracket “]”/”}”.
Returns:: The expanded list of port strings.

parseList(filePath: Path, collect: Literal['pair'] = 'pair') → list[tuple[str, str]][source]¶

parseList(filePath: Path, collect: Literal['source', 'sink']) → dict[str, list[str]]

Parse a list file and expand the list file information into a list of tuples.

Parameters:

filePath (Path) – The path to the list file to parse.
collect (Literal["pair", "source", "sink"], optional) – Collect value by source, sink or just as (source, sink) pair. Defaults to “pair”.

Raises:

FileNotFoundError – The file does not exist.
InvalidListFileDefinition – Invalid format in the list file.

Returns:

Return either a list of connection pairs or a dictionary of lists which is collected by the specified option, source or sink.

parseMatrix(fileName, preserve_list_order=False) → dict[str, list[str]][source]¶

Parse the matrix CSV into a dictionary from destination to source.

A non-zero cell denotes a configurable connection. When preserve_list_order is set, the cell’s integer encodes the mux input position (higher = earlier, MSB-first) and that order is kept; when unset, every connection is treated as a plain 1 so the inputs fall back to CSV-column order (legacy behaviour). Both sort by (-value, column).

The top-left header cell is a label only (conventionally the tile name) and is not validated: the mux-input columns are header[1:].

Parameters:

fileName (Path) – Directory of the matrix CSV file.
preserve_list_order (bool, optional) – Keep the cell-encoded mux-input order when True; otherwise treat every connection as 1 and use CSV-column order. Defaults to False.

Raises:

InvalidSwitchMatrixDefinition – A non-integer cell value in a row.

Returns:

Dictionary from destination to a list of sources.