lkj 0.1.45__py3-none-any.whl → 0.1.47__py3-none-any.whl

lkj/strings.py

@@ -633,21 +633,59 @@ class FindReplaceTool:
                         print(highlight)
                 print("-" * 40)
         else:
+            # In non-line mode, a naive snippet (characters around the match) can
+            # include newlines. If we simply print that snippet and then print the
+            # highlight line relative to the snippet start, the visual caret
+            # markers may appear under a different printed line. To avoid this,
+            # find the full line that contains the match and print the context as
+            # lines: preceding context lines, the matched line, then the highlight
+            # directly under the matched line, then the following context lines.
             snippet_radius = 20
             for idx, m in enumerate(self._matches):
                 start, end = m["start"], m["end"]
-                if self.line_mode:
-                    snippet_start = current_text.rfind("\n", 0, start) + 1
-                else:
-                    snippet_start = max(0, start - snippet_radius)
-                snippet_end = min(len(current_text), end + snippet_radius)
-                snippet = current_text[snippet_start:snippet_end]
+                # Find the boundaries of the line containing the match
+                line_start = current_text.rfind("\n", 0, start) + 1
+                line_end = current_text.find("\n", end)
+                if line_end == -1:
+                    line_end = len(current_text)
+
+                # Context window (characters) around the matched line
+                context_start = max(0, line_start - snippet_radius)
+                context_end = min(len(current_text), line_end + snippet_radius)
+                context_text = current_text[context_start:context_end]
+
+                # Split into lines while preserving newlines so output looks natural
+                context_lines = context_text.splitlines(True)
+
+                # Determine which line in context_lines contains the match
+                acc = 0
+                match_line_idx = 0
+                rel_pos_in_context = line_start - context_start
+                for i, line in enumerate(context_lines):
+                    if acc + len(line) > rel_pos_in_context:
+                        match_line_idx = i
+                        break
+                    acc += len(line)
+
                 print(f"Match {idx} (around line {m['line_number']+1}):")
-                print(snippet)
-                highlight = " " * (start - snippet_start) + self.highlight_char * (
-                    end - start
-                )
-                print(highlight)
+                # Print each context line. For the match line, print a highlight
+                # line immediately after it so the caret markers line up under
+                # the matched text.
+                for i, line in enumerate(context_lines):
+                    # Print the context line as-is (it may or may not contain a newline)
+                    print(line, end="")
+                    if i == match_line_idx:
+                        # If the printed line did not end with a newline, ensure the
+                        # caret highlight appears on the next line so it lines up
+                        # visually beneath the matched characters.
+                        if not line.endswith("\n"):
+                            print()
+                        # position of match within the printed line
+                        pos_in_line = start - line_start
+                        highlight = " " * pos_in_line + self.highlight_char * (
+                            end - start
+                        )
+                        print(highlight)
                 print("-" * 40)
 
     def replace_one(self, match_index: int, replacement: Replacement) -> None:
@@ -741,7 +779,7 @@ def print_list(
     sep: str = ", ",
     line_prefix: str = "",
     items_per_line=None,
-    show_count=True,
+    show_count: Union[bool, Callable[[int], str]] = False,
     title=None,
     print_func=print,
 ):
