Skip to content

Reference

panel-copy-paste provides features for copying to and pasting from the clipboard.

CopyButton

Bases: JSComponent

A custom Panel widget to copy a value to the clipboard.

Currently supports copying strings and DataFrames.

Examples:

>>> from panel_copy_paste import CopyButton
>>> CopyButton(value="Hello World").servable()
Source code in src/panel_copy_paste/_copy_button.py 
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
class CopyButton(pn.custom.JSComponent):
    """
    A custom Panel widget to copy a value to the clipboard.

    Currently supports copying strings and DataFrames.

    Examples
    --------
    >>> from panel_copy_paste import CopyButton
    >>> CopyButton(value="Hello World").servable()

    """

    value = param.Parameter(doc="""A String or DataFrame. Or a callback, Parameter or Parameterized object providing such types.""")
    button = pn.custom.Child(constant=True, doc="""An optional custom Button or ButtonIcon to use.""")

    decimal_separator = param.Selector(
        default=None,
        objects=[None, ".", ","],
        doc="""The decimal symbol used when transforming a DataFrame. If not provided set to the decimal symbol of the client.""",
    )
    index = param.Boolean(default=False, doc="""Whether to include the index when copying a Pandas DataFrame.""")

    _DEFAULT_BUTTON = pn.widgets.ButtonIcon(description="Copy to clip board.", icon="copy", active_icon="check", toggle_duration=1500)
    _data = param.Parameter(doc="""The value to be transferred to the clip board.""")

    _rename = {"value": None, "index": None}
    _esm = """
    function getDecimalSeparator(locale) {
        const numberWithDecimalSeparator = 1.1;
        return Intl.NumberFormat(locale)
            .formatToParts(numberWithDecimalSeparator)
            .find(part => part.type === 'decimal')
            .value;
    }

    export function render({ model, el }) {
      const button = model.get_child("button")
      el.appendChild(button)

      if (model.decimal_separator === null) {
        model.decimal_separator = getDecimalSeparator();
      }

      model.on("_data", (e)=>{
        navigator.clipboard.writeText(model._data).then(function() { }, function(err) {
            console.error('Could not write to clipboard: ', err);
        });
      })
    }
    """

    def __init__(self, **params):
        if "button" not in params:
            params["button"] = self._get_new_button()
        super().__init__(**params)

    @classmethod
    def _get_new_button(cls):
        return cls._DEFAULT_BUTTON.clone()

    @param.depends("button.clicks", watch=True)
    def _handle_clicks(self):
        self._data = self._transform_value(self.value, decimal_separator=self.decimal_separator)

    @staticmethod
    def _transform_frame(value: IntoDataFrame, index=False, decimal_separator=None) -> str:
        if decimal_separator not in [".", ","]:
            decimal_separator = "."

        if is_pandas_dataframe(value):
            return value.to_csv(sep="\t", decimal=decimal_separator, index=index)
        if is_polars_dataframe(value):
            # Polars does not support ",": https://github.com/pola-rs/polars/issues/19963
            # This assumes pandas and pyarrow is installed
            if decimal_separator == ",":
                return value.to_pandas().to_csv(sep="\t", decimal=decimal_separator, index=False)
            return value.write_csv(separator="\t")

        msg = f"Value of type '{type(value)} is not supported yet."
        raise ValueError(msg)

    @classmethod
    def _transform_value(cls, value, transform_func=None, index=False, decimal_separator=None) -> str:
        if isinstance(value, param.Parameterized):
            if hasattr(value, "value"):
                return cls._transform_frame(value.value)
            elif hasattr(value, "object"):
                return cls._transform_frame(value.object)
        elif isinstance(value, param.Parameter):
            return cls._transform_value(value.rx.value)
        elif callable(value):
            return cls._transform_frame(value())

        if value is None:
            return ""
        if isinstance(value, str):
            return value
        if is_into_dataframe(value):
            return cls._transform_frame(value, index=index, decimal_separator=decimal_separator)

        msg = f"Value of type '{type(value)} is not supported yet."
        raise ValueError(msg)

    @classmethod
    def _create_test_app(cls):
        str_button = cls(value="Hello String World")
        import pandas as pd

        pandas_button = cls(value=pd.DataFrame({"x": [1, 2], "pandas": ["a", "b"]}), button=pn.widgets.Button(name="Copy Pandas", icon="copy"))
        import polars as pl

        polars_button = cls(
            value=pl.DataFrame({"x": [1, 2], "polars": ["a", "b"]}),
            button=pn.widgets.ButtonIcon(name="Copy Polars", icon="copy", active_icon="check", toggle_duration=1500),
        )

        text_area_input = pn.widgets.TextAreaInput(rows=10)
        return pn.Row(pn.Column(str_button, pandas_button, polars_button), text_area_input)

button = pn.custom.Child(constant=True, doc='An optional custom Button or ButtonIcon to use.') class-attribute instance-attribute

