langfun 0.1.2.dev202501050804__py3-none-any.whl → 0.1.2.dev202501090804__py3-none-any.whl

langfun/core/text_formatting.py

@@ -1,168 +0,0 @@
-# Copyright 2023 The Langfun Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""Utility library for LM input/output formatting."""
-
-import io
-import re
-from typing import Any
-
-try:
-  import termcolor      # pylint: disable=g-import-not-at-top
-except ImportError:
-  termcolor = None
-
-
-# Regular expression for ANSI color characters.
-_ANSI_COLOR_REGEX = re.compile(r'\x1b\[[0-9;]*m')
-
-
-def decolored(text: str) -> str:
-  """Return the de-colored string that may contains ANSI color characters."""
-  return re.sub(_ANSI_COLOR_REGEX, '', text)
-
-
-def colored(
-    text: str,
-    color: str | None = None,
-    background: str | None = None,
-    styles: list[str] | None = None
-) -> str:
-  """Returns the colored text with ANSI color characters.
-
-  Args:
-    text: A string that may or may not already has ANSI color characters.
-    color: A string for text colors. Applicable values are:
-      'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'.
-    background: A string for background colors. Applicable values are:
-      'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'.
-    styles: A list of strings for applying styles on the text.
-      Applicable values are: 
-      'bold', 'dark', 'underline', 'blink', 'reverse', 'concealed'.
-
-  Returns:
-    A string with ANSI color characters embracing the entire text.
-  """
-  if not termcolor:
-    return text
-  return termcolor.colored(
-      text,
-      color=color,
-      on_color=('on_' + background) if background else None,
-      attrs=styles)
-
-
-def colored_template(
-    text: str,
-    expression_color: str | None = 'white',
-    expression_background: str | None = 'blue',
-    expression_styles: list[str] | None = None,
-    statement_color: str | None = 'red',
-    statement_background: str | None = None,
-    statement_styles: list[str] | None = None,
-    comment_color: str | None = 'green',
-    comment_background: str | None = None,
-    comment_styles: list[str] | None = None,
-    ) -> str:
-  """Returns colored (maybe) Jinja2 template string."""
-  text = color_text_blocks(
-      text, '{{', '}}',
-      color=expression_color,
-      background=expression_background,
-      styles=expression_styles)
-
-  text = color_text_blocks(
-      text, '{%', '%}',
-      color=statement_color,
-      background=statement_background,
-      styles=statement_styles)
-
-  text = color_text_blocks(
-      text, '{#', '#}',
-      color=comment_color,
-      background=comment_background,
-      styles=comment_styles)
-
-  return text
-
-
-def color_text_blocks(
-    text: str,
-    block_start: str,
-    block_end: str,
-    color: str | None = None,
-    background: str | None = None,
-    styles: list[str] | None = None
-) -> str:
-  """Apply colors to text blocks.
-
-  Args:
-    text: A string that may or may not already has ANSI color characters.
-    block_start: A string that signals the start of a block. E.g. '{{'
-    block_end: A string that signals the end of a block. E.g. '}}'.
-    color: A string for text colors. Applicable values are:
-      'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'.
-    background: A string for background colors. Applicable values are:
-      'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'.
-    styles: A list of strings for applying styles on the text.
-      Applicable values are: 
-      'bold', 'dark', 'underline', 'blink', 'reverse', 'concealed'.
-
-  Returns:
-    A string with ANSI color characters embracing the matched text blocks.
-  """
-  if not color and not background and not styles:
-    return text
-
-  string_buffer = io.StringIO()
-  start_index = 0
-  end_index = 0
-  previous_color = None
-
-  def write_nonblock_text(text: str, previous_color: str | None):
-    if previous_color:
-      string_buffer.write(previous_color)
-    string_buffer.write(text)
-
-  while start_index < len(text):
-    start_index = text.find(block_start, end_index)
-    if start_index == -1:
-      write_nonblock_text(text[end_index:], previous_color)
-      break
-
-    # Deal with text since last block.
-    since_last_block = text[end_index:start_index]
-    write_nonblock_text(since_last_block, previous_color)
-    colors = re.findall(_ANSI_COLOR_REGEX, since_last_block)
-    if colors:
-      previous_color = colors[-1]
-
-    # Match block.
-    end_index = text.find(block_end, start_index + len(block_start))
-    if end_index == -1:
-      write_nonblock_text(text[start_index:], previous_color)
-      break
-    end_index += len(block_end)
-
-    # Write block text.
-    block = text[start_index:end_index]
-    colored_block = colored(
-        block, color=color, background=background, styles=styles)
-    string_buffer.write(colored_block)
-  return string_buffer.getvalue()
-
-
-def colored_print(value: Any):
-  """Prints text with color."""
-  print(colored_template(str(value)))
-

langfun/core/text_formatting_test.py

@@ -1,65 +0,0 @@
-# Copyright 2023 The Langfun Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""Tests for text formatting."""
-
-import inspect
-import unittest
-from langfun.core import text_formatting
-
-
-class TextFormattingTest(unittest.TestCase):
-
-  def test_colored_template(self):
-    original_text = inspect.cleandoc("""
-        Hi {{ foo }}
-        {# print x if x is present #}
-        {% if x %}
-        {{ x }}
-        {% endif %}
-        """)
-
-    colored_text = text_formatting.colored_template(
-        text_formatting.colored(original_text, color='blue')
-    )
-    self.assertEqual(
-        colored_text,
-        '\x1b[34mHi \x1b[44m\x1b[37m{{ foo }}\x1b[0m\x1b[34m\n'
-        '\x1b[32m{# print x if x is present #}\x1b[0m\x1b[34m\n'
-        '\x1b[31m{% if x %}\x1b[0m\x1b[34m\n'
-        '\x1b[44m\x1b[37m{{ x }}\x1b[0m\x1b[34m\n'
-        '\x1b[31m{% endif %}\x1b[0m\x1b[34m\x1b[0m'
-    )
-    self.assertEqual(text_formatting.decolored(colored_text), original_text)
-
-  def test_colored_without_termcolor(self):
-    termcolor = text_formatting.termcolor
-    text_formatting.termcolor = None
-    original_text = inspect.cleandoc("""
-        Hi {{ foo }}
-        {# print x if x is present #}
-        {% if x %}
-        {{ x }}
-        {% endif %}
-        """)
-
-    colored_text = text_formatting.colored_template(
-        text_formatting.colored(original_text, color='blue')
-    )
-    self.assertEqual(colored_text, original_text)
-    self.assertEqual(text_formatting.decolored(colored_text), original_text)
-    text_formatting.termcolor = termcolor
-
-
-if __name__ == '__main__':
-  unittest.main()