Skip to content

v0.2.0

Choose a tag to compare

@mtravaillard mtravaillard released this 06 Nov 14:13
· 6 commits to main since this release

xactflow-archidesc v0.2.0

This release moves xactflow-archidesc to ipxact-compiler 0.2.0 and XactFlow 0.3.0, makes
connect_bus() follow more of the IEEE 1685-2022 connection rules, and fixes the importer when
several scripts are run in one process. It contains breaking changes: see "Upgrading" below.

ipxact-compiler 0.2.0 and XactFlow 0.3.0

xactflow-archidesc now requires ipxact-compiler>=0.2.0 and xactflow>=0.3.0. The parameter
overrides given to add_ip() are recorded as ipxact.Expression objects in
component_ref.config_element_values.

Bus connections (#1, #5)

  • connect_bus() accepts two bus definitions when one extends the other, directly or not, as
    link() already did (SCR 2.2) (#5).
  • A system and a mirrored-system interface are only connected when their group is the same
    (SCR 2.13). Otherwise the error says their system groups differ (#1).
  • A monitor of a system or mirrored-system interface needs the same group as the interface it
    watches (SCR 4.4).

Parameter values (#7)

add_ip() raises ValueError for a parameter value that is not a usable expression: an empty or
blank string, or a float that is not finite (nan, inf).

Importer (#2)

The modules a script imports from its own folder (a helpers.py next to it, for example) are
forgotten once the script has run. A second script in another folder no longer gets the first
script's helpers. Packages installed below the script's folder, in a .venv for example, are
left alone. If the script fails, its own error is the one raised.

Type hints (#6)

The package ships py.typed, and its type hints now pass mypy. CI runs mypy on every supported
Python version.

Documentation (#3, #4)

  • The .tex format description uses link() instead of elaborate(), like the .md (#3).
  • The worked example of the format description names the interconnect ports, so it no longer
    fails with "more than one possible pair", and its interconnect VLNV has all four fields (#4).
  • The format description and the README describe the new connection rules.

Upgrading

  • ipxact-compiler>=0.2.0 and xactflow>=0.3.0 are required. See their release notes for their
    own breaking changes.
  • config_element_values holds ipxact.Expression objects instead of strings. Use .value to
    get the text.
  • connect_bus() now refuses connections it used to accept: a system and a mirrored-system
    interface with different groups, and a monitor whose group differs from the system interface
    it watches.
  • add_ip() now refuses empty, blank and non-finite parameter values.
  • With xactflow-design 0.2.0, the exported design file is named
    <vendor>_<library>_<name>_<version>.xml, for example example.org_soc_example_0.1.xml.

Full Changelog: v0.1.1...v0.2.0