Config Formatter

Warnings

• gotcha The `prettify` method returns a formatted string; it does not modify files in-place. Users must handle file I/O (reading and writing back to disk) explicitly. Improper handling (e.g., overwriting the original file before a successful write of the formatted content) can lead to data loss.
  Fix: Implement robust file I/O, such as writing the formatted content to a temporary file first and then atomically replacing the original file only after a successful write operation.
• gotcha While designed for standard `.ini` and `.cfg` files, highly custom or non-standard syntax (e.g., unusual comment styles, non-standard key-value assignments) might be reformatted in unexpected ways. This could potentially alter the intended structure or functionality if the formatter's interpretation differs from the application consuming the config.
  Fix: Always review the formatted output (e.g., via a `diff`) and thoroughly test configurations with the consuming application after formatting, especially for critical files or those with unusual syntax.
• gotcha The formatter aims to preserve comments. However, minor whitespace adjustments around comments or within multi-line values can occur during the formatting process. If exact byte-for-byte preservation of whitespace or comment positioning is critical (e.g., for `git diff` consistency or specific parser requirements), these subtle changes might be problematic.
  Fix: Visually inspect generated diffs and test the formatted files with the consuming application if precise whitespace or comment placement is essential for your use case.

Install

• pip install config-formatter Install stable version

Imports

• ConfigFormatter

  from config_formatter import ConfigFormatter

Quickstart

Initialize `ConfigFormatter` and use its `prettify` method to format a string containing `.ini` or `.cfg` content. The `prettify` method returns the formatted string, requiring manual file I/O for saving changes.

import os
from config_formatter import ConfigFormatter

# Create a dummy config file for demonstration
config_content_before = """
[main]
# A comment here
key1: value1
key2= value2

[section_one]
   long_key_name  =   multiline value\
  continues here
# Another comment
"""

with open("temp_config.ini", "w") as f:
    f.write(config_content_before)

# Read, format, and print the content
with open("temp_config.ini", "r") as file:
    formatter = ConfigFormatter()
    formatted_content = formatter.prettify(file.read())
    print("--- Original ---")
    print(config_content_before)
    print("\n--- Formatted ---")
    print(formatted_content)

# Clean up the dummy file
os.remove("temp_config.ini")