feat: multiple characters for rule.py

rich/console.py

@@ -795,18 +795,18 @@ def rule(
         self,
         title: str = "",
         *,
-        character: str = "─",
+        characters: str = "─",
         style: Union[str, Style] = "rule.line",
     ) -> None:
         """Draw a line with optional centered title.
 
         Args:
             title (str, optional): Text to render over the rule. Defaults to "".
-            character (str, optional): Character to form the line. Defaults to "─".
+            characters (str, optional): Character(s) to form the line. Defaults to "─".
         """
         from .rule import Rule
 
-        rule = Rule(title=title, character=character, style=style)
+        rule = Rule(title=title, characters=characters, style=style)
         self.print(rule)
 
     def control(self, control_codes: Union["Control", str]) -> None:

rich/rule.py

@@ -1,6 +1,6 @@
 from typing import Union
 
-from .cells import cell_len
+from .cells import cell_len, get_character_cell_size as get_char_size, set_cell_size
 from .console import Console, ConsoleOptions, RenderResult
 from .jupyter import JupyterMixin
 from .style import Style
@@ -12,7 +12,7 @@ class Rule(JupyterMixin):
 
     Args:
         title (Union[str, Text], optional): Text to render in the rule. Defaults to "".
-        character (str, optional): Character used to draw the line. Defaults to "─".
+        characters (str, optional): Character(s) used to draw the line. Defaults to "─".
         style (StyleType, optional): Style of Rule. Defaults to "rule.line".
         end (str, optional): Character at end of Rule. defaults to "\\n"
     """
@@ -21,29 +21,37 @@ def __init__(
         self,
         title: Union[str, Text] = "",
         *,
-        character: str = None,
+        characters: str = "─",
         style: Union[str, Style] = "rule.line",
         end: str = "\n",
     ) -> None:
-        if character and cell_len(character) != 1:
-            raise ValueError("'character' argument must have a cell width of 1")
+        if cell_len(characters) < 1:
+            raise ValueError(
+                "'characters' argument must have at least a cell width of 1"
+            )
         self.title = title
-        self.character = character
+        self.characters = characters
         self.style = style
         self.end = end
 
     def __repr__(self) -> str:
-        return f"Rule({self.title!r}, {self.character!r})"
+        return f"Rule({self.title!r}, {self.characters!r})"
 
     def __rich_console__(
         self, console: Console, options: ConsoleOptions
     ) -> RenderResult:
         width = options.max_width
 
-        character = self.character or "─"
+        characters = self.characters or "─"
 
+        if cell_len(characters) == 1:
+            chars_len = get_char_size(characters)
+        else:
+            chars_len = 0
+            for i in list(characters):
+                chars_len += get_char_size(i)
         if not self.title:
-            yield Text(character * width, self.style)
+            yield Text(characters * (width // chars_len), self.style)
         else:
             if isinstance(self.title, Text):
                 title_text = self.title
@@ -56,12 +64,18 @@ def __rich_console__(
             title_text.plain = title_text.plain.replace("\n", " ")
             title_text = title_text.tabs_to_spaces()
             rule_text = Text(end=self.end)
-            center = (width - cell_len(title_text.plain)) // 2
-            rule_text.append(character * (center - 1) + " ", self.style)
+            side_width = (width - cell_len(title_text.plain)) // 2
+            if chars_len == 1:
+                side = Text(characters * side_width)
+            else:
+                side = Text(characters * (side_width // (chars_len - 1)))
+            side.truncate(side_width - 1)
+            rule_text.append(str(side) + " ", self.style)
             rule_text.append(title_text)
-            rule_text.append(
-                " " + character * (width - cell_len(rule_text.plain) - 1), self.style
-            )
+            rule_text.append(" " + str(side), self.style)
+            if len(rule_text) < width:
+                rule_text.append(characters[0], self.style)
+            rule_text.plain = set_cell_size(rule_text.plain, width)
             yield rule_text
 
 
@@ -74,4 +88,4 @@ def __rich_console__(
     except IndexError:
         text = "Hello, World"
     console = Console()
-    console.print(Rule(text))
+    console.print(Rule(title=text))