Callbacks

Callbacks that might be useful at the APS using BlueSky

document_contents_callback(key, doc)

prints document contents – use for diagnosing a document stream

DocumentCollectorCallback()

BlueSky callback to collect all documents from most-recent plan

SnapshotReport(*args, **kwargs)

show the data from a apstools.plans.snapshot()

FILE WRITER CALLBACK

see SpecWriterCallback()

class apstools.callbacks.DocumentCollectorCallback[source]

BlueSky callback to collect all documents from most-recent plan

Will reset when it receives a start document.

EXAMPLE:

from apstools.callbacks import DocumentCollector
doc_collector = DocumentCollectorCallback()
RE.subscribe(doc_collector.receiver)
...
RE(some_plan())
print(doc_collector.uids)
print(doc_collector.documents["stop"])
receiver(key, document)[source]

keep all documents from recent plan in memory

apstools.callbacks.document_contents_callback(key, doc)[source]

prints document contents – use for diagnosing a document stream