tmux_styler.Statusbar.Statusbar

  1from enum import Enum
  2from typing import Any, Dict
  3import pickle
  4
  5from .WindowList import WindowList
  6from ..Style import *
  7from ..Colors import *
  8from ..ContextVars import *
  9from .Segment import Segment
 10
 11
 12class SegmentSeparator:
 13    """
 14    A segment separator is a character that is displayed between segments.
 15
 16    Attributes:
 17    -----------
 18    `left_thick`: str
 19        The left thick separator, used for separating between segments.
 20
 21    `right_thick`: str
 22        The right thick separator, used for separating between segments.
 23
 24    `left_thin`: str
 25        The left thin separator, used for separating between segments of the same background color.
 26
 27    `right_thin`: str
 28        The right thin separator, used for separating between segments of the same background color.
 29    """
 30
 31    def __init__(self, right_thick: str, left_thick: str, right_thin: str, left_thin: str):
 32        """
 33        Creates a SegmentSeparator object.
 34
 35        Parameters:
 36        -----------
 37        `right_thick`: str
 38            The "pointing" right thick separator, used for separating between segments.
 39
 40        `left_thick`: str
 41            The "pointing" left thick separator, used for separating between segments.
 42
 43        `right_thin`: str
 44            The "pointing" right thin separator, used for separating between segments of the same background color.
 45
 46        `left_thin`: str
 47            The "pointing" left thin separator, used for separating between segments of the same background color.
 48        """
 49
 50        self.right_thick = right_thick
 51        self.left_thick = left_thick
 52        self.right_thin = right_thin
 53        self.left_thin = left_thin
 54
 55
 56class Separators(Enum):
 57    """
 58    Segment separators using nerd font's extra-powerline-separators
 59    https://github.com/ryanoasis/powerline-extra-symbols
 60    """
 61    NONE = SegmentSeparator("", "", "", "")
 62    """
 63    No defining separator between segments.
 64    """
 65
 66    ORIGINAL = SegmentSeparator("", "", "", "")
 67    """
 68    Original/Arrow separators. i.e.  and , and  and .
 69    """
 70
 71    ANGLE = SegmentSeparator("", "", "", "")
 72    """
 73    Angle separators,  and , and  and . Same as Original.
 74    """
 75
 76    SLASH_FORWARD = SegmentSeparator("", "", "", "")
 77    """
 78    Forward slash separators,   and  , .
 79    """
 80
 81    SLASH_BACKWARD = SegmentSeparator("", "", "", "")
 82    """
 83    Backward slash separators,   and  ,  .
 84    """
 85
 86    ROUND = SegmentSeparator("", "", "", "")
 87    """
 88    Round separators,  and , and  and .
 89    """
 90
 91    FLAME = SegmentSeparator(" ", " \u2588", " ", " ")
 92    """
 93    Flame separators,  and , and   and  .
 94    """
 95
 96    PIXEL_SQUARES = SegmentSeparator(" ", " \u2588", "", " ")
 97    """
 98    Pixel square separators,  and ,  and .
 99    """
