Python에서 YAML 다루기 완벽 가이드: 설정 파일 관리부터 고급 커스텀 태그까지

1. YAML이란?

YAML의 개요

JSON 및 XML과의 차이

Python과의 높은 친화성

2. Python에서 YAML 파일을 읽고 쓰는 방법

YAML 파일 읽기

import yaml

# YAML 파일을 열어 내용을 읽어오기
with open('config.yaml', 'r') as file:
    data = yaml.safe_load(file)

print(data)

database:
  host: localhost
  port: 3306

{'database': {'host': 'localhost', 'port': 3306}}

YAML 파일 쓰기

import yaml

data = {
    'name': 'John Doe',
    'age': 30,
    'city': 'New York'
}

with open('output.yaml', 'w') as file:
    yaml.dump(data, file)

age: 30
city: New York
name: John Doe

일본어 처리

yaml.dump(data, file, allow_unicode=True)

3. 고급 YAML 작업

사용자 지정 태그 만들기

import yaml

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

def person_representer(dumper, data):
    return dumper.represent_mapping('!Person', {'name': data.name, 'age': data.age})

def person_constructor(loader, node):
    values = loader.construct_mapping(node)
    return Person(values['name'], values['age'])

yaml.add_representer(Person, person_representer)
yaml.add_constructor('!Person', person_constructor)

# 객체를 YAML로 변환하여 저장
person = Person('Alice', 25)
with open('person.yaml', 'w') as file:
    yaml.dump(person, file)

# YAML 파일에서 객체를 재구성
with open('person.yaml', 'r') as file:
    loaded_person = yaml.load(file, Loader=yaml.FullLoader)

순서 유지

4. YAML 사용 예: 설정 파일 관리

설정 파일로서의 YAML의 편의성

database:
  host: localhost
  port: 3306
  username: user
  password: pass

logging:
  level: DEBUG
  file: /var/log/app.log

실제 프로젝트에서의 YAML 사용 예

import yaml

with open('config.yaml', 'r') as file:
    config = yaml.safe_load(file)

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': config['database']['name'],
        'USER': config['database']['username'],
        'PASSWORD': config['database']['password'],
        'HOST': config['database']['host'],
        'PORT': config['database']['port'],
    }
}

JSON 및 XML과의 비교

{
  "database": {
    "host": "localhost",
    "port": 3306,
    "username": "user",
    "password": "pass"
  },
  "logging": {
    "level": "DEBUG",
    "file": "/var/log/app.log"
  }
}

database:
  host: localhost
  port: 3306
  username: user
  password: pass

logging:
  level: DEBUG
  file: /var/log/app.log

5. 문제 해결 및 오류 처리

자주 발생하는 오류와 그 대처법

import yaml

def load_yaml(file_path):
    try:
        with open(file_path, 'r') as file:
            data = yaml.safe_load(file)
    except FileNotFoundError:
        print(f"Error: The file {file_path} does not exist.")
        return None
    except yaml.YAMLError as e:
        print(f"Error: Failed to parse YAML file. {e}")
        return None
    return data

config = load_yaml('config.yaml')
if config:
    print(config)

오류 처리 모범 사례

1. 파일 존재 여부 확인: 파일이 존재하는지 확인하고, 존재하지 않으면 오류 메시지를 표시합니다.
2. 파싱 오류 처리: YAML 구문이 올바르지 않은 경우 오류를 잡아 상세한 메시지를 제공합니다.
3. 로그 출력: 문제가 발생했을 때 오류 메시지를 로그 파일에 기록하여 나중에 문제를 해결할 수 있도록 합니다。

6. 정리