Graph

matchbox.common.graph

Common data structures for resolution graphs.

Classes:

• ResolutionNodeType –

  Types of nodes in a resolution.

• ResolutionNode –

  A node in a resolution graph.

• ResolutionEdge –

  An edge in a resolution graph.

• ResolutionGraph –

  A directed graph of resolution nodes and edges.

Attributes:

• SourceResolutionName (TypeAlias) –

  Type alias for source resolution names.

• ModelResolutionName (TypeAlias) –

  Type alias for model resolution names.

• ResolutionName –

  Type alias for resolution names.

• DEFAULT_RESOLUTION (ResolutionName) –

SourceResolutionName module-attribute

SourceResolutionName: TypeAlias = str

Type alias for source resolution names.

ModelResolutionName module-attribute

ModelResolutionName: TypeAlias = str

Type alias for model resolution names.

ResolutionName module-attribute

ResolutionName = SourceResolutionName | ModelResolutionName

Type alias for resolution names.

DEFAULT_RESOLUTION module-attribute

DEFAULT_RESOLUTION: ResolutionName = '__DEFAULT__'

ResolutionNodeType

Bases: StrEnum

Types of nodes in a resolution.

Attributes:

• SOURCE –
• MODEL –
• HUMAN –

SOURCE class-attribute instance-attribute

SOURCE = 'source'

MODEL class-attribute instance-attribute

MODEL = 'model'

HUMAN class-attribute instance-attribute

HUMAN = 'human'

ResolutionNode

Bases: BaseModel

A node in a resolution graph.

Attributes:

• id (int) –
• name (ResolutionName) –
• type (ResolutionNodeType) –

id instance-attribute

id: int

name instance-attribute

name: ResolutionName

type instance-attribute

type: ResolutionNodeType

ResolutionEdge

Bases: BaseModel

An edge in a resolution graph.

Attributes:

• parent (int) –
• child (int) –

parent instance-attribute

parent: int

child instance-attribute

child: int

ResolutionGraph

Bases: BaseModel

A directed graph of resolution nodes and edges.

Methods:

• to_rx –

  Convert the resolution graph to a rustworkx directed graph.

Attributes:

• nodes (set[ResolutionNode]) –
• edges (set[ResolutionEdge]) –

nodes instance-attribute

nodes: set[ResolutionNode]

edges instance-attribute

edges: set[ResolutionEdge]

to_rx

to_rx() -> PyDiGraph

Convert the resolution graph to a rustworkx directed graph.