Skip to content

roboherd.annotations

Activity = Annotated[dict, Depends(get_activity)] module-attribute

The activity parsed by muck_out

EmbeddedObject = Annotated[dict, Depends(get_embedded_object)] module-attribute

The embedded object in the activity as parsed by muck_out

ParsedData = Annotated[dict, Depends(get_parsed)] module-attribute

The parsed data as transformed by muck_out

RawData = Annotated[dict, Depends(get_raw)] module-attribute

The raw data as received by cattle_grid

bovine

Test documentation

ActivityFactory = Annotated[BovineActivityFactory, Depends(get_activity_factory)] module-attribute

MarkdownPoster = Annotated[MarkdownPublisher, Depends(get_markdown_poster)] module-attribute

A function that takes a markdown string and posts it as the content of a note

MarkdownPublisher = Callable[[str], Awaitable[None]] module-attribute

Type of the markdown publisher

ObjectFactory = Annotated[BovineObjectFactory, Depends(get_object_factory)] module-attribute

common

Profile = Annotated[dict, Depends(get_profile)] module-attribute

The profile of the cow

PublishActivity = Annotated[Publisher, Depends(construct_publish_activity)] module-attribute

Allows one to publish an activity as the actor. Assumes cattle_grid has the extension simple_object_storage or equivalent

PublishObject = Annotated[Publisher, Depends(construct_publish_object)] module-attribute

Allows one to publish an object as the actor. Assumes cattle_grid has the extension simple_object_storage or equivalent

Publisher = Callable[[dict], Awaitable[None]] module-attribute

Type returned by the publishing functions