models

alchemiscale.models — common data models

exception alchemiscale.models.InvalidGufeKeyError

Bases: ValueError

exception alchemiscale.models.InvalidScopeError

Bases: ValueError

class alchemiscale.models.Scope(*args: Any, **kwargs: Any)

Bases: BaseModel

is_superset(other: Scope) → bool

Return True if this Scope is a superset of another.

Check for a superset (not a proper superset) so that two equal scopes also return True.

specific() → bool

Return True if this Scope has no unspecified elements.

class alchemiscale.models.ScopedKey(*args: Any, **kwargs: Any)

Bases: BaseModel

Unique identifier for GufeTokenizables in state store.

For this object, org, campaign, and project cannot contain wildcards. In other words, the Scope of a ScopedKey must be specific.