@@ -755,7 +793,7 @@ def print_list(
         sep: Separator for items
         line_prefix: Prefix for each line
         items_per_line: For columns style, how many items per line
-        show_count: Whether to show the count of items
+        show_count: Whether to prefix with the count of items
         title: Optional title to display before the list
         print_func: Function to use for printing. Defaults to print.
                    If None, returns the string instead of printing.
@@ -765,19 +803,16 @@ def print_list(
 
         # Wrapped style (default)
         >>> print_list(items, max_width=30)
-        List (6 items):
         apple, banana, cherry, date,
         elderberry, fig
 
         # Columns style
         >>> print_list(items, style="columns", items_per_line=3)
-        List (6 items):
         apple banana     cherry
         date  elderberry fig
 
         # Numbered style
         >>> print_list(items, style="numbered")
-        List (6 items):
         1. apple
         2. banana
         3. cherry
@@ -787,7 +822,6 @@ def print_list(
 
         # Bullet style
         >>> print_list(items, style="bullet")
-        List (6 items):
         • apple
         • banana
         • cherry
@@ -796,7 +830,7 @@ def print_list(
         • fig
 
         # Return string instead of printing
-        >>> result = print_list(items, style="numbered", print_func=None)
+        >>> result = print_list(items, style="numbered", print_func=None, show_count=True)
         >>> print(result)
         List (6 items):
         1. apple
@@ -847,6 +881,8 @@ def print_list(
             print_func=print_func,
         )
     items = list(items)  # Convert to list if it's an iterable
+    if show_count is True:
+        show_count = lambda n_items: f"List ({n_items} items):"
 
     # Handle print_func=None by using StringAppender
     if print_func is None:
@@ -860,7 +896,7 @@ def print_list(
     if title:
         print_func(title)
     elif show_count:
-        print_func(f"List ({len(items)} items):")
+        print_func(show_count(len(items)))
 
     if not items:
         print_func(f"{line_prefix}(empty list)")

lkj/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for lkj"""

lkj/tests/test_strings.py

@@ -0,0 +1,48 @@
+import io
+import sys
+import re
+
+from lkj.strings import FindReplaceTool
+
+
+def capture_print(func, *args, **kwargs):
+    old_stdout = sys.stdout
+    try:
+        sys.stdout = io.StringIO()
+        func(*args, **kwargs)
+        return sys.stdout.getvalue()
+    finally:
+        sys.stdout = old_stdout
+
+
+def test_find_and_print_matches_highlight_under_match():
+    text = "apple banana apple\nsome other line\n"
+    tool = FindReplaceTool(text, line_mode=False)
+    out = capture_print(tool.find_and_print_matches, r"apple")
+
+    # We expect for the first match that the matched line appears, then the
+    # highlight line directly under it, then following context lines. Ensure the
+    # highlight caret appears on its own line immediately after the matched line.
+    # Locate the first occurrence of the matched line and the caret line that follows.
+    lines = out.splitlines()
+
+    # Find the index of the line that contains the first printed snippet for match 0
+    # It should contain 'apple banana apple'
+    match0_idx = None
+    for i, line in enumerate(lines):
+        if "apple banana apple" in line:
+            # Ensure the next non-empty line is the highlight
+            match0_idx = i
+            break
+
+    assert match0_idx is not None, "Did not find the matched line in output"
+
+    # The next line should be the caret highlight (contains at least one '^')
+    assert any(
+        c == "^" for c in lines[match0_idx + 1]
+    ), "Highlight not directly under matched line"
+
+    # For completeness, ensure that the text 'some other line' appears after the caret
+    assert "some other line" in "\n".join(
+        lines[match0_idx + 2 :]
+    ), "Following context not printed after highlight"

{lkj-0.1.45.dist-info → lkj-0.1.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lkj
-Version: 0.1.45
+Version: 0.1.47
 Summary: A dump of homeless useful utils
 Home-page: https://github.com/thorwhalen/lkj
 Author: Thor Whalen

{lkj-0.1.45.dist-info → lkj-0.1.47.dist-info}/RECORD

@@ -7,9 +7,11 @@ lkj/importing.py,sha256=TcW3qUDmw7jqswpxXnksjlHkkbOJq70NbUk1ZyaafT0,6658
 lkj/iterables.py,sha256=9jeO36w-IGiZryge7JKgXZOGZAgehUvhwKV3nHPcZWk,2801
 lkj/loggers.py,sha256=ImmBdacz89Lvb3dg_xI5jOct_44rSRv0hNI_CVehy60,13706
 lkj/misc.py,sha256=IZf05tkl0cgiMgBwCMH5cLSC59fRXwnemPRo8G0OxQg,1436
-lkj/strings.py,sha256=aib3KLFBuHl2WuDI2m7xC2JXM9E2-fk9CkXU7Pld6VU,41459
-lkj-0.1.45.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-lkj-0.1.45.dist-info/METADATA,sha256=J8VwBFxfxTERN8kVlzKROEz3kkz0FvILqflc6rFVxeI,8221
-lkj-0.1.45.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-lkj-0.1.45.dist-info/top_level.txt,sha256=3DZOUwYmyurJFBXQCvCmEIVm8z2b42O5Sx3RDQyePfg,4
-lkj-0.1.45.dist-info/RECORD,,
+lkj/strings.py,sha256=eFPA1EzEyLaF8wPk0Srj8rzrdEN9GNXc03wfvV4MOGU,43744
+lkj/tests/__init__.py,sha256=kReYfWiyz1T79AuZAy5m4PIBj3Oj_Dlc0E-T8HVQ504,20
+lkj/tests/test_strings.py,sha256=Ix54io8WqWmYTY4guBgZShtKabtjd5uVpdxzxwJkgNA,1707
+lkj-0.1.47.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lkj-0.1.47.dist-info/METADATA,sha256=bpcIVJxkJl8wIa2ycVWRmbhVJ3-o-5y-S46A3wepHeo,8221
+lkj-0.1.47.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+lkj-0.1.47.dist-info/top_level.txt,sha256=3DZOUwYmyurJFBXQCvCmEIVm8z2b42O5Sx3RDQyePfg,4
+lkj-0.1.47.dist-info/RECORD,,