| 1 | # attachment_manager.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `attachment_manager.py` helper module. |
| 6 | - This module tracks uploaded or generated attachments associated with chat contexts. |
| 7 | - Keep this file-level DOX profile synchronized with `attachment_manager.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `attachment_manager.py` owns the runtime implementation. |
| 12 | - `attachment_manager.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Classes: |
| 14 | - `AttachmentManager` (no explicit base class) |
| 15 | - `is_allowed_file(self, filename: str) -> bool` |
| 16 | - `get_file_type(self, filename: str) -> str` |
| 17 | - `get_file_extension(filename: str) -> str` |
| 18 | - `validate_mime_type(self, file) -> bool` |
| 19 | - `save_file(self, file: FileStorage, name: str) -> Tuple[str, Dict]` |
| 20 | - `generate_image_preview(self, image_path: str, max_size: int=...) -> Optional[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 writes, settings/state persistence. |
| 27 | - Imported dependency areas include: `PIL`, `base64`, `helpers.print_style`, `helpers.security`, `io`, `os`, `typing`, `werkzeug.datastructures`. |
| 28 | |
| 29 | ## Key Concepts |
| 30 | |
| 31 | - Important called helpers/classes observed in the source: `os.makedirs`, `self.get_file_extension`, `set.union`, `filename.rsplit.lower`, `safe_filename`, `os.path.join`, `self.get_file_type`, `file.save`, `ValueError`, `self.generate_image_preview`, `PrintStyle.error`, `img.thumbnail`, `io.BytesIO`, `img.save`, `base64.b64encode.decode`, `mime_type.split`, `img.convert`, `filename.rsplit`, `base64.b64encode`, `buffer.getvalue`. |
| 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 | - No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check. |
| 44 | |
| 45 | ## Child DOX Index |
| 46 | |
| 47 | No child DOX files. |