Skip to content

rules

__all__ = ['BaseRule', 'JsonSchemaRule', 'Rule', 'Ruleset'] module-attribute

BaseRule

Bases: ABC, SerializableMixin

Source code in griptape/rules/base_rule.py 
11
12
13
14
15
16
17
18
19
20
@define()
class BaseRule(ABC, SerializableMixin):
    value: Any = field(metadata={"serializable": True})
    meta: dict[str, Any] = field(factory=dict, kw_only=True)

    def __str__(self) -> str:
        return self.to_text()

    @abstractmethod
    def to_text(self) -> str: ...

meta = field(factory=dict, kw_only=True) class-attribute instance-attribute

value = field(metadata={'serializable': True}) class-attribute instance-attribute

__str__()

Source code in griptape/rules/base_rule.py 
16
17
def __str__(self) -> str:
    return self.to_text()

to_text() abstractmethod

Source code in griptape/rules/base_rule.py 
19
20
@abstractmethod
def to_text(self) -> str: ...

JsonSchemaRule

Bases: BaseRule

Source code in griptape/rules/json_schema_rule.py 
11
12
13
14
15
16
17
@define()
class JsonSchemaRule(BaseRule):
    value: dict = field(metadata={"serializable": True})
    generate_template: J2 = field(default=Factory(lambda: J2("rules/json_schema.j2")))

    def to_text(self) -> str:
        return self.generate_template.render(json_schema=json.dumps(self.value))

generate_template = field(default=Factory(lambda: J2('rules/json_schema.j2'))) class-attribute instance-attribute

value = field(metadata={'serializable': True}) class-attribute instance-attribute

to_text()

Source code in griptape/rules/json_schema_rule.py 
16
17
def to_text(self) -> str:
    return self.generate_template.render(json_schema=json.dumps(self.value))

Rule

Bases: BaseRule

Source code in griptape/rules/rule.py 
 8
 9
10
11
12
13
@define()
class Rule(BaseRule):
    value: str = field(metadata={"serializable": True})

    def to_text(self) -> str:
        return self.value

value = field(metadata={'serializable': True}) class-attribute instance-attribute

to_text()

Source code in griptape/rules/rule.py 
12
13
def to_text(self) -> str:
    return self.value

Ruleset

Bases: SerializableMixin

Source code in griptape/rules/ruleset.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@define
class Ruleset(SerializableMixin):
    id: str = field(default=Factory(lambda: uuid.uuid4().hex), kw_only=True, metadata={"serializable": True})
    name: str = field(
        default=Factory(lambda self: self.id, takes_self=True),
        metadata={"serializable": True},
    )
    ruleset_driver: BaseRulesetDriver = field(
        default=Factory(lambda: Defaults.drivers_config.ruleset_driver), kw_only=True
    )
    meta: dict[str, Any] = field(factory=dict, kw_only=True, metadata={"serializable": True})
    rules: Sequence[BaseRule] = field(factory=list, metadata={"serializable": True})

    def __attrs_post_init__(self) -> None:
        rules, meta = self.ruleset_driver.load(self.name)
        self.rules = [*rules, *self.rules]
        self.meta = {**meta, **self.meta}

id = field(default=Factory(lambda: uuid.uuid4().hex), kw_only=True, metadata={'serializable': True}) class-attribute instance-attribute

meta = field(factory=dict, kw_only=True, metadata={'serializable': True}) class-attribute instance-attribute

name = field(default=Factory(lambda self: self.id, takes_self=True), metadata={'serializable': True}) class-attribute instance-attribute

rules = field(factory=list, metadata={'serializable': True}) class-attribute instance-attribute

ruleset_driver = field(default=Factory(lambda: Defaults.drivers_config.ruleset_driver), kw_only=True) class-attribute instance-attribute

__attrs_post_init__()

Source code in griptape/rules/ruleset.py 
31
32
33
34
def __attrs_post_init__(self) -> None:
    rules, meta = self.ruleset_driver.load(self.name)
    self.rules = [*rules, *self.rules]
    self.meta = {**meta, **self.meta}