RegisterFile

class RegisterFile(data: RegisterData = <cfinterface.data.registerdata.RegisterData object>)[source]

Class that models a file divided by registers, where the reading and writing are given by a series of registers.

classmethod read(content: str | bytes, *args: Any, version: str | None = None, **kwargs: Any) RegisterFile[source]

Read from a file path or buffer. version selects a component set from VERSIONS without mutating the class.

classmethod read_many(paths: list[str], *, version: str | None = None) dict[str, RegisterFile][source]

Read multiple files and return a dict keyed by file path.

Parameters:
pathslist[str]

File paths to read.

versionstr or None, optional

Version key passed to read(). Defaults to None.

Returns:
dict[str, RegisterFile]

Mapping from each file path to its parsed RegisterFile instance.

classmethod set_version(v: str) None[source]

Set the active register set for the given version key.

Resolves to the latest available version <= v, so an out-of-range key falls back to the nearest known version.

Deprecated since version Use: read(content, version="...") instead.

validate(version: str | None = None, threshold: float = 0.5) VersionMatchResult[source]

Validate parsed data against expected component types.