Entities

The entities in the yace Interface Definition are enherit the Entity and mix-in common attributes.

• Base-classes: Entity / Typespec

• Mixin-attributes: Named / Documented / Typed

The above are defined below.

class yace.ir.base.Docstring(*, brief: str, description: str, tags: Dict[str, Dict[str, str]])

An enrichment of a raw-comment-text

The raw comment-text is parsed into the components of brief, description, and tags.

brief: str

description: str

classmethod from_cursor(cursor)

model_config: ClassVar[ConfigDict] = {}

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

tags: Dict[str, Dict[str, str]]

class yace.ir.base.Documented(*, doc: Docstring)

Attribute-mixin; adding a required ‘doc’ describing the Entity

doc: Docstring

model_config: ClassVar[ConfigDict] = {}

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

class yace.ir.base.Entity(*, key: str, ant: dict | None = <factory>)

A baseclass for all entities in the Yace Interface Definition Language.

• label; list of labels

• annotations; User-defined annotations of any kind

ant: dict | None

key: str

model_config: ClassVar[ConfigDict] = {}

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

class yace.ir.base.Named(*, sym: str)

Attribute-mixin; adding a required ‘sym’ to be used as identifier

is_valid_sym()

Check whether the symbol is a valid C identifier

model_config: ClassVar[ConfigDict] = {}

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

sym: str