Skip to main content

Models

Node​

Node(id, kind, qualified_name, name,
     file_path=None, span=None, metadata=None)

See Nodes for what each field means.

NodeKind​

An enum with a string value, so NodeKind.FUNCTION.value == "function".

PROJECT  MODULE  FILE  CLASS  FUNCTION  METHOD  VARIABLE
ATTRIBUTE  PARAMETER  TYPE_ALIAS  IMPORT  EXTERNAL_SYMBOL
DEPENDENCY  BOUNDARY

NodeKind.from_value(value) converts back from a string and raises ValueError on an unknown one. RelationKind has the same pair.

Relation​

Relation(source_id, target_id, kind, metadata=None)

RelationKind​

CONTAINS  DECLARES  IMPORTS  RESOLVES_TO  DEPENDS_ON
CALLS  REFERENCES  HAS_TYPE  INHERITS_FROM
EXPOSES  CONSUMES  COMMUNICATES_WITH

Span​

Span(start_line, start_col, end_line, end_col)   # all 1-based
span.contains(line, col)

ResolvedRef​

What a resolver returns for one position.

ResolvedRef(full_name, file_path, line, col, kind, origin)

origin is internal, stdlib, third_party or unknown. Only internal sends the edge to a node in the graph; the rest produce an EXTERNAL_SYMBOL.

OccurrenceRef​

A use-site waiting to be resolved.

OccurrenceRef(role, line, col, enclosing_id, span)

role is call, read, write, annotation or base.

ResolverStatus​

OK, DEGRADED, UNAVAILABLE. Stored in graph metadata as a string, and merged to the worst of the two when graphs are combined.

UNAVAILABLE means resolution did not run or the backend could not answer; DEGRADED means it ran and answered partially, which is the best PHP, C and C++ report. YamlAdapter reports OK with zero queries, because a YAML document has no symbols to resolve — see Resolvers.

ResolverMetrics​

metrics.queries      # positions handed to the resolver
metrics.resolved     # answers that came back
metrics.internal     # bound to a node in the graph
metrics.external     # became an EXTERNAL_SYMBOL
metrics.unresolved   # no answer
metrics.seconds
metrics.resolved_pct

GraphDiff​

diff.added_nodes, diff.removed_nodes, diff.changed_nodes
diff.added_relations, diff.removed_relations
diff.is_empty

changed_nodes holds (old, new) pairs.

SpanIndex​

Maps a source position back to a graph node. Built from a graph, queried during resolution.

index = SpanIndex.from_graph(graph)
index.at(file_path, line, col)          # by name span
index.enclosing(file_path, line, col)   # by full extent