ReferencePython SDK ReferenceNemoguardrails

nemoguardrails.registry

View as Markdown

Module Contents

Classes

NameDescription
Registry-

API

class nemoguardrails.registry.Registry(
    enable_validation: bool = True
)
Abstract
items
= defaultdict(str)
nemoguardrails.registry.Registry.__contains__(
    name: str
) -> bool
nemoguardrails.registry.Registry.__getitem__(
    name: str
) -> typing.Any
nemoguardrails.registry.Registry.__iter__() -> typing.Iterator[str]
nemoguardrails.registry.Registry.__len__() -> int
nemoguardrails.registry.Registry.__repr__() -> str
nemoguardrails.registry.Registry.add(
    name: str,
    item: typing.Any
)

Add an item to the registry.

Parameters:

name
str

The name of the item.

item
Any

The item to be added.

Raises:

  • ValueError: If the item name already exists in the registry.
nemoguardrails.registry.Registry.get(
    name: str
) -> typing.Any

Get an item by name.

Parameters:

name
str

The name of the item.

Raises:

  • KeyError: If the item name does not exist in the registry.
nemoguardrails.registry.Registry.list() -> typing.List[str]

List all items in the registry.

Returns: List[str]

List[str]: A list of all item names.

nemoguardrails.registry.Registry.reset()
nemoguardrails.registry.Registry.validate(
    name: str,
    item: typing.Any
) -> None
abstract