decimal_separator = param.Selector(default=None, objects=[None, '.', ','], doc='The decimal symbol used when transforming a DataFrame. If not provided set to the decimal symbol of the client.') class-attribute instance-attribute

index = param.Boolean(default=False, doc='Whether to include the index when copying a Pandas DataFrame.') class-attribute instance-attribute

value = param.Parameter(doc='A String or DataFrame. Or a callback, Parameter or Parameterized object providing such types.') class-attribute instance-attribute

PasteButton

Bases: PasteButtonBase

A Custom Panel widget to paste a string value from the clipboard.

Examples:

>>> import panel as pn
>>> from panel_copy_paste import PasteButton
>>> pn.extension("codeeditor")
>>> editor = pn.widgets.CodeEditor()
>>> button = PasteButton(target=editor)
>>> pn.Column(button, editor).servable()
Source code in src/panel_copy_paste/_paste_button.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
class PasteButton(PasteButtonBase):
    """
    A Custom Panel widget to paste a string value from the clipboard.

    Examples
    --------
    >>> import panel as pn
    >>> from panel_copy_paste import PasteButton
    >>> pn.extension("codeeditor")
    >>> editor = pn.widgets.CodeEditor()
    >>> button = PasteButton(target=editor)
    >>> pn.Column(button, editor).servable()

    """

    value = param.String(default="", doc="""The value from the clip board as a string.""")
    button = pn.custom.Child(constant=True, doc="""An optional custom Button or ButtonIcon to use.""")
    target = param.Parameter(
        doc="""If a widget its value is set to value when it changes. If a Pane its object will be
        set to the value. If a callable the callable will be executed on the value.""",
        allow_refs=False,
    )

    _transform_func = do_nothing

button = pn.custom.Child(constant=True, doc='An optional custom Button or ButtonIcon to use.') class-attribute instance-attribute

target = param.Parameter(doc='If a widget its value is set to value when it changes. If a Pane its object will be\n set to the value. If a callable the callable will be executed on the value.', allow_refs=False) class-attribute instance-attribute

value = param.String(default='', doc='The value from the clip board as a string.') class-attribute instance-attribute

PasteToDataFrameButton

Bases: PasteButtonBase

A Custom Panel widget to paste a tab separated string from the clipboard into a Pandas DataFrame.

Examples:

>>> import panel as pn
>>> from panel_copy_paste import PasteToDataFrameButton
>>> pn.extension("tabulator")
>>> table = pn.widgets.Tabulator()
>>> button = PasteToDataFrameButton(target=table)
>>> pn.Column(button, table).servable()
Source code in src/panel_copy_paste/_paste_button.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class PasteToDataFrameButton(PasteButtonBase):
    """
    A Custom Panel widget to paste a tab separated string from the clipboard into a Pandas DataFrame.

    Examples
    --------
    >>> import panel as pn
    >>> from panel_copy_paste import PasteToDataFrameButton
    >>> pn.extension("tabulator")
    >>> table = pn.widgets.Tabulator()
    >>> button = PasteToDataFrameButton(target=table)
    >>> pn.Column(button, table).servable()

    """

    _esm = """
    function getDecimalSeparator(locale) {
        const numberWithDecimalSeparator = 1.1;
        return Intl.NumberFormat(locale)
            .formatToParts(numberWithDecimalSeparator)
            .find(part => part.type === 'decimal')
            .value;
    }

    export function render({ model, el }) {
      const button = model.get_child("button")
      el.appendChild(button)

      if (model._decimal_separator === null) {
        model.decimal_separator = getDecimalSeparator();
      }

      button.addEventListener('click', (event) => {
            navigator.clipboard.readText()
            .then(pastedData => {
                if (model.data==pastedData){
                    model.data=pastedData + " ";
                } else {
                    model.data = pastedData;
                }
            })

        });
    }
    """

    value = param.DataFrame(doc="""The value from the clip board as a Pandas DataFrame.""")
    button = pn.custom.Child(constant=True, doc="""A custom Button or ButtonIcon to use.""")
    target = param.Parameter(
        doc="""If a widget its value is set to value when it changes. If a Pane its object will be
        set to the value. If a callable the callable will be executed on the value.""",
        allow_refs=False,
    )

    decimal_separator = param.Selector(
        default=None,
        objects=[None, ".", ","],
        doc="""The decimal symbol used when transforming a DataFrame. If not provided set to the decimal symbol of the client.""",
    )
    _transform_func = read_csv

button = pn.custom.Child(constant=True, doc='A custom Button or ButtonIcon to use.') class-attribute instance-attribute

decimal_separator = param.Selector(default=None, objects=[None, '.', ','], doc='The decimal symbol used when transforming a DataFrame. If not provided set to the decimal symbol of the client.') class-attribute instance-attribute

target = param.Parameter(doc='If a widget its value is set to value when it changes. If a Pane its object will be\n set to the value. If a callable the callable will be executed on the value.', allow_refs=False) class-attribute instance-attribute

value = param.DataFrame(doc='The value from the clip board as a Pandas DataFrame.') class-attribute instance-attribute