서버에서 다루는 시점과 날짜, 유지보수할 때 남겨 둘 예제

예약 시각과 생일처럼 의미가 다른 값을 모두 같은 날짜 타입으로 처리하면 시간대 오류가 생길 수 있다.

시간이 지나면 왜 이렇게 구현했는지보다 어떻게 실행하는지만 남기기 쉽다. 옵션과 제약을 잊은 채 코드를 정리하면 의도했던 동작까지 바뀔 수 있다. 이번에는 작은 예제를 실행 가능한 설명으로 남기고, 구현이 달라져도 유지할 부분을 분리한다.

다시 읽을 수 있는 최소 맥락

정확한 사건의 시점은 시간대 정보가 있는 값으로 저장한다. 달력 날짜 자체가 의미인 값은 시점으로 변환하지 않고 별도 타입과 계약을 사용한다.

이번에 확인할 질문: 내부 구조를 바꾸더라도 이 예제가 설명하는 결과는 그대로 유지되어야 하는가?

작게 확인하는 예제

다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.

from datetime import datetime, timezone

instant = datetime.now(timezone.utc)
serialized = instant.isoformat()
restored = datetime.fromisoformat(serialized)
assert restored.tzinfo is not None

서로 다른 시간대에서 같은 사건을 읽었을 때 실제 시점은 유지되고 표시만 달라지는지 확인한다.

놓치기 쉬운 조건

시간대가 없는 datetime에 단순히 UTC 표식을 붙이는 것은 변환이 아니다. 원래 값이 어떤 지역의 시간이었는지 알아야 올바르게 해석할 수 있다.

확인할 부분	살펴볼 내용
기준 동작	서로 다른 시간대에서 같은 사건을 읽었을 때 실제 시점은 유지되고 표시만 달라지는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 구현 세부 사항보다 외부에서 관찰하는 결과를 적는다.
2. 예제가 의존하는 입력과 환경을 가까이에 둔다.
3. 설명이 실제 동작과 달라지면 코드와 예제를 같은 변경에서 고친다.

오래 남는 문서는 가장 긴 문서가 아니라 다시 확인할 수 있는 문서다. 선택의 이유와 작동하는 예제가 함께 있으면 새로운 구현으로 옮길 때도 기준을 잃지 않는다. 중복 설명을 늘리기보다 정본이 어디인지 분명히 하는 편이 유지 비용을 줄인다.