Coma

Tutorials

  • Introduction
    • Commands
    • Multiple Commands
    • Configurations
    • Multiple Configurations
    • Next Steps
  • Core UI
    • Initiate
      • argparse Overrides
      • Global Configs
      • Global Hooks
    • Register
      • argparse Overrides
      • Local Hooks
    • Command
    • Forget
      • Forgetting Global Hooks
      • Forgetting Global Configs
    • Wake
  • Hooks
    • Introduction
      • Types of Hooks
      • Hook Pipeline
      • Default Hook Pipeline
      • Global and Local Hooks
    • Protocols
      • Function Signature
      • Protocol Parameters
        • generic_protocol()
      • @hook Decorator
      • sequence() Function
      • Specific Protocols
        • Parser
        • Pre Config
        • Config
        • Post Config
        • Pre Init
        • Init
        • Post Init
        • Pre Run
        • Run
        • Post Run
  • Examples
    • Command Line Arguments
      • Program-Level Arguments
      • Command-Level Arguments
      • Using coma.SENTINEL
      • On-the-Fly Hook Redefinition
    • Command Line Config Overrides
      • Prefixing Overrides
      • Overriding Structured Objects
      • Capturing Superfluous Overrides
    • Config Serialization
      • Default Behavior
      • Favoring JSON
    • Fitting coma to Existing Code
      • Redefining Hooks
      • Wrapping with Functions
      • Wrapping with Classes
      • Adding Interface Elements

Package Reference

  • coma
    • coma.hooks
      • coma.hooks.parser_hook
      • coma.hooks.config_hook
      • coma.hooks.post_config_hook
      • coma.hooks.init_hook
      • coma.hooks.run_hook
    • coma.config
      • coma.config.cli
      • coma.config.io
Coma
  • Hooks
  • View page source

Hooks

Hooks make it easy to tweak, replace, or extend coma.

  • Introduction
    • Types of Hooks
    • Hook Pipeline
    • Default Hook Pipeline
    • Global and Local Hooks
  • Protocols
    • Function Signature
    • Protocol Parameters
      • generic_protocol()
    • @hook Decorator
    • sequence() Function
    • Specific Protocols
      • Parser
        • parser_hook_protocol()
      • Pre Config
        • pre_config_hook_protocol()
      • Config
        • config_hook_protocol()
      • Post Config
        • post_config_hook_protocol()
      • Pre Init
        • pre_init_hook_protocol()
      • Init
        • init_hook_protocol()
      • Post Init
        • post_init_hook_protocol()
      • Pre Run
        • pre_run_hook_protocol()
      • Run
        • run_hook_protocol()
      • Post Run
        • post_run_hook_protocol()
Previous Next

© Copyright 2025, Francois Roewer-Despres.

Built with Sphinx using a theme provided by Read the Docs.