🧩 utils.file_resolver

Overview

The File Resolver module provides the ConfigFileResolver class, which automates the injection of external file content into a JSON-based configuration. This is particularly useful for managing large or complex configurations where some values are best stored in separate files (such as documentation, HTML, or markdown content).

The resolver scans a configuration dictionary (or a JSON file) for keys ending with _file. When such a key is found, it replaces the key (removing the _file suffix) and populates it with the raw text content of the referenced file.

Key Features

• Recursive Resolution: Handles nested dictionaries and lists, resolving all *_file keys at any depth.

• Content Caching: Prevents redundant disk I/O by caching file contents during resolution.

• Flexible Input: Accepts a dictionary, a path to a JSON file, or a string path as input.

• Formatting Utilities: Includes methods for pretty-printing the resolved configuration and exporting it back to JSON.

• Supports Any File Type: Works with HTML, TXT, MD, and other text-based files.

API Reference

class owlmix.utils.file_resolver.ConfigFileResolver

A class to resolve file references in a configuration dictionary or JSON file.

Parameters:

config (dict or str) – Input configuration as a dictionary or path to a JSON file.

resolve() → dict

Resolves all *_file keys in the configuration and returns the updated dictionary.

Returns:

Resolved configuration with file contents injected.

Return type:

dict

pretty_print()

Prints the resolved configuration in a human-readable format.

to_json(file_path: str)

Exports the resolved configuration to a JSON file.

Parameters:

file_path (str) – Path to save the resolved configuration as JSON.

Example

from owlmix.utils.file_resolver import ConfigFileResolver

# Example input configuration
config = {
    "title": "My Report",
    "description_file": "docs/description.txt",
    "metadata": {
        "summary_file": "docs/summary.md"
    }
}

resolver = ConfigFileResolver(config)
resolved = resolver.resolve()

# Result:
# {
#     "title": "My Report",
#     "description": "<content of docs/description.txt>",
#     "metadata": {
#         "summary": "<content of docs/summary.md>"
#     }
# }

How It Works

• The resolver loads the configuration from a dictionary or JSON file.

• It recursively searches for keys ending with _file.

• For each such key, it reads the referenced file and replaces the key (removing _file) with the file’s content.

• The process is repeated for all nested dictionaries and lists.

Error Handling

• Raises TypeError if the input config is not a dict or a valid path to a JSON file.

• Raises FileNotFoundError if a referenced file does not exist.

---

For more advanced usage and examples, see the user guide and API documentation.

Back to Home