Function add

mitmproxy/contentviews/__init__.py:161–175

Register a contentview for use in mitmproxy. You may pass a `Contentview` instance or the class itself. When passing the class, its constructor will be invoked with no arguments.

(contentview: Contentview | type[Contentview])

def add(contentview: Contentview | type[Contentview]) -> None:
    """
    Register a contentview for use in mitmproxy.

    You may pass a `Contentview` instance or the class itself.
    When passing the class, its constructor will be invoked with no arguments.
    """
    if isinstance(contentview, View):
        warnings.warn(
            f"`mitmproxy.contentviews.View` is deprecated since mitmproxy 12, "
            f"migrate {contentview.__class__.__name__} to `mitmproxy.contentviews.Contentview` instead.",
            stacklevel=2,
        )
        contentview = LegacyContentview(contentview)
    registry.register(contentview)


# hack: docstring where pdoc finds it.