PluginParamInfo

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

class PluginParamInfo(name: str, required: bool, annotation: str, default: str, allowed: str, description: str)[source]

Bases: object

One Spec / Registry.create parameter from the v2 constructor.

Rows are built from constructor_signature() for built-in components. When a third-party plugin registers a legacy Pydantic params_model, that schema is used instead.

description prefers the Pydantic Field(description=...), then the registered class Args: section, then the params-model field docstring. allowed is a short constraint string (Literal choices, numeric bounds).

__init__(name: str, required: bool, annotation: str, default: str, allowed: str, description: str) → None