Seagrass documentation

Welcome to the documentation for Seagrass!

Seagrass is a Python library for auditing user-defined events in your code. You can use it to emit a log whenever a function is called, profile small sections of code, monitor what files get opened, and much, much more.

To get started, check out the Quick start guide. Otherwise, you can browse the table of contents for the information you’re looking for.

Contents:

• Quick start guide
  • Installation
  • Creating a new Auditor
  • Raising audit events without wrapping functions
• Creating custom hooks
  • Passing context between the prehook and posthook
  • Change prehook and posthook priority
  • Additional hook methods
• Tips and tricks
  • Auditing class attributes
  • Automatically naming events
• FAQ
  • Why use Seagrass instead of Python runtime audit hooks?
• Glossary
  • Auditor
  • Auditing context
  • Event
  • Hook
  • Runtime audit event/hook
• API documentation
  • seagrass
  • seagrass.base
  • seagrass.errors
  • seagrass.events
  • seagrass.hooks

Indices and tables

• Index

• Module Index

• Search Page