Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1"""
2Clipboard for command line interface.
3"""
5from __future__ import annotations
7from abc import ABCMeta, abstractmethod
8from typing import Callable
10from prompt_toolkit.selection import SelectionType
12__all__ = [
13 "Clipboard",
14 "ClipboardData",
15 "DummyClipboard",
16 "DynamicClipboard",
17]
20class ClipboardData:
21 """
22 Text on the clipboard.
24 :param text: string
25 :param type: :class:`~prompt_toolkit.selection.SelectionType`
26 """
28 def __init__(
29 self, text: str = "", type: SelectionType = SelectionType.CHARACTERS
30 ) -> None:
31 self.text = text
32 self.type = type
35class Clipboard(metaclass=ABCMeta):
36 """
37 Abstract baseclass for clipboards.
38 (An implementation can be in memory, it can share the X11 or Windows
39 keyboard, or can be persistent.)
40 """
42 @abstractmethod
43 def set_data(self, data: ClipboardData) -> None:
44 """
45 Set data to the clipboard.
47 :param data: :class:`~.ClipboardData` instance.
48 """
50 def set_text(self, text: str) -> None: # Not abstract.
51 """
52 Shortcut for setting plain text on clipboard.
53 """
54 self.set_data(ClipboardData(text))
56 def rotate(self) -> None:
57 """
58 For Emacs mode, rotate the kill ring.
59 """
61 @abstractmethod
62 def get_data(self) -> ClipboardData:
63 """
64 Return clipboard data.
65 """
68class DummyClipboard(Clipboard):
69 """
70 Clipboard implementation that doesn't remember anything.
71 """
73 def set_data(self, data: ClipboardData) -> None:
74 pass
76 def set_text(self, text: str) -> None:
77 pass
79 def rotate(self) -> None:
80 pass
82 def get_data(self) -> ClipboardData:
83 return ClipboardData()
86class DynamicClipboard(Clipboard):
87 """
88 Clipboard class that can dynamically returns any Clipboard.
90 :param get_clipboard: Callable that returns a :class:`.Clipboard` instance.
91 """
93 def __init__(self, get_clipboard: Callable[[], Clipboard | None]) -> None:
94 self.get_clipboard = get_clipboard
96 def _clipboard(self) -> Clipboard:
97 return self.get_clipboard() or DummyClipboard()
99 def set_data(self, data: ClipboardData) -> None:
100 self._clipboard().set_data(data)
102 def set_text(self, text: str) -> None:
103 self._clipboard().set_text(text)
105 def rotate(self) -> None:
106 self._clipboard().rotate()
108 def get_data(self) -> ClipboardData:
109 return self._clipboard().get_data()