vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/helpers/secrets.py.dox.md
frdel e138e33ca9 Add file-level DOX docs & update AGENTS indexes 
Add comprehensive file-level DOX documentation across the repo and update directory AGENTS.md indexes. Many new `*.py.dox.md` files were added under api, helpers, tools, plugins, extensions, webui, and other dirs to document endpoint purpose, ownership, runtime contracts, work guidance, and verification. Several AGENTS.md files were created or updated (agents profiles, api, docker, extensions, helpers, plugins, skills, webui components, etc.) to list child DOX files and clarify documentation/work guidance. Also add example and bundled profile DOX files (agent0, default, developer, hacker, researcher) and minor updates to helpers/dirty_json.py and its tests. These changes improve on-disk documentation coverage and establish the convention that each direct runtime file should have a matching `*.dox.md` describing its contracts and verification steps.
2026-06-08 12:41:53 +02:00

3.3 KiB
Raw Permalink Blame History

secrets.py DOX

Purpose

  • Own the secrets.py helper module.
  • This module loads, aliases, masks, and streams secret values safely.
  • Keep this file-level DOX profile synchronized with secrets.py because this directory is intentionally flat.

Ownership

  • secrets.py owns the runtime implementation.
  • secrets.py.dox.md owns durable notes about responsibilities, contracts, side effects, and verification for that implementation.
  • Classes:
  • EnvLine (no explicit base class)
  • StreamingSecretsFilter (no explicit base class)
    • process_chunk(self, chunk: str) -> str
    • finalize(self) -> str
  • SecretsManager (no explicit base class)
    • get_instance(cls, *secrets_files) -> 'SecretsManager'
    • read_secrets_raw(self) -> str
    • load_secrets(self) -> Dict[str, str]
    • save_secrets(self, secrets_content: str)
    • save_secrets_with_merge(self, submitted_content: str)
    • get_keys(self) -> List[str]
    • get_secrets_for_prompt(self) -> str
    • create_streaming_filter(self) -> 'StreamingSecretsFilter'
  • Top-level functions:
  • alias_for_key(key: str, placeholder: str=...) -> str
  • get_secrets_manager(context: 'AgentContext|None'=...) -> SecretsManager
  • get_project_secrets_manager(project_name: str, merge_with_global: bool=...) -> SecretsManager
  • get_default_secrets_manager() -> SecretsManager
  • Notable constants/configuration names: ALIAS_PATTERN, DEFAULT_SECRETS_FILE.

Runtime Contracts

  • Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together.
  • Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change.
  • Observed side-effect areas: filesystem reads, filesystem writes, filesystem deletion, WebSocket state, settings/state persistence, secret handling.
  • Imported dependency areas include: dataclasses, dotenv.parser, helpers, helpers.errors, helpers.extension, io, os, re, threading, time, typing.

Key Concepts

  • Important called helpers/classes observed in the source: key.upper, placeholder.format, SecretsManager.get_instance, self._replace_full_values, self._longest_suffix_prefix, threading.RLock, join, files.write_file, self._invalidate_all_caches, self.load_secrets, self.read_secrets_raw, self.parse_env_lines, self._serialize_env_lines, StreamingSecretsFilter, re.sub, self.parse_env_content, parse_stream, AgentContext.current, projects.get_context_project_name, files.get_abs_path.
  • Keep request/response, tool, or helper semantics documented here at the same time as source changes.

Work Guidance

  • Preserve public helper APIs used by core code and plugins unless every caller is updated.
  • Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded.
  • Prefer adding cohesive helper functions here only when behavior is reused across modules.

Verification

  • Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers.
  • Related tests observed by source search:
    • tests/test_plugin_scan_prompt.py
    • tests/test_print_style.py
    • tests/test_time_travel.py

Child DOX Index

No child DOX files.