Class _PatchHvplotDocstrings

hvplot/util.py:1101–1132

class _PatchHvplotDocstrings:
    def __init__(self):
        from .plotting.core import hvPlot, hvPlotTabular
        from .converter import HoloViewsConverter

        # Store the original signatures because the method signatures
        # are going to be patched every time an extension is changed.
        orig = {}
        for cls in [hvPlot, hvPlotTabular]:
            for _kind in HoloViewsConverter._kind_mapping:
                if hasattr(cls, _kind):
                    method = getattr(cls, _kind)
                    sig = inspect.signature(method)
                    orig[(cls, _kind)] = (sig, method.__doc__)
        self.orig = orig

    def __call__(self):
        from .plotting.core import hvPlot, hvPlotTabular
        from .converter import HoloViewsConverter

        for cls in [hvPlot, hvPlotTabular]:
            for _kind in HoloViewsConverter._kind_mapping:
                if hasattr(cls, _kind):
                    signature = self.orig[(cls, _kind)][0]
                    _patch_doc(cls, _kind, signature=signature)

    def reset(self):
        """Used for testing purposes mostly."""
        for (cls, _kind), (osig, odoc) in self.orig.items():
            obj = getattr(cls, _kind)
            obj.__signature__ = osig
            obj.__doc__ = odoc


def _patch_doc(cls, kind, signature=None):