| 1 | # strings.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `strings.py` helper module. |
| 6 | - This module sanitizes, formats, truncates, and expands framework string content. |
| 7 | - Keep this file-level DOX profile synchronized with `strings.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `strings.py` owns the runtime implementation. |
| 12 | - `strings.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Top-level functions: |
| 14 | - `sanitize_string(s: str, encoding: str=...) -> str` |
| 15 | - `calculate_valid_match_lengths(first: bytes | str, second: bytes | str, deviation_threshold: int=..., deviation_reset: int=..., ignore_patterns: list[bytes | str]=..., debug: bool=...) -> tuple[int, int]` |
| 16 | - `format_key(key: str) -> str`: Format a key string to be more readable. |
| 17 | - `dict_to_text(d: dict) -> str` |
| 18 | - `truncate_text(text: str, length: int, at_end: bool=..., replacement: str=...) -> str` |
| 19 | - `truncate_text_by_ratio(text: str, threshold: int, replacement: str=..., ratio: float=...) -> str`: Truncate text with replacement at a specified ratio position. |
| 20 | - `replace_file_includes(text: str, placeholder_pattern: str=...) -> str` |
| 21 | |
| 22 | ## Runtime Contracts |
| 23 | |
| 24 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 25 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 26 | - Observed side-effect areas: filesystem reads, filesystem deletion. |
| 27 | - Imported dependency areas include: `helpers`, `re`, `sys`, `time`. |
| 28 | |
| 29 | ## Key Concepts |
| 30 | |
| 31 | - Important called helpers/classes observed in the source: `s.encode.decode`, `join`, `join.rstrip`, `re.sub`, `skip_ignored_patterns`, `match.group`, `s.encode`, `sys.stdout.write`, `sys.stdout.flush`, `time.sleep`, `c.isupper`, `result.islower`, `word.capitalize`, `files.fix_dev_path`, `files.read_file`, `re.match`, `formatted.split`, `c.isalnum`, `format_key`. |
| 32 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 33 | |
| 34 | ## Work Guidance |
| 35 | |
| 36 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 37 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 38 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 39 | |
| 40 | ## Verification |
| 41 | |
| 42 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 43 | - Related tests observed by source search: |
| 44 | - `tests/test_model_search.py` |
| 45 | - `tests/test_whatsapp_number_utils.py` |
| 46 | |
| 47 | ## Child DOX Index |
| 48 | |
| 49 | No child DOX files. |