scitex 2.0.0__py2.py3-none-any.whl

scitex/str/_print_block.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-03 03:44:47 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_print_block.py
+
+from ._color_text import color_text
+
+
+def printc(message, char="-", n=40, c="cyan"):
+    """Print a message surrounded by a character border.
+
+    This function prints a given message surrounded by a border made of
+    a specified character. The border can be colored if desired.
+
+    Parameters
+    ----------
+    message : str
+        The message to be printed inside the border.
+    char : str, optional
+        The character used to create the border (default is "-").
+    n : int, optional
+        The width of the border (default is 40).
+    c : str, optional
+        The color of the border. Can be 'red', 'green', 'yellow', 'blue',
+        'magenta', 'cyan', 'white', or 'grey' (default is None, which means no color).
+
+    Returns
+    -------
+    None
+
+    Example
+    -------
+    >>> print_block("Hello, World!", char="*", n=20, c="blue")
+    ********************
+    * Hello, World!    *
+    ********************
+
+    Note: The actual output will be in green color.
+    """
+    border = char * n
+    text = f"\n{border}\n{message}\n{border}\n"
+    if c is not None:
+        text = color_text(text, c)
+    print(text)
+
+
+# EOF

scitex/str/_print_debug.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-24 17:17:05 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_print_debug.py
+
+THIS_FILE = "/home/ywatanabe/proj/scitex_repo/src/scitex/str/_print_debug.py"
+
+from ._printc import printc
+
+
+def print_debug():
+    """Print a prominent debug mode banner.
+
+    Displays a highly visible yellow banner to indicate that the program
+    is running in debug mode. Useful for making debug runs immediately
+    distinguishable from production runs.
+
+    The banner consists of multiple lines of exclamation marks with
+    "DEBUG MODE" prominently displayed in the center.
+
+    Examples
+    --------
+    >>> # At the start of debug runs
+    >>> if DEBUG:
+    ...     print_debug()
+    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+    !!!!!!!!!!!!!!!!!!!!!!!! DEBUG MODE !!!!!!!!!!!!!!!!!!!!!!!!
+    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+    >>> # In configuration validation
+    >>> if config.debug_mode:
+    ...     print_debug()
+    ...     print("Debug logging enabled")
+
+    See Also
+    --------
+    printc : Colored printing function used internally
+
+    Notes
+    -----
+    The banner is printed in yellow color to ensure high visibility
+    in terminal output.
+    """
+    printc(
+        (
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*24} DEBUG MODE {'!'*24}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}\n"
+            f"{'!'*60}"
+        ),
+        c="yellow",
+        char="!",
+        n=60,
+    )
+
+
+# EOF

scitex/str/_printc.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: "2025-06-14 19:09:38 (ywatanabe)"
+# File: /ssh:sp:/home/ywatanabe/proj/SciTeX-Code/src/scitex/str/_printc.py
+# ----------------------------------------
+import os
+__FILE__ = (
+    "./src/scitex/str/_printc.py"
+)
+__DIR__ = os.path.dirname(__FILE__)
+# ----------------------------------------
+# Time-stamp: "2024-11-24 17:01:23 (ywatanabe)"
+
+THIS_FILE = "/home/ywatanabe/proj/scitex_repo/src/scitex/str/_printc.py"
+
+# Time-stamp: "2024-11-03 03:47:51 (ywatanabe)"
+
+from ._color_text import color_text
+
+
+def printc(message, c="blue", char="-", n=40):
+    """Print a message surrounded by a character border.
+
+    This function prints a given message surrounded by a border made of
+    a specified character. The border can be colored if desired.
+
+    Parameters
+    ----------
+    message : str
+        The message to be printed inside the border.
+    char : str, optional
+        The character used to create the border (default is "-").
+    n : int, optional
+        The width of the border (default is 40).
+    c : str, optional
+        The color of the border. Can be 'red', 'green', 'yellow', 'blue',
+        'magenta', 'cyan', 'white', or 'grey' (default is None, which means no color).
+
+    Returns
+    -------
+    None
+
+    Example
+    -------
+    >>> print_block("Hello, World!", char="*", n=20, c="blue")
+    ********************
+    * Hello, World!    *
+    ********************
+
+    Note: The actual output will be in green color.
+    """
+    if char is not None:
+        border = char * n
+        text = f"\n{border}\n{message}\n{border}\n"
+    else:
+        text = f"\n{message}\n"
+    if c is not None:
+        text = color_text(text, c)
+
+    print(text)
+
+# EOF

