Python String Utilities

Warnings

• gotcha The library has not been updated since March 2020 (version 1.0.0) and was last tested against Python versions 3.5-3.8. While it may still function on newer Python versions, active development and official compatibility for Python 3.9+ are not guaranteed, which could lead to unforeseen issues or a lack of support for modern Python features.
  Fix: For new projects, consider modern alternatives within Python's standard library (e.g., f-strings, `pathlib` for path manipulation) or more actively maintained string utility libraries. If using this library, thorough testing on your target Python version is recommended.
• gotcha Many string manipulation and validation tasks can now be handled efficiently and often more 'pythonically' using built-in Python features such as f-strings for formatting, the `re` module for complex regex patterns, and `pathlib` for robust path operations. Relying heavily on older utility libraries for these tasks might introduce unnecessary dependencies or overlook more idiomatic Python solutions.
  Fix: Evaluate if a specific `python-string-utils` function provides unique value compared to current Python standard library features (e.g., `str` methods, `re`, `pathlib`). Prioritize standard library solutions where they meet requirements for better maintainability and fewer external dependencies.
• gotcha The `is_string` function specifically checks if an object is of type `str` and returns `False` for byte strings (`bytes`). This might be a footgun if you expect it to validate any string-like object, including byte strings, which are common in I/O or network operations.
  Fix: Be explicit about the string type you are expecting. If byte strings are a possibility, check `isinstance(obj, (str, bytes))` or convert byte strings to `str` before validation, e.g., `obj.decode('utf-8')`.

Install

• pip install python-string-utils Install stable version

Imports

• is_email

  from string_utils import is_email

  While importing from submodules like `string_utils.validation` works, the library makes all public API functions directly importable from the top-level `string_utils` package for convenience.
• prettify

  from string_utils import prettify

  Functions for string manipulation are available directly from the top-level package.

Quickstart

The quickstart demonstrates importing and using core validation and manipulation functions like `is_email`, `prettify`, and `is_full_string`. All public API functions are importable directly from the `string_utils` package.

from string_utils import is_email, prettify, is_full_string

# Example 1: Validate an email address
email = "test@example.com"
print(f"'{email}' is a valid email: {is_email(email)}")

# Example 2: Prettify a string
unprettified_string = "  unprettified string ,, like this one,will be\"prettified\" . it' s awesome! "
prettified_string = prettify(unprettified_string)
print(f"Original: '{unprettified_string}'")
print(f"Prettified: '{prettified_string}'")

# Example 3: Check for non-empty string
empty_string = ""
non_empty_string = "hello"
print(f"'{empty_string}' is a full string: {is_full_string(empty_string)}")
print(f"'{non_empty_string}' is a full string: {is_full_string(non_empty_string)}")