Files
Arkasha c095560e13 feat: improve documentation quality with real data
- Extract file-level docstrings from Python files (module-level string expressions)
- Use __init__.py docstrings as module doc_summary
- Use file docstrings as file purpose in layout tables (instead of 'Source file')
- Populate module outbound_modules/inbound_modules from import edges (internal only)
- Make filename sanitization consistent (sanitize_for_link matches sanitize_filename)
- Clean up stale .md files from previous runs before generating
- Fill ARCHITECTURE.md template with real layout, modules index, and critical points
- Add file_docstring field to ParsedModule and file_purpose to FileDoc
2026-02-15 04:10:20 +03:00

4.3 KiB

File: ./src/utils.py

  • Module: utils
  • Defined symbols: 4
  • Imports: 2

File intent (manual)

<FILL_MANUALLY>


Imports & file-level dependencies

Generated. Do not edit inside this block.

  • json
  • os

Symbols index

Generated. Do not edit inside this block.

  • load_config (Function)
  • save_config (Function)
  • get_file_size (Function)
  • format_bytes (Function)

Symbol details

load_config

  • Kind: Function
  • Signature: def load_config(config_path: str)
  • Docstring: Load configuration from a JSON file.

What it does

extracted from AST

Relations

Outbound calls (best-effort):

Inbound (used by) (best-effort):

Integrations (heuristic)

  • HTTP: no
  • DB: no
  • Queue/Tasks: no

Risk / impact

  • fan-in: 0
  • fan-out: 2
  • cycle participant: no
  • critical: no

Manual notes

<FILL_MANUALLY>

save_config

  • Kind: Function
  • Signature: def save_config(config: dict, config_path: str)
  • Docstring: Save configuration to a JSON file.

What it does

extracted from AST

Relations

Outbound calls (best-effort):

Inbound (used by) (best-effort):

Integrations (heuristic)

  • HTTP: no
  • DB: no
  • Queue/Tasks: no

Risk / impact

  • fan-in: 0
  • fan-out: 2
  • cycle participant: no
  • critical: no

Manual notes

<FILL_MANUALLY>

get_file_size

  • Kind: Function
  • Signature: def get_file_size(filepath: str)
  • Docstring: Get the size of a file in bytes.

What it does

extracted from AST

Relations

Outbound calls (best-effort):

Inbound (used by) (best-effort):

Integrations (heuristic)

  • HTTP: no
  • DB: no
  • Queue/Tasks: no

Risk / impact

  • fan-in: 0
  • fan-out: 1
  • cycle participant: no
  • critical: no

Manual notes

<FILL_MANUALLY>

format_bytes

  • Kind: Function
  • Signature: def format_bytes(size: int)
  • Docstring: Format bytes into a human-readable string.

What it does

extracted from AST

Relations

Outbound calls (best-effort):

Inbound (used by) (best-effort):

Integrations (heuristic)

  • HTTP: no
  • DB: no
  • Queue/Tasks: no

Risk / impact

  • fan-in: 0
  • fan-out: 0
  • cycle participant: no
  • critical: no

Manual notes

<FILL_MANUALLY>