Plugins
Plugin packages register Plugin objects through entry points in the data_designer.plugins group. A plugin registration ties a config class to its implementation class and declares its PluginType.
Related pages: Build Your Own, Column Generators, Seed Readers, Engine Processors, and Processor Configurations.
Plugin
Bases: BaseModel
Declares a Data Designer plugin by tying a config class to its implementation class.
A plugin package exposes one Plugin instance per extension through an entry
point in the data_designer.plugins group. Data Designer discovers the entry
point on import, loads the referenced classes, and registers the plugin so its
config type is usable like any built-in Data Designer object.
Attributes:
| Name | Type | Description |
|---|---|---|
impl_qualified_name |
str
|
Fully-qualified import path of the implementation class,
e.g. |
config_qualified_name |
str
|
Fully-qualified import path of the config class,
e.g. |
plugin_type |
PluginType
|
The kind of extension this plugin contributes. Determines which
discriminator field name is required on the config class: |
PluginType
Bases: str, Enum
The kind of Data Designer extension a plugin contributes.
Attributes:
| Name | Type | Description |
|---|---|---|
COLUMN_GENERATOR |
A custom column type whose config inherits from
|
|
SEED_READER |
A custom seed dataset reader whose config inherits from
|
|
PROCESSOR |
A custom processor whose config inherits from
|