Method _normalize_plugins

packages/reflex-base/src/reflex_base/config.py:412–462

Normalize ``plugins`` entries to Plugin instances. Auto-instantiates Plugin subclasses passed without parentheses (e.g. ``plugins=[SitemapPlugin]``) so they behave the same as ``plugins=[SitemapPlugin()]``. Any entry that is neither a Plugin subclass nor a Plugin ins

(self)

            raise ConfigError(msg)

    def _normalize_plugins(self):
        """Normalize ``plugins`` entries to Plugin instances.

        Auto-instantiates Plugin subclasses passed without parentheses (e.g.
        ``plugins=[SitemapPlugin]``) so they behave the same as
        ``plugins=[SitemapPlugin()]``. Any entry that is neither a Plugin
        subclass nor a Plugin instance raises ``ConfigError`` with a message
        that names the offending value, instead of failing later in the
        compiler with a confusing ``TypeError`` about a missing ``self``.

        An ``_InvalidPlugin`` (produced when a ``REFLEX_PLUGINS`` import path
        cannot be resolved) is fatal here: ``plugins`` is an explicit list of
        plugins the app needs, so a bad entry raises ``InvalidPluginConfigError``
        and the app cannot start.

        Raises:
            ConfigError: If an entry is neither a Plugin instance nor subclass.
            InvalidPluginConfigError: If an entry could not be loaded.
        """
        normalized: list[Plugin] = []
        invalid: list[_InvalidPlugin] = []
        for entry in self.plugins:
            if isinstance(entry, _InvalidPlugin):
                invalid.append(entry)
            elif isinstance(entry, Plugin):
                normalized.append(entry)
            elif isinstance(entry, type) and issubclass(entry, Plugin):
                try:
                    normalized.append(entry())
                except TypeError as exc:
                    msg = (
                        f"reflex.Config.plugins entry {entry.__name__!r} could not be "
                        f"instantiated and may require arguments; pass an instance "
                        f"instead, e.g. plugins=[{entry.__name__}(...)]."
                    )
                    raise InvalidPluginConfigError(msg) from exc
            else:
                msg = (
                    f"reflex.Config.plugins must contain Plugin instances, but got "
                    f"{entry!r} of type {type(entry).__name__}. "
                    f"Pass an instance, e.g. plugins=[SitemapPlugin()]."
                )
                raise InvalidPluginConfigError(msg)
        if invalid:
            details = ", ".join(p.describe() for p in invalid)
            msg = (
                f"reflex.Config.plugins contains plugin(s) that could not be loaded "
                f"(check REFLEX_PLUGINS import paths): {details}."
            )
            raise InvalidPluginConfigError(msg)
        self.plugins = normalized

    def _add_extra_plugins(self):
        """Append plugins declared via the ``REFLEX_EXTRA_PLUGINS`` env var.