Pythonで設定ファイルを読み込むならJSON？YAML？実用サンプル完全ガイド

{
  "app_name": "sample_app",
  "debug": true,
  "port": 8000,
  "database": {
    "host": "localhost",
    "port": 5432,
    "user": "app_user",
    "password": "secret"
  }
}

# config_loader_json.py
import json
from pathlib import Path

def load_config(path: str) -> dict:
    """JSON形式の設定ファイルを読み込んで辞書として返す関数"""
    config_path = Path(path)

    # ファイルの存在チェック
    if not config_path.exists():
        raise FileNotFoundError(f"設定ファイルが見つかりません: {config_path}")

    # 文字コードはUTF-8を推奨
    with config_path.open("r", encoding="utf-8") as f:
        # json.loadでファイルから直接読み込む
        config = json.load(f)

    return config

if __name__ == "__main__":
    # 同じディレクトリにあるconfig.jsonを読み込む例
    config = load_config("config.json")

    # 設定値の参照例
    print("アプリ名:", config.get("app_name"))
    print("デバッグ:", config.get("debug"))
    print("DBホスト:", config.get("database", {}).get("host"))

# config_writer_json.py
import json
from pathlib import Path

def save_config(path: str, config: dict) -> None:
    """辞書オブジェクトをJSON形式で保存する関数"""
    config_path = Path(path)

    # 親ディレクトリが存在しない場合は作成
    config_path.parent.mkdir(parents=True, exist_ok=True)

    # ensure_ascii=False と indent=2 で
    # ・日本語をそのまま保存
    # ・見やすい整形(インデント)を有効化
    with config_path.open("w", encoding="utf-8") as f:
        json.dump(config, f, ensure_ascii=False, indent=2)

if __name__ == "__main__":
    config_data = {
        "app_name": "sample_app",
        "debug": False,
        "port": 8080,
        "features": {
            "use_cache": True,
            "enable_metrics": True
        }
    }

    save_config("output_config.json", config_data)
    print("設定ファイルをoutput_config.jsonとして保存しました。")

{
  "app_name": "sample_app",
  "debug": false,
  "port": 8080,
  "features": {
    "use_cache": true,
    "enable_metrics": true
  }
}

{
  "logging": {
    "level": "INFO",
    "file": "logs/app.log"
  },
  "services": [
    {
      "name": "user_service",
      "base_url": "https://api.example.com/users",
      "timeout_sec": 5,
      "retries": 3
    },
    {
      "name": "payment_service",
      "base_url": "https://api.example.com/payments",
      "timeout_sec": 10,
      "retries": 5
    }
  ]
}

# services_config_example.py
import json
from pathlib import Path

def load_services_config(path: str) -> list[dict]:
    """services配列を取り出して返すユーティリティ関数"""
    with Path(path).open("r", encoding="utf-8") as f:
        config = json.load(f)

    # "services"キーが存在しない場合に備えて空リストをデフォルトに
    services = config.get("services", [])
    return services

if __name__ == "__main__":
    services = load_services_config("services_config.json")

    # サービスごとの設定を一覧表示
    for svc in services:
        name = svc.get("name")
        url = svc.get("base_url")
        timeout = svc.get("timeout_sec")
        retries = svc.get("retries")
        print(f"{name}: {url} (timeout={timeout}, retries={retries})")

{
  "port": 8000,
  "debug": true,
  "allowed_hosts": ["localhost", "example.com"],
  "extra": null
}

# json_types_example.py
import json

data = json.loads("""
{
  "port": 8000,
  "debug": true,
  "allowed_hosts": ["localhost", "example.com"],
  "extra": null
}
""")

print(data, type(data))
print("port:", data["port"], type(data["port"]))
print("debug:", data["debug"], type(data["debug"]))
print("allowed_hosts:", data["allowed_hosts"], type(data["allowed_hosts"]))
print("extra:", data["extra"], type(data["extra"]))

{
  "_comment": "デバッグ用フラグ。本番環境では必ずfalseにすること。",
  "debug": true,
  "port": 8000
}

{
  "app_name": "sample_app",
  "debug": true,
  "port": 8000,
  "database": {
    "host": "localhost",
    "port": 5432
  }
}

app_name: sample_app
debug: true
port: 8000
database:
  host: localhost
  port: 5432

pip install pyyaml

# config_loader_yaml.py
from pathlib import Path
import yaml  # PyYAML

def load_yaml_config(path: str) -> dict:
    """YAML形式の設定ファイルを読み込んで辞書として返す関数"""
    config_path = Path(path)

    if not config_path.exists():
        raise FileNotFoundError(f"設定ファイルが見つかりません: {config_path}")

    with config_path.open("r", encoding="utf-8") as f:
        # 安全な読み込みにはsafe_loadを使用
        config = yaml.safe_load(f)

    return config

if __name__ == "__main__":
    config = load_yaml_config("config.yaml")

    print("アプリ名:", config.get("app_name"))
    print("デバッグ:", config.get("debug"))
    print("DBホスト:", config.get("database", {}).get("host"))

app_name: sample_app
debug: true
database:
  host: localhost
  port: 5432

# db_config.yaml

# ベースとなるDB設定をアンカーで定義
default_db: &default_db
  host: localhost
  port: 5432
  user: app_user
  password: secret

# 開発環境のDB設定
development:
  <<: *default_db   # default_dbの内容をマージ
  database: app_dev

# 本番環境のDB設定
production:
  <<: *default_db
  host: db.prod.internal
  database: app_prod
  # 本番だけユーザー名とパスワードを変更
  user: app_prod_user
  password: super_secret

# yaml_anchor_example.py
import yaml
from pprint import pprint
from pathlib import Path

with Path("db_config.yaml").open("r", encoding="utf-8") as f:
    config = yaml.safe_load(f)

print("development設定:")
pprint(config["development"])

print("\nproduction設定:")
pprint(config["production"])

# app_settings.yaml
app_name: sample_app
start_date: 2024-01-01
maintenance:
  enabled: false
  schedule_at: 2024-02-01T10:00:00
  message: "定期メンテナンスのお知らせ"

# env_config.yaml

development:
  debug: true
  db_url: postgresql://dev_user:dev_pass@localhost/dev_db

staging:
  debug: false
  db_url: postgresql://stg_user:stg_pass@stg-db.internal/stg_db

production:
  debug: false
  db_url: postgresql://prod_user:prod_pass@prod-db.internal/prod_db

# env_config_loader.py
import os
from pathlib import Path
import yaml

def load_env_config(path: str, env: str) -> dict:
    """環境名(env)に対応する設定を返す"""
    with Path(path).open("r", encoding="utf-8") as f:
        all_config = yaml.safe_load(f)

    if env not in all_config:
        raise KeyError(f"環境 '{env}' の設定が見つかりません。定義されているのは: {list(all_config.keys())}")

    return all_config[env]

if __name__ == "__main__":
    # 環境変数APP_ENVから環境名を取得。なければdevelopmentをデフォルトに。
    env = os.environ.get("APP_ENV", "development")
    config = load_env_config("env_config.yaml", env)

    print(f"現在の環境: {env}")
    print("debug:", config["debug"])
    print("db_url:", config["db_url"])

{
  "app": {
    "name": "my_web_app",
    "debug": false,
    "host": "0.0.0.0",
    "port": 8000
  },
  "logging": {
    "level": "INFO",
    "file": "logs/app.log"
  },
  "database": {
    "url": "postgresql://app_user:secret@db:5432/app_db",
    "pool_size": 10,
    "max_overflow": 5
  },
  "external_api": {
    "base_url": "https://api.example.com",
    "api_key": "YOUR_API_KEY_HERE",
    "timeout_sec": 5
  }
}

app:
  name: my_web_app
  debug: false
  host: 0.0.0.0
  port: 8000

logging:
  level: INFO
  file: logs/app.log

database:
  url: postgresql://app_user:secret@db:5432/app_db
  pool_size: 10
  max_overflow: 5

external_api:
  base_url: https://api.example.com
  api_key: YOUR_API_KEY_HERE
  timeout_sec: 5

# web_config_loader.py
import json
import yaml
from pathlib import Path

def load_json_config(path: str) -> dict:
    with Path(path).open("r", encoding="utf-8") as f:
        return json.load(f)

def load_yaml_config(path: str) -> dict:
    with Path(path).open("r", encoding="utf-8") as f:
        return yaml.safe_load(f)

if __name__ == "__main__":
    json_conf = load_json_config("config.json")
    yaml_conf = load_yaml_config("config.yaml")

    print("[JSON] DB URL:", json_conf["database"]["url"])
    print("[YAML] DB URL:", yaml_conf["database"]["url"])

# config.yaml
database:
  url_env: DATABASE_URL  # 実際のURLは環境変数DATABASE_URLから取得
  pool_size: 10

external_api:
  base_url: https://api.example.com
  api_key_env: EXTERNAL_API_KEY

# config_with_env.py
import os
import yaml
from pathlib import Path

def load_config(path: str) -> dict:
    with Path(path).open("r", encoding="utf-8") as f:
        return yaml.safe_load(f)

def resolve_env_values(config: dict) -> dict:
    """*_envキーを実際の環境変数の値に置き換える簡易処理"""
    db_env_key = config["database"]["url_env"]
    api_env_key = config["external_api"]["api_key_env"]

    config["database"]["url"] = os.environ.get(db_env_key)
    config["external_api"]["api_key"] = os.environ.get(api_env_key)

    return config

if __name__ == "__main__":
    config = load_config("config.yaml")
    config = resolve_env_values(config)

    print("DB URL:", config["database"]["url"])
    print("API KEY:", config["external_api"]["api_key"])

pip install python-dotenv

# dotenv_example.py
from dotenv import load_dotenv
import os

# .envファイルから環境変数を読み込む
load_dotenv()

print("DATABASE_URL:", os.environ.get("DATABASE_URL"))

pip install pydantic

# pydantic_config_example.py
from pathlib import Path
import yaml
from pydantic import BaseModel, AnyHttpUrl, ValidationError

class DatabaseConfig(BaseModel):
    url: str
    pool_size: int = 10
    max_overflow: int = 5

class ExternalAPIConfig(BaseModel):
    base_url: AnyHttpUrl
    api_key: str
    timeout_sec: int = 5

class AppConfig(BaseModel):
    app_name: str
    debug: bool = False
    database: DatabaseConfig
    external_api: ExternalAPIConfig

def load_config(path: str) -> AppConfig:
    """YAMLを読み込み、AppConfigとしてバリデーションして返す"""
    with Path(path).open("r", encoding="utf-8") as f:
        raw = yaml.safe_load(f)

    # AppConfigのスキーマに沿って検証・型変換
    return AppConfig(**raw)

if __name__ == "__main__":
    try:
        config = load_config("config.yaml")
    except ValidationError as e:
        # スキーマに合わない場合はここで詳細なエラーが出る
        print("設定ファイルの内容が不正です。")
        print(e)
    else:
        print("アプリ名:", config.app_name)
        print("DB URL:", config.database.url)
        print("APIベースURL:", config.external_api.base_url)
        print("タイムアウト:", config.external_api.timeout_sec)