100
101
102class Statusbar:
103    """
104    Represents the tmux statusbar.
105    """
106
107    segment_data: Dict[str, Dict[str, Any] | None] | None = None
108    """
109    Specify what functions are available to use as segments. The key is {module}.{function name} and its value is a dict
110    containing the args that will be passed to it. If the value is None, then no args will be passed to the function.
111    Functions included by default in this library or do not need to be prefixed by a module name. A module must be
112    accessible by your python path or in a recognized segment directory.
113
114    Example:
115    ```python
116    statusbar.segment_data = {
117        "some_module.add_numbers": {
118            "x": 1,
119            "y": 2,
120        },
121
122    }
123    ```
124    """
125
126    left_side: tuple[list[Segment], Style] | list[Segment]
127    """
128    List of Segment objects to display on the left side of the statusbar and optionally, the default style to use for the left side.
129    """
130
131    right_side: tuple[list[Segment], Style] | list[Segment]
132    """
133    List of Segment objects to display on the right side of the statusbar and optionally, the default style to use.
134    """
135
136    left_side_max_length: int = 60
137    """
138    The maximum length of the left side of the statusbar. Defaults to 60.
139    """
140
141    right_side_max_length: int = 90
142    """
143    The maximum length of the right side of the statusbar. Defaults to 90.
144    """
145
146    window_list: WindowList
147    """
148    tmux window status list.
149    """
150
151    _segment_separator: SegmentSeparator = Separators.ORIGINAL.value
152
153    @property
154    def segment_separator(cls) -> SegmentSeparator:
155        """
156        The segment separator to use. Defaults to the "original" powerline separators. i.e.  and ,  and .
157        """
158        return cls._segment_separator
159
160    @segment_separator.setter
161    def segment_separator(cls, value: SegmentSeparator | Separators) -> None:
162        if isinstance(value, Separators):
163            cls._segment_separator = value.value
164        else:
165            cls._segment_separator = value
166
167    _left_end_separator: SegmentSeparator | None = None
168
169    @property
170    def left_end_separator(cls) -> SegmentSeparator:
171        """
172        The segment separator to use at the end of the left side of the statusbar. Defaults to whatever is set in segment_separator.
173        """
174        return cls._left_end_separator if cls._left_end_separator is not None else cls.segment_separator
175
176    @left_end_separator.setter
177    def left_end_separator(cls, value: SegmentSeparator | Separators) -> None:
178        if isinstance(value, Separators):
179            cls._left_end_separator = value.value
180        else:
181            cls._left_end_separator = value
182
183    _right_end_separator: SegmentSeparator | None = None
184
185    @property
186    def right_end_separator(cls) -> SegmentSeparator:
187        """
188        The segment separator to use at the end of the right side of the statusbar. Defaults to whatever is set in segment_separator.
189        """
190        return cls._right_end_separator if cls._right_end_separator is not None else cls.segment_separator
191
192    @right_end_separator.setter
193    def right_end_separator(cls, value: SegmentSeparator | Separators) -> None:
194        if isinstance(value, Separators):
195            cls._right_end_separator = value.value
196        else:
197            cls._right_end_separator = value
198
199    default_bg: Color = NamedColor.TERMINAL
200    """
201    The default background color for the statusbar.
202    """
203
204    default_fg: Color = NamedColor.TERMINAL
205    """
206    The default foreground color for the statusbar.
207    """
208
209    default_style: Style | None = None
210    """
211    The default style for the statusbar.
212
213    Segments will inherit from the default style, e.g. if you set bold here, all segments will be bold unless you explictily unset it in that segment's style.
214    """
215
216    status_interval: int = 1
217    """
218    The interval in seconds at which the statusbar will be redrawn.
219    """
220
221    visible: bool = True
222    """
223    Whether the statusbar is initially visible or not .
224    """
225
226    def __init__(self, left_side: tuple[list[Segment], Style] | list[Segment], right_side: tuple[list[Segment], Style] | list[Segment], window_list: WindowList):
227        """
228        Creates the Statusbar object.
229
230        Parameters:
231        -----------
232        `left_side`: tuple[list[Segment], Style] | list[Segment]
233            List of Segment objects to display on the left side of the statusbar and optionally, the default style to use for the left side.
234
235        `right_side`: tuple[list[Segment], Style] | list[Segment]
236            List of Segment objects to display on the right side of the statusbar and optionally, the default style to use.
237
238        `window_list`: WindowList
239            tmux window list.
240        """
241        self.left_side = left_side
242        self.right_side = right_side
243        self.window_list = window_list
244
245    def __pickle(self) -> bytes:
246        """
247        Pickles the Statusbar object and returns the pickled bytes.
248        """
249        return pickle.dumps(self)
250
251    def __commands(self) -> list[str]:
252        """
253        Returns the tmux commands to be run to update the statusbar.
254        """
255        if self.default_style is not None:
256            if self.default_style.bg is not None:
257                self.default_bg = self.default_style.bg
258            if self.default_style.fg is not None:
259                self.default_fg = self.default_style.fg
260        else:
261            self.default_style = Style(self.default_bg, self.default_fg)
262
263        return [
264            *self.window_list._WindowList__commands(),
265            # visible
266            f'tmux set -g status {"on" if self.visible else "off"}',
267            # interval
268            f'tmux set -g status-interval {self.status_interval}',
269            # Default Style
270            f'tmux set -g status-style "{str(self.default_style)}"',
271            # Lengths
272            f'tmux set -g status-left-length {self.left_side_max_length}',
273            f'tmux set -g status-right-length {self.right_side_max_length}',
274
275            # Left/Right Side
276            'tmux set -g status-left "#(tmux-styler -sl #{window_start_flag})"',
277            f'tmux set -g status-left-style "{str(self.left_side[1]) if isinstance(self.left_side, tuple) else "default"}"',
278            'tmux set -g status-right "#(tmux-styler -sr #{window_end_flag})"',
279            f'tmux set -g status-right-style "{str(self.right_side[1]) if isinstance(self.right_side, tuple) else "default"}"',
280        ]