pwrs.corex.types

Shared type vocabulary for the MATPOWER-compatible core.

The MATLAB interface accepts many array-like values and dynamic structs. The aliases in this module describe the normalized values used inside the Python implementation, while the public compatibility functions may still accept npt.ArrayLike or mapping values and normalize them at their boundary.

class pwrs.corex.types.SparseMatrix(*args, **kwargs)

Bases: Protocol

Typed subset of the SciPy sparse matrix API used by core.

SciPy 1.15 does not ship complete type information for sparse matrices. Keeping this protocol local prevents that missing information from turning every downstream matrix expression into Any.

class pwrs.corex.types.BasicCaseData

Bases: TypedDict

Required fields available on an internal MATPOWER case mapping.

class pwrs.corex.types.CaseData

Bases: BasicCaseData

Optional fields commonly added during MATPOWER processing.

class pwrs.corex.types.RequiredResultFields

Bases: BasicCaseData

Fields present on every completed PF/OPF result.

class pwrs.corex.types.InternalResultData

Bases: RequiredResultFields

Mutable result builder used before public result normalization.

class pwrs.corex.types.EventData

Bases: TypedDict

Dynamic event record used by CPF event detection and callbacks.

class pwrs.corex.types.DoneData

Bases: TypedDict