| 1 | # yaml.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `yaml.py` helper module. |
| 6 | - This module wraps YAML loading/dumping and JSON conversion helpers. |
| 7 | - Keep this file-level DOX profile synchronized with `yaml.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `yaml.py` owns the runtime implementation. |
| 12 | - `yaml.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Top-level functions: |
| 14 | - `loads(text: str)` |
| 15 | - `dumps(obj, **kwargs) -> str` |
| 16 | - `from_json(text: str, **yaml_dump_kwargs) -> str` |
| 17 | - `to_json(text: str, **json_dump_kwargs) -> str` |
| 18 | |
| 19 | ## Runtime Contracts |
| 20 | |
| 21 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 22 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 23 | - Observed side-effect areas: filesystem writes, settings/state persistence. |
| 24 | - Imported dependency areas include: `json`, `yaml`. |
| 25 | |
| 26 | ## Key Concepts |
| 27 | |
| 28 | - Important called helpers/classes observed in the source: `yaml.safe_load`, `yaml.safe_dump`, `dumps`, `loads`, `json.dumps`, `json.loads`. |
| 29 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 30 | |
| 31 | ## Work Guidance |
| 32 | |
| 33 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 34 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 35 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 36 | |
| 37 | ## Verification |
| 38 | |
| 39 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 40 | - Related tests observed by source search: |
| 41 | - `tests/test_a0_connector_prompt_gating.py` |
| 42 | - `tests/test_browser_agent_regressions.py` |
| 43 | - `tests/test_document_query_plugin.py` |
| 44 | - `tests/test_model_config_api_keys.py` |
| 45 | - `tests/test_model_config_project_presets.py` |
| 46 | - `tests/test_oauth_codex.py` |
| 47 | - `tests/test_oauth_providers.py` |
| 48 | - `tests/test_office_canvas_setup.py` |
| 49 | |
| 50 | ## Child DOX Index |
| 51 | |
| 52 | No child DOX files. |