Definition

class Definition(*, val: str | None = None, xrefs: list[str] | None = None, references: list[Reference] | None = None, standardized: bool = False)[source]

Bases: BaseModel

Represents a definition for a node.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes Summary

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Summary

from_parsed(value[, references])

Construct a definition object from pre-standardized content.

standardize()

Standardize the xref.

Attributes Documentation

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Documentation

classmethod from_parsed(value: str | None, references: list[Reference] | None = None) Definition[source]

Construct a definition object from pre-standardized content.

standardize() Self[source]

Standardize the xref.