scitex/str/_readable_bytes.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-02 04:06:54 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_readable_bytes.py
+
+
+def readable_bytes(num, suffix="B"):
+    """Convert a number of bytes to a human-readable format.
+
+    Parameters
+    ----------
+    num : int
+        The number of bytes to convert.
+    suffix : str, optional
+        The suffix to append to the unit (default is "B" for bytes).
+
+    Returns
+    -------
+    str
+        A human-readable string representation of the byte size.
+
+    Example
+    -------
+    >>> readable_bytes(1024)
+    '1.0 KiB'
+    >>> readable_bytes(1048576)
+    '1.0 MiB'
+    >>> readable_bytes(1073741824)
+    '1.0 GiB'
+    """
+    for unit in ["", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"]:
+        if abs(num) < 1024.0:
+            return "%3.1f %s%s" % (num, unit, suffix)
+        num /= 1024.0
+    return "%.1f %s%s" % (num, "Yi", suffix)
+
+
+# EOF

scitex/str/_remove_ansi.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-04 01:21:34 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_remove_ansi.py
+
+import re
+
+
+def remove_ansi(string):
+    """
+    Removes ANSI escape sequences from a given text chunk.
+
+    Parameters:
+    - chunk (str): The text chunk to be cleaned.
+
+    Returns:
+    - str: The cleaned text chunk.
+    """
+    ansi_escape = re.compile(r"\x1B[@-_][0-?]*[ -/]*[@-~]")
+    return ansi_escape.sub("", string)
+
+
+# EOF

scitex/str/_replace.py

@@ -0,0 +1,134 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-16 16:34:46 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_replace.py
+
+THIS_FILE = "/home/ywatanabe/proj/scitex_repo/src/scitex/str/_replace.py"
+
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-16 16:30:25 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_replace.py
+
+THIS_FILE = "/home/ywatanabe/proj/scitex_repo/src/scitex/str/_replace.py"
+
+from typing import Union, Dict, Optional
+from ..dict import DotDict as _DotDict
+
+
+def replace(
+    string: str, replacements: Optional[Union[str, Dict[str, str]]] = None
+) -> str:
+    """Replace placeholders in the string with corresponding values from replacements.
+
+    This function replaces placeholders in the format {key} within the input string
+    with corresponding values from the replacements dictionary. If replacements is
+    a string, it replaces the entire input string.
+
+    Parameters
+    ----------
+    string : str
+        The string containing placeholders in the format {key}
+    replacements : Optional[Union[str, Dict[str, str]]], optional
+        A dictionary containing key-value pairs for replacing placeholders in the string,
+        or a single string to replace the entire string
+
+    Returns
+    -------
+    str
+        The input string with placeholders replaced by their corresponding values
+
+    Examples
+    --------
+    >>> replace("Hello, {name}!", {"name": "World"})
+    'Hello, World!'
+    >>> replace("Original string", "New string")
+    'New string'
+    >>> replace("Value: {x}", {"x": "42"})
+    'Value: 42'
+    >>> template = "Hello, {name}! You are {age} years old."
+    >>> replacements = {"name": "Alice", "age": "30"}
+    >>> replace(template, replacements)
+    'Hello, Alice! You are 30 years old.'
+    """
+    if not isinstance(string, str):
+        raise TypeError("Input 'string' must be a string")
+
+    if isinstance(replacements, str):
+        return replacements
+
+    if replacements is None:
+        return string
+
+    if not isinstance(replacements, (dict, _DotDict)):
+        raise TypeError("replacements must be either a string or a dictionary")
+
+    result = string
+    for key, value in replacements.items():
+        if value is not None:
+            placeholder = "{" + str(key) + "}"
+            result = result.replace(placeholder, str(value))
+
+    return result
+
+
+# EOF
+
+# #!/usr/bin/env python3
+# # -*- coding: utf-8 -*-
+# # Time-stamp: "2024-11-16 16:30:25 (ywatanabe)"
+# # File: ./scitex_repo/src/scitex/str/_replace.py
+
+# THIS_FILE = "/home/ywatanabe/proj/scitex_repo/src/scitex/str/_replace.py"
+
+# def replace(string, replacements):
+#     """Replace placeholders in the string with corresponding values from replacements.
+
+#     This function replaces placeholders in the format {key} within the input string
+#     with corresponding values from the replacements dictionary. If replacements is
+#     a string, it replaces the entire input string.
+
+#     Parameters
+#     ----------
+#     string : str
+#         The string containing placeholders in the format {key}.
+#     replacements : dict or str, optional
+#         A dictionary containing key-value pairs for replacing placeholders in the string,
+#         or a single string to replace the entire string.
+
+#     Returns
+#     -------
+#     str
+#         The input string with placeholders replaced by their corresponding values.
+
+#     Examples
+#     --------
+#     >>> replace("Hello, {name}!", {"name": "World"})
+#     'Hello, World!'
+#     >>> replace("Original string", "New string")
+#     'New string'
+#     >>> replace("Value: {x}", {"x": 42})
+#     'Value: 42'
+#     >>> template = "Hello, {name}! You are {age} years old."
+#     >>> replacements = {"name": "Alice", "age": "30"}
+#     >>> replace(template, replacements)
+#     'Hello, Alice! You are 30 years old.'
+#     """
+#     if isinstance(replacements, str):
+#         return replacements
+
+#     if replacements is None:
+#         replacements = {}
+
+#     for k, v in replacements.items():
+#         if v is not None:
+#             try:
+#                 string = string.replace("{" + k + "}", v)
+#             except Exception as e:
+#                 pass
+#     return string
+
+
+#
+
+# EOF

scitex/str/_search.py

@@ -0,0 +1,125 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-13 14:25:59 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_search.py
+
+import re
+from collections import abc
+
+import numpy as np
+import pandas as pd
+import xarray as xr
+from natsort import natsorted
+
+
+def search(
+    patterns,
+    strings,
+    only_perfect_match=False,
+    as_bool=False,
+    ensure_one=False,
+):
+    """Search for patterns in strings using regular expressions.
+
+    Parameters
+    ----------
+    patterns : str or list of str
+        The pattern(s) to search for. Can be a single string or a list of strings.
+    strings : str or list of str
+        The string(s) to search in. Can be a single string or a list of strings.
+    only_perfect_match : bool, optional
+        If True, only exact matches are considered (default is False).
+    as_bool : bool, optional
+        If True, return a boolean array instead of indices (default is False).
+    ensure_one : bool, optional
+        If True, ensures only one match is found (default is False).
+
+    Returns
+    -------
+    tuple
+        A tuple containing two elements:
+        - If as_bool is False: (list of int, list of str)
+          The first element is a list of indices where matches were found.
+          The second element is a list of matched strings.
+        - If as_bool is True: (numpy.ndarray of bool, list of str)
+          The first element is a boolean array indicating matches.
+          The second element is a list of matched strings.
+
+    Example
+    -------
+    >>> patterns = ['orange', 'banana']
+    >>> strings = ['apple', 'orange', 'apple', 'apple_juice', 'banana', 'orange_juice']
+    >>> search(patterns, strings)
+    ([1, 4, 5], ['orange', 'banana', 'orange_juice'])
+
+    >>> patterns = 'orange'
+    >>> strings = ['apple', 'orange', 'apple', 'apple_juice', 'banana', 'orange_juice']
+    >>> search(patterns, strings)
+    ([1, 5], ['orange', 'orange_juice'])
+    """
+
+    def to_list(string_or_pattern):
+        """Convert various input types to a list.
+
+        Handles conversion of different data structures to lists for
+        consistent processing in the search function.
+
+        Parameters
+        ----------
+        string_or_pattern : str, list, tuple, array-like, or dict_keys
+            Input to be converted to list format.
+
+        Returns
+        -------
+        list
+            The input converted to list format.
+
+        Examples
+        --------
+        >>> to_list('hello')
+        ['hello']
+
+        >>> to_list(['a', 'b'])
+        ['a', 'b']
+
+        >>> to_list(np.array(['x', 'y']))
+        ['x', 'y']
+        """
+        if isinstance(string_or_pattern, (np.ndarray, pd.Series, xr.DataArray)):
+            return string_or_pattern.tolist()
+        elif isinstance(string_or_pattern, abc.KeysView):
+            return list(string_or_pattern)
+        elif not isinstance(string_or_pattern, (list, tuple, pd.Index)):
+            return [string_or_pattern]
+        return string_or_pattern
+
+    patterns = to_list(patterns)
+    strings = to_list(strings)
+
+    indices_matched = []
+    for pattern in patterns:
+        for index_str, string in enumerate(strings):
+            if only_perfect_match:
+                if pattern == string:
+                    indices_matched.append(index_str)
+            else:
+                if re.search(pattern, string):
+                    indices_matched.append(index_str)
+
+    indices_matched = natsorted(indices_matched)
+    keys_matched = list(np.array(strings)[indices_matched])
+
+    if ensure_one:
+        assert (
+            len(indices_matched) == 1
+        ), "Expected exactly one match, but found {}".format(len(indices_matched))
+
+    if as_bool:
+        bool_matched = np.zeros(len(strings), dtype=bool)
+        bool_matched[np.unique(indices_matched)] = True
+        return bool_matched, keys_matched
+    else:
+        return indices_matched, keys_matched
+
+
+# EOF

scitex/str/_squeeze_space.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-11-02 04:04:31 (ywatanabe)"
+# File: ./scitex_repo/src/scitex/str/_squeeze_space.py
+
+import re
+
+
+def squeeze_spaces(string, pattern=" +", repl=" "):
+    """Replace multiple occurrences of a pattern in a string with a single replacement.
+
+    Parameters
+    ----------
+    string : str
+        The input string to be processed.
+    pattern : str, optional
+        The regular expression pattern to match (default is " +", which matches one or more spaces).
+    repl : str or callable, optional
+        The replacement string or function (default is " ", a single space).
+
+    Returns
+    -------
+    str
+        The processed string with pattern occurrences replaced.
+
+    Example
+    -------
+    >>> squeeze_spaces("Hello   world")
+    'Hello world'
+    >>> squeeze_spaces("a---b--c-d", pattern="-+", repl="-")
+    'a-b-c-d'
+    """
+    return re.sub(pattern, repl, string)
+
+
+# EOF

scitex/tex/__init__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+"""LaTeX utilities module for scitex."""
+
+from ._preview import preview
+from ._to_vec import to_vec
+
+__all__ = [
+    "preview",
+    "to_vec",
+]

scitex/tex/_preview.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2025-06-05 12:00:00 (ywatanabe)"
+# File: ./src/scitex/tex/_preview.py
+
+"""
+LaTeX preview functionality with fallback mechanisms.
+
+Functionality:
+    - Generate previews of LaTeX strings with automatic fallback
+    - Handle LaTeX rendering failures gracefully
+Input:
+    List of LaTeX strings
+Output:
+    Matplotlib figure with previews
+Prerequisites:
+    matplotlib, numpy, scitex.plt, scitex.str._latex_fallback
+"""
+
+import numpy as np
+
+try:
+    from ..str._latex_fallback import safe_latex_render, latex_fallback_decorator
+    FALLBACK_AVAILABLE = True
+except ImportError:
+    FALLBACK_AVAILABLE = False
+    def latex_fallback_decorator(fallback_strategy="auto", preserve_math=True):
+        def decorator(func):
+            return func
+        return decorator
+    
+    def safe_latex_render(text, fallback_strategy="auto", preserve_math=True):
+        return text
+
+
+@latex_fallback_decorator(fallback_strategy="auto", preserve_math=True)
+def preview(tex_str_list, enable_fallback=True):
+    r"""
+    Generate a preview of LaTeX strings with automatic fallback.
+
+    Parameters
+    ----------
+    tex_str_list : list of str
+        List of LaTeX strings to preview
+    enable_fallback : bool, optional
+        Whether to enable LaTeX fallback mechanisms, by default True
+
+    Returns
+    -------
+    matplotlib.figure.Figure
+        Figure containing the previews
+
+    Examples
+    --------
+    >>> tex_strings = ["x^2", r"\sum_{i=1}^n i", r"\alpha + \beta"]
+    >>> fig = preview(tex_strings)
+    >>> scitex.plt.show()
+    
+    Notes
+    -----
+    If LaTeX rendering fails, this function automatically falls back to 
+    mathtext or unicode alternatives while preserving the preview layout.
+    """
+    from ..plt import subplots
+
+    if not isinstance(tex_str_list, (list, tuple)):
+        tex_str_list = [tex_str_list]
+
+    fig, axes = subplots(
+        nrows=len(tex_str_list), ncols=1, figsize=(10, 3 * len(tex_str_list))
+    )
+    axes = np.atleast_1d(axes)
+    
+    for ax, tex_string in zip(axes, tex_str_list):
+        try:
+            # Original LaTeX string (raw)
+            if enable_fallback and FALLBACK_AVAILABLE:
+                safe_raw = safe_latex_render(tex_string, "unicode", preserve_math=False)
+                ax.text(0.5, 0.7, safe_raw, size=20, ha="center", va="center")
+            else:
+                ax.text(0.5, 0.7, tex_string, size=20, ha="center", va="center")
+            
+            # LaTeX-formatted string
+            latex_formatted = f"${tex_string}$" if not (tex_string.startswith("$") and tex_string.endswith("$")) else tex_string
+            
+            if enable_fallback and FALLBACK_AVAILABLE:
+                safe_latex = safe_latex_render(latex_formatted, preserve_math=True)
+                ax.text(0.5, 0.3, safe_latex, size=20, ha="center", va="center")
+            else:
+                ax.text(0.5, 0.3, latex_formatted, size=20, ha="center", va="center")
+                
+        except Exception as e:
+            # Fallback for individual preview failures
+            ax.text(0.5, 0.7, f"Raw: {tex_string}", size=16, ha="center", va="center")
+            ax.text(0.5, 0.3, f"Error: {str(e)[:50]}...", size=12, ha="center", va="center", color='red')
+            
+        ax.hide_spines()
+        
+    fig.tight_layout()
+    return fig
+
+
+# EOF