The Grok Reference

(keep this under your pillow)

Reference for Grok version:

5.4

Document last updated:

Jun 10, 2025

This is the Grok reference documentation. It is organized by the Python artefacts that implement it’s concepts.

• Components
  • Core components
  • Indexes
  • Adapters
  • Utilities
  • Views
  • Forms
  • Security
• Directives
  • Core directives
  • Utility directives
  • Adapter directives
  • Security directives
  • Component registry directives
  • View directives
  • URL Traversal directives
• Decorators
  • grok.subscribe() – register a function as a subscriber for an event
  • grok.action() – declare a form submit handler
  • grok.require() – protect a method with a permission
  • grok.adapter/grok.implementer() – declare an adapter factory
• Functions
  • grok.AutoFields() – deduce and return schema fields automatically
  • grok.Fields() – declare schema fields of a form
  • grok.getApplication()
  • grok.getSite()
  • grok.notify()
  • grok.url()
  • grok.create_application()
• Utilities
  • grok.util.application_url()
  • grok.util.applySkin()
  • grok.util.getApplication()
  • grok.util.safely_locate_maybe()
• Events
  • Subscription: Event interfaces
  • Notification: Event implementations
• Exceptions
  • grok.GrokImportError – errors while importing a module
  • grok.GrokError – errors while grokking a module
• Testing
  • Installing the testing tool
  • Using the test runner
  • Discovering Test Cases
  • Test Supporting API