Migrate configuration from INI to YAML

Author: 6C656C65

.dockerignore

@@ -10,7 +10,7 @@ certs/*.pem
 !certs/ca/*
 
 tests/
-config.ini.example
+config.yaml.example
 
 .github
 .bumpversion.cfg

CHANGELOG.md

@@ -6,6 +6,7 @@
 - Update dependencies
 - Change Flake8, Black and Bandit for Ruff
 - Move benchmarking tool (https://github.com/pyproxytools/pyproxy-benchmark)
+- Change configuration file format to yaml
 
 ## [0.4.6] - 2025-06-12
 ### Added

config.ini.example

@@ -0,0 +1,44 @@
+server:
+  host: "0.0.0.0"
+  port: 8080
+
+logging:
+  debug: false
+  access_log: "./logs/access.log"
+  block_log: "./logs/block.log"
+  no_logging_access: false
+  no_logging_block: false
+  console_format: "date=%(asctime)s level=%(levelname)s file=%(filename)s function=%(funcName)s message=%(message)s"
+  access_log_format: "date=%(asctime)s ip_src=%(ip_src)s url=%(url)s method=%(method)s domain=%(domain)s port=%(port)s protocol=%(protocol)s bytes_sent=%(bytes_sent)s bytes_received=%(bytes_received)s tls_version=%(tls_version)s"
+  block_log_format: "date=%(asctime)s ip_src=%(ip_src)s url=%(url)s method=%(method)s domain=%(domain)s port=%(port)s protocol=%(protocol)s"
+  datefmt: "%Y-%m-%d %H:%M:%S"
+
+files:
+  html_403: "assets/403.html"
+
+filtering:
+  no_filter: false
+  filter_mode: "local"
+  blocked_sites: "config/blocked_sites.txt"
+  blocked_url: "config/blocked_url.txt"
+
+options:
+  shortcuts: "config/shortcuts.txt"
+  custom_header: "config/custom_header.json"
+  authorized_ips: "config/authorized_ips.txt"
+
+security:
+  ssl_inspect: false
+  inspect_ca_cert: "certs/ca/cert.pem"
+  inspect_ca_key: "certs/ca/key.pem"
+  inspect_certs_folder: "certs/"
+  cancel_inspect: "config/cancel_inspect.txt"
+
+monitoring:
+  flask_port: 5000
+  flask_pass: "password"
+
+proxy:
+  proxy_enable: false
+  proxy_host: "127.0.0.1"
+  proxy_port: 8081

config.yaml.example

@@ -14,7 +14,7 @@ services:
       #- ./certs/ca:/app/certs/ca
       #- ./config:/app/config
       #- ./logs:/app/logs
-      #- ./config.ini:/app/config.ini
+      #- ./config.yaml:/app/config.yaml
     environment:
       PYPROXY_HOST: 0.0.0.0
       PYPROXY_PORT: 8080

docker-compose.yml

@@ -49,10 +49,10 @@ def main():
         port=get_config_value(args, config, "proxy_port", "Proxy", 8081),
     )
 
-    console_format = config.get("Logging", "console_format", fallback=None)
-    access_log_format = config.get("Logging", "access_log_format", fallback=None)
-    block_log_format = config.get("Logging", "block_log_format", fallback=None)
-    datefmt = config.get("Logging", "datefmt", fallback=None)
+    console_format = get_config_value(args, config, "console_format", "Logging", None)
+    access_log_format = get_config_value(args, config, "access_log_format", "Logging", None)
+    block_log_format = get_config_value(args, config, "block_log_format", "Logging", None)
+    datefmt = get_config_value(args, config, "datefmt", "Logging", None)
 
     logger_config = ProxyConfigLogger(
         access_log=get_config_value(args, config, "access_log", "Logging", "logs/access.log"),

pyproxy/pyproxy.py

@@ -4,9 +4,10 @@
 This module allows you to read the program configuration file and return the values.
 """
 
-import configparser
 import argparse
 import os
+import yaml
+from typing import Any
 from rich_argparse import MetavarTypeRichHelpFormatter
 from pyproxy import __version__
 
@@ -27,49 +28,49 @@ def parse_args() -> argparse.Namespace:
     )
     parser.add_argument(
         "-v", "--version", action="version", version=__version__, help="Show version"
-    )  # noqa: E501
+    )
     parser.add_argument("--debug", action="store_true", help="Enable debug logging")
     parser.add_argument("-H", "--host", type=str, help="IP address to listen on")
     parser.add_argument("-P", "--port", type=int, help="Port to listen on")
     parser.add_argument(
         "-f",
         "--config-file",
         type=str,
-        default="./config.ini",
-        help="Path to config.ini file",
-    )  # noqa: E501
+        default="./config.yaml",
+        help="Path to config.yaml file",
+    )
     parser.add_argument("--access-log", type=str, help="Path to the access log file")
     parser.add_argument("--block-log", type=str, help="Path to the block log file")
     parser.add_argument("--html-403", type=str, help="Path to the custom 403 Forbidden HTML page")
     parser.add_argument("--no-filter", action="store_true", help="Disable URL and domain filtering")
     parser.add_argument(
         "--filter-mode", type=str, choices=["local", "http"], help="Filter list mode"
-    )  # noqa: E501
+    )
     parser.add_argument(
         "--blocked-sites",
         type=str,
         help="Path to the text file containing the list of sites to block",
-    )  # noqa: E501
+    )
     parser.add_argument(
         "--blocked-url",
         type=str,
         help="Path to the text file containing the list of URLs to block",
-    )  # noqa: E501
+    )
     parser.add_argument(
         "--shortcuts",
         type=str,
         help="Path to the text file containing the list of shortcuts",
-    )  # noqa: E501
+    )
     parser.add_argument(
         "--custom-header",
         type=str,
         help="Path to the json file containing the list of custom headers",
-    )  # noqa: E501
+    )
     parser.add_argument(
         "--authorized-ips",
         type=str,
         help="Path to the txt file containing the list of authorized ips",
-    )  # noqa: E501
+    )
     parser.add_argument("--no-logging-access", action="store_true", help="Disable access logging")
     parser.add_argument("--no-logging-block", action="store_true", help="Disable block logging")
     parser.add_argument("--ssl-inspect", action="store_true", help="Enable SSL inspection")
@@ -79,12 +80,12 @@ def parse_args() -> argparse.Namespace:
         "--inspect-certs-folder",
         type=str,
         help="Path to the generated certificates folder",
-    )  # noqa: E501
+    )
     parser.add_argument(
         "--cancel-inspect",
         type=str,
         help="Path to the text file containing the list of URLs without ssl inspection",
-    )  # noqa: E501
+    )
     parser.add_argument("--flask-port", type=int, help="Port to listen on for monitoring interface")
     parser.add_argument("--flask-pass", type=int, help="Default password to Flask interface")
     parser.add_argument("--proxy-enable", action="store_true", help="Enable proxy after PyProxy")
@@ -94,63 +95,65 @@ def parse_args() -> argparse.Namespace:
     return parser.parse_args()
 
 
-def load_config(config_path: str) -> configparser.ConfigParser:
+def load_config(config_path: str) -> dict[str, Any]:
     """
-    Loads the configuration file and returns the parsed config object.
+    Loads the YAML configuration file and returns it as a dictionary.
 
     Args:
-        config_path (str): The path to the configuration file to load.
+        config_path (str): Path to config.yaml
 
     Returns:
-        configparser.ConfigParser: The parsed configuration object.
+        dict[str, Any]: Parsed YAML configuration
     """
-    config = configparser.ConfigParser(interpolation=None)
-    config.read(config_path)
+    with open(config_path, "r", encoding="utf-8") as f:
+        config = yaml.safe_load(f)
+    if not isinstance(config, dict):
+        raise ValueError("Invalid YAML configuration format.")
     return config
 
 
 def get_config_value(
     args: argparse.Namespace,
-    config: configparser.ConfigParser,
+    config: dict[str, Any],
     arg_name: str,
     section: str,
     fallback_value: str,
-) -> str:
+) -> Any:
     """
-    Retrieves the configuration value, either from the command-line
-                        arguments or from the config file.
+    Retrieves the configuration value, either from CLI args, environment vars, or YAML config.s
 
     Args:
-        args (argparse.Namespace): The parsed command-line arguments object.
-        config (configparser.ConfigParser): The parsed configuration object.
-        arg_name (str): The name of the command-line argument.
-        section (str): The section in the config file where the value is located.
-        fallback_value (str): The fallback value to return if neither
-                        argument nor config has a value.
+        args (argparse.Namespace): Parsed CLI args
+        config (dict[str, Any]): YAML config
+        arg_name (str): Argument name
+        section (str): Section name (as top-level YAML key)s
+        fallback_value (Any): Default value
 
     Returns:
-        str: The final value, either from command-line arguments, config file, or fallback.
+        Any: The resulting value
     """
     arg_value = getattr(args, arg_name, None)
-    if arg_value:
+    if arg_value not in (None, False, ""):
         return arg_value
 
     env_var_name = f"PYPROXY_{arg_name.upper().replace('-', '_')}"
     env_value = os.getenv(env_var_name)
     if env_value:
         return env_value
 
-    return config.get(section, arg_name, fallback=fallback_value)
+    section_lower = section.lower()
+    if section_lower in config:
+        section_data = config[section_lower]
+        if isinstance(section_data, dict):
+            return section_data.get(arg_name, fallback_value)
 
+    return fallback_value
 
-def str_to_bool(value: str) -> bool:
-    """
-    Converts a string representation of truth to a boolean value.
 
-    Args:
-        value (str): The value to convert (e.g., "true", "1", "yes").
-
-    Returns:
-        bool: True if the string represents a true value, False otherwise.
+def str_to_bool(value: Any) -> bool:
+    """
+    Converts a string-like values into booleans
     """
+    if isinstance(value, bool):
+        return value
     return str(value).lower() in ("yes", "true", "t", "1")