Python으로 JSON 스키마 정의하고 데이터 유효성 검사하기

 

Python에서 JSON 데이터를 다룰 때, 데이터의 구조와 유효성을 정확하게 검증하는 것은 매우 중요합니다. 특히 다양한 소스에서 수집된 데이터를 통합하거나, API를 통해 데이터를 주고받을 때 데이터의 일관성을 유지하기 위해서는 데이터 스키마를 정의하고 이에 맞게 데이터를 검증하는 과정이 필수적입니다. 이 글에서는 Python에서 JSON 스키마를 정의하고 데이터 유효성을 검사하는 방법에 대해 자세히 알아보겠습니다.

JSON 스키마란?

JSON 스키마는 JSON 데이터의 구조와 유효성을 정의하는 일종의 규칙입니다. 어떤 속성이 있어야 하고, 각 속성의 데이터 타입은 무엇인지, 어떤 값이 허용되는지 등을 명확하게 지정할 수 있습니다. 이러한 스키마를 정의하면 다음과 같은 이점이 있습니다.

• 데이터의 일관성 유지: 모든 데이터가 동일한 구조를 가지도록 강제하여 데이터 분석 및 처리 과정에서 발생할 수 있는 오류를 줄일 수 있습니다.
• 데이터 문서화: 스키마를 통해 데이터의 의미와 구조를 명확하게 설명할 수 있어 다른 개발자들과의 협업을 용이하게 합니다.
• 데이터 유효성 검증 자동화: 스키마에 정의된 규칙에 따라 데이터를 자동으로 검증하여 잘못된 데이터를 조기에 발견하고 수정할 수 있습니다.

 

728x90

Python에서 JSON 스키마 사용하기

Python에서 JSON 스키마를 사용하기 위해서는 jsonschema 라이브러리를 설치해야 합니다.

pip install jsonschema

 

스키마 정의하기

JSON 스키마는 JSON 형식으로 정의됩니다. 다음은 간단한 사용자 정보를 나타내는 JSON 스키마의 예시입니다.

{
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "age": {"type": "integer"},
        "email": {"type": "string", "format": "email"}
    },
    "required": ["name", "age"]
}

• type: 스키마의 최상위 타입을 나타냅니다. 여기서는 object 타입입니다.
• properties: 객체의 속성들을 정의합니다. 각 속성은 이름과 해당 속성의 타입을 가지고 있습니다.
• required: 필수 속성들을 지정합니다.

데이터 유효성 검사하기

jsonschema.validate 함수를 사용하여 정의한 스키마에 따라 데이터의 유효성을 검사할 수 있습니다.

from jsonschema import validate

# 스키마 정의
schema = {
    # 위에서 정의한 스키마 내용
}

# 검사할 데이터
data = {
    "name": "홍길동",
    "age": 30,
    "email": "hong@example.com"
}

try:
    validate(instance=data, schema=schema)
    print("유효한 데이터입니다.")
except Exception as e:
    print("유효하지 않은 데이터입니다:", e)

 

 

만약 데이터가 스키마에 정의된 규칙을 위반하면 validate 함수는 예외를 발생시킵니다.

더 복잡한 스키마 정의하기

JSON 스키마는 다양한 기능을 제공하여 복잡한 데이터 구조를 정의할 수 있습니다.

• 배열: type: "array"
• enum: 허용되는 값의 목록 지정
• null: null 값 허용
• anyOf, oneOf, allOf: 여러 스키마 중 하나 또는 모두 만족하는 경우
• 추가 속성 허용/불허: additionalProperties
• 패턴: 문자열 패턴 정의
• 참조: 다른 스키마 참조

실제 예시

 

from jsonschema import validate

# 책 정보 스키마
book_schema = {
    "type": "object",
    "properties": {
        "title": {"type": "string"},
        "author": {"type": "string"},
        "year": {"type": "integer"},
        "genre": {"type": "string", "enum": ["소설", "시", "역사"]},
        "pages": {"type": "integer", "minimum": 1}
    },
    "required": ["title", "author", "year"]
}

# 책 정보 데이터
book_data = {
    "title": "데이터 과학 입문",
    "author": "홍길동",
    "year": 2023,
    "genre": "과학",
    "pages": 300
}

try:
    validate(instance=book_data, schema=book_schema)
    print("유효한 책 정보입니다.")
except Exception as e:
    print("유효하지 않은 책 정보입니다:", e)

 

 

728x90

JSON 스키마를 활용하면 Python에서 JSON 데이터의 구조와 유효성을 정확하게 관리할 수 있습니다. 이는 데이터 처리 과정에서 발생할 수 있는 오류를 줄이고, 데이터의 신뢰성을 높이는 데 큰 도움이 됩니다.

주의: 위에서 설명한 내용은 jsonschema 라이브러리의 기본적인 기능에 대한 소개입니다. jsonschema는 더욱 다양한 기능을 제공하므로 공식 문서를 참고하여 더 자세한 내용을 확인할 수 있습니다.

참고:

• jsonschema 공식 문서: https://json-schema.org/understanding-json-schema/
• jsonschema Python 라이브러리: https://pypi.org/project/jsonschema/