Plugins

This page lists the public plugin API.

For a guide-style introduction, see Plugins.

Base class

class InterfacyPlugin

Base class for code-registered Interfacy plugins.

configure(_context)

Configure a parser immediately after plugin registration.

before_parse(_context, args)

Transform raw CLI arguments before backend parsing.

after_parse(_context, namespace)

Transform the parsed namespace before it is returned.

transform_schema(_context, schema)

Transform a fully built parser schema before backend materialization.

wrap_execute(_context, call_next)

Wrap command execution.

recover_parse_failure(_context, _failure)

Optionally recover from a structured parse failure.

property plugin_name: str

Return the unique parser-local name used for plugin registration.

Context

class PluginContext

Stable context object passed to plugin lifecycle hooks.

Parse failure

class ParseFailureKind

Kinds of recoverable parse failures supported by the plugin system.

__new__(value)

class ArgumentRef

Stable reference to one schema argument inside a parsed command bucket.

class ParseFailure

Structured recoverable parse failure emitted by Interfacy.

Recovery actions

class ProvideArgumentValues

Recovery action that injects values into a partial parsed namespace.

class AbortRecovery

Recovery action that aborts the current CLI invocation.