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_computed_fields`	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`model_fields`	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

Methods Summary

`from_parsed`(value[, references])	Construct a definition object from pre-standardized content.
`standardize`()	Standardize the xref.

Attributes Documentation

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'references': FieldInfo(annotation=Union[List[curies.api.Reference], NoneType], required=False), 'standardized': FieldInfo(annotation=bool, required=False, default=False, exclude=True), 'value': FieldInfo(annotation=Union[str, NoneType], required=False, alias='val', alias_priority=2), 'xrefs_raw': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='xrefs', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Methods Documentation

classmethod from_parsed(value: str, references: List[Reference] | None = None) → Definition[source]: Construct a definition object from pre-standardized content.

standardize() → Self[source]: Standardize the xref.