Instruction on format_string.py script

Owner: Vadim Rudakov, rudakow.wadim@gmail.com Version: 0.2.0 Birth: 2026-01-07 Last Modified: 2026-01-26

This script formats a given input string by applying several transformations to make it URL-safe and filesystem-friendly. The transformations include converting to lowercase, replacing specific special characters, removing unwanted words, and truncating the string if necessary.

Synopsis¶

format_string.py 'Your Input String'

Transformation Logic¶

1. Convert to Lowercase: All characters in the input string are converted to lowercase.

2. Replace & with and: The ampersand (&) is replaced with the word “and”.

3. Remove Special Symbols: Certain special symbols (e.g., "the ", “(”, “)”, "# ", “#”, “`”, “~”, “$”, “%”, “@”) are removed from the string.

4. Replace Special Symbols with Underscores: Other special symbols (e.g., “.”, “,”, “;”, “:”, “!”, “?”, “-”, “/”, “\”, “|”, “<”, “>”, “*”) are replaced with underscores (_).

5. Remove Multiple Underscores: Any sequence of multiple underscores is reduced to a single underscore.

6. Replace Spaces with Underscores: All spaces in the string are replaced with underscores.

7. Truncate Long Strings: If the resulting string exceeds 50 characters, it is truncated to 50 characters.

8. Remove Trailing Underscore: If the final character of the string is an underscore, it is removed.

Examples¶

Test Suite¶

The test suite covers all transformation rules:

Run tests with:

uv run pytest tools/tests/test_format_string.py -v