Module `osbot_utils.utils.Str`

Expand source code

import textwrap
from html import escape, unescape

from osbot_utils.utils.Files import safe_file_name

# todo: refactor this this class all str related methods (mainly from the Misc class)

def html_escape(value: str):
    return escape(value)

def html_unescape(value: str):
    return unescape(value)

def strip_quotes(value: str):                           # Remove surrounding quotes (single or double)
    if (value.startswith("'") and value.endswith("'")) or (value.startswith('"') and value.endswith('"')):
        return value[1:-1]
    return value

def str_dedent(value, strip=True):
    result = textwrap.dedent(value)
    if strip:
        result = result.strip()
    return result

def str_index(target:str, source:str):
    try:
        return target.index(source)
    except:
        return -1

def str_join(delimiter, values):
    return delimiter.join(values)

def str_max_width(target, value):
    return str(target)[:value]

def str_safe(value):
    return safe_file_name(value)

def str_starts_with(source, prefix):
    if source is None or prefix is None:
        return False
    else:
        return source.startswith(prefix)

def str_unicode_escape(target):
    return str(target).encode('unicode_escape').decode("utf-8")

def str_cap_snake_case(snake_str):
    """
    Converts a snake_case string to Capitalized_Snake_Case.

    Args:
        snake_str (str): The snake_case string to be converted.

    Returns:
        str: The converted string in Capitalized_Snake_Case.
    """
    return "_".join(word.capitalize() for word in snake_str.split("_"))


def trim(target):
    if type(target) is str:
        return target.strip()
    return ""

html_encode = html_escape
html_decode = html_unescape
safe_str    = str_safe

Functions

def html_decode(value: str)

Expand source code

def html_unescape(value: str):
    return unescape(value)

def html_encode(value: str)

Expand source code

def html_escape(value: str):
    return escape(value)

def html_escape(value: str)

Expand source code

def html_escape(value: str):
    return escape(value)

def html_unescape(value: str)

Expand source code

def html_unescape(value: str):
    return unescape(value)

def safe_str(value)

Expand source code

def str_safe(value):
    return safe_file_name(value)

def str_cap_snake_case(snake_str)

Converts a snake_case string to Capitalized_Snake_Case.

Args

snake_str : str: The snake_case string to be converted.

Returns

str: The converted string in Capitalized_Snake_Case.

Expand source code

def str_cap_snake_case(snake_str):
    """
    Converts a snake_case string to Capitalized_Snake_Case.

    Args:
        snake_str (str): The snake_case string to be converted.

    Returns:
        str: The converted string in Capitalized_Snake_Case.
    """
    return "_".join(word.capitalize() for word in snake_str.split("_"))

def str_dedent(value, strip=True)

Expand source code

def str_dedent(value, strip=True):
    result = textwrap.dedent(value)
    if strip:
        result = result.strip()
    return result

def str_index(target: str, source: str)

Expand source code

def str_index(target:str, source:str):
    try:
        return target.index(source)
    except:
        return -1

def str_join(delimiter, values)

Expand source code

def str_join(delimiter, values):
    return delimiter.join(values)

def str_max_width(target, value)

Expand source code

def str_max_width(target, value):
    return str(target)[:value]

def str_safe(value)

Expand source code

def str_safe(value):
    return safe_file_name(value)

def str_starts_with(source, prefix)

Expand source code

def str_starts_with(source, prefix):
    if source is None or prefix is None:
        return False
    else:
        return source.startswith(prefix)

def str_unicode_escape(target)

Expand source code

def str_unicode_escape(target):
    return str(target).encode('unicode_escape').decode("utf-8")

def strip_quotes(value: str)

Expand source code

def strip_quotes(value: str):                           # Remove surrounding quotes (single or double)
    if (value.startswith("'") and value.endswith("'")) or (value.startswith('"') and value.endswith('"')):
        return value[1:-1]
    return value

def trim(target)

Expand source code

def trim(target):
    if type(target) is str:
        return target.strip()
    return ""