feat(toolkit): Splitting text on role

src/rst_package_refs/toolkit.py

@@ -0,0 +1,17 @@
+"""Toolkit to create original custom role."""
+import re
+from typing import Tuple
+
+
+def split_text(source: str) -> Tuple[str, str]:
+    """Split from content to displaying text and target text.
+
+    Support text patterns:
+
+    * ``text <target>``
+    * ``target``
+    """
+    matched = re.match(r"^(?P<display>.+) <(?P<target>.+)>$", source)
+    if matched:
+        return matched.group("display"), matched.group("target")
+    return source, source

tests/test_toolkit.py

@@ -0,0 +1,20 @@
+import pytest
+from rst_package_refs import toolkit
+
+
+@pytest.mark.parametrize(
+    "text,display_text,target_text",
+    [
+        ("text", "text", "text"),
+        ("text <target", "text <target", "text <target"),
+        ("text target>", "text target>", "text target>"),
+        ("text<target>", "text<target>", "text<target>"),
+        ("text <target>", "text", "target"),
+        ("text <<target>>", "text", "<target>"),
+        ("text <><target>", "text", "><target"),
+    ],
+)
+def test_split_text(text, display_text, target_text):
+    display, target = toolkit.split_text(text)
+    assert display == display_text
+    assert target == target_text