academy.identifier

academy/identifier.py

EntityId module-attribute

EntityId = Union[AgentId[Any], ClientId]

EntityId union type for type annotations.

AgentId pydantic-model

Bases: BaseModel, Generic[BehaviorT]

Unique identifier of an agent in a multi-agent system.

Config:

• extra: forbid
• frozen: True
• validate_default: True

Fields:

• uid (UUID)
• name (Optional[str])
• role (Literal['agent'])

new classmethod

new(name: str | None = None) -> Self

Create a new identifier.

Parameters:

• name (str | None, default: None ) –

  Optional human-readable name for the entity.

Source code in academy/identifier.py

@classmethod
def new(cls, name: str | None = None) -> Self:
    """Create a new identifier.

    Args:
        name: Optional human-readable name for the entity.
    """
    return cls(uid=uuid.uuid4(), name=name)

ClientId pydantic-model

Bases: BaseModel

Unique identifier of a client in a multi-agent system.

Config:

• extra: forbid
• frozen: True
• validate_default: True

Fields:

• uid (UUID)
• name (Optional[str])
• role (Literal['client'])

new classmethod

new(name: str | None = None) -> Self

Create a new identifier.

Parameters:

• name (str | None, default: None ) –

  Optional human-readable name for the entity.

Source code in academy/identifier.py

@classmethod
def new(cls, name: str | None = None) -> Self:
    """Create a new identifier.

    Args:
        name: Optional human-readable name for the entity.
    """
    return cls(uid=uuid.uuid4(), name=name)