dochan (독한)

독한 native 문서 파서 — AI/LLM 최적 Markdown 변환

The toughest Korean document parser. HWP/HWPX/Office/PDF → Markdown, JSON, Plain Text.

Current stable version: 1.9.0

What is dochan?

dochan(독한)은 한글(HWP/HWPX)과 Office 문서를 native로 파싱하여 AI/LLM이 바로 사용할 수 있는 Markdown으로 변환하는 Python 파서입니다.

• doc (문서) + 한 (韓, 한국) = dochan — "독한 파서"라는 더블 미닝
• HWP 5.0 바이너리 + HWPX(OWPML) XML + Office OOXML/legacy binary + PDF(텍스트·표·읽기 순서) 네이티브 지원
• 동일 문서 HWP/HWPX/PDF 80쌍과 공개 HWP/HWPX 7,188개 회귀 코퍼스로 검증(2026-08 기준), 공개가능한 문서로 계속 학습시켜 개선할 예정
• 공개 OOXML fixture 50개의 고정 SHA-256 corpus와 형식별 회귀 테스트로 지속 검증

from dochan import Dochan

doc = Dochan("공문서.hwp")
print(doc.to_markdown())

Features

Installation

pip install dochan

OCR 기능이 필요한 경우(Python 3.10 이상):

pip install "dochan[ocr]"
brew install tesseract tesseract-lang  # macOS

Quick Start

Python API

from dochan import Dochan

# HWP, HWPX, DOC, PPT, XLS, DOCX, PPTX, XLSX, PDF
doc = Dochan("보고서.hwp")

# AI/LLM용 Markdown
markdown = doc.to_markdown()

# 구조화 JSON
json_str = doc.to_json()

# 플레인 텍스트
text = doc.to_plain_text()

# 요소별 접근
for table in doc.find_all('table'):
    print(f"표: {table.row_count}행 x {table.col_count}열")

for eq in doc.find_all('equation'):
    print(f"수식: {eq.latex}")

# 메타데이터
print(doc.metadata)

# 문서 속 이미지 바이너리를 파일로 저장 (<파일이름>-image-NNN.<확장자>)
doc.save_images("images/")

# 암호화 문서 (키워드 전용; 암호 값은 오류·로그에 남지 않는다)
doc = Dochan("암호문서.docx", password="비밀번호")

# HWP/HWPX 변경 추적: preserve(기본, 모든 텍스트) · final(삭제 제외) · original(삽입 제외)
doc = Dochan("검토본.hwpx", revision_mode="final")

CLI

# Markdown 변환 (stdout)
dochan convert 문서.hwp

# 파일로 저장
dochan convert 문서.hwp -o output.md

# JSON 출력
dochan convert 문서.hwpx --format json

# Word DOCX 변환
dochan convert 문서.docx

# Legacy Word DOC 변환
dochan convert 문서.doc

# PowerPoint PPTX 변환
dochan convert 발표.pptx

# Legacy PowerPoint PPT 변환
dochan convert 발표.ppt

# Excel XLSX 변환
dochan convert 표.xlsx

# Legacy Excel XLS 변환
dochan convert 표.xls

# PDF 텍스트 추출
dochan convert 문서.pdf

# 이미지 바이너리도 함께 저장
dochan convert 문서.docx -o 문서.md --images-dir images/

# 암호화 문서: 표준 입력 첫 줄 또는 DOCHAN_PASSWORD (명령줄 인자로는 받지 않는다)
echo "$PASSWORD" | dochan convert 암호문서.xlsx --password-stdin

# PDF 괘선 없는 표 복원(실험적)
dochan convert 문서.pdf --pdf-text-tables

# 디렉토리 일괄 변환
dochan batch input_dir/ output_dir/ --format markdown --workers 4

# 문서 정보
dochan info 문서.hwp

OCR (이미지 속 텍스트 추출)

doc = Dochan("이미지포함문서.hwpx", ocr=True)
print(doc.to_markdown())  # 이미지 속 텍스트도 포함

Output Examples

Input: 한글 공문서 (.hwp)

Output: Markdown

# **사내 규정집**

| 연번 | 내용 | 일자 |
| --- | --- | --- |
| 1 | 제정 | 2020. 3. 1. |
| 2 | 개정 | 2024. 9.15. |

### **제1장 총칙**

**제1조(목적)** 이 규정은 회사 직원의 복무에 관한 사항을 정함을
목적으로 한다.

Supported Elements

✅ 지원   ⬜ 미지원   — 해당 없음 (형식에 그 구조가 없음)

✅ 는 단위 테스트와 실물 문서 검증을 모두 통과한 칸에만 붙인다. 칸마다 검증 표본·수치·남은 한계는 docs/SUPPORT_NOTES.md 와 docs/benchmarks/ 에 있다. 주요 범위 제한:

1. DOC·PPT 수식은 내장 Equation 3.0(MathType MTEF v2/v3/v5) 개체를 LaTeX 로 바꾼다. 공개 실물 변환율은 DOC 42/54, PPT 13/18 이고 변환하지 못한 식은 미리보기 그림으로 남는다.
2. XLS 수식은 BIFF8 기준이다. 같은 문서의 XLSX 와 비교한 1,070 수식 중 1,059개(98.97%)가 일치하며, DDE·OLE 링크와 해석하지 못한 BIFF5 식은 수식 대신 캐시 값만 낸다.
3. 캡션은 Caption 스타일·SEQ 필드 문단이 최상위 흐름에서 표·그림 바로 앞/뒤에 있을 때만 결합한다. DOC 의 위쪽 캡션은 합성 문서로만 검증했다.
4. HWP 는 배포용 문서를 복호화한다. 열기 암호로 보호된 HWP 는 명확한 오류로 거부한다.
5. DOC 의 XOR 난독화는 공개 실물 표본이 없어 합성 문서로만 검증했다(RC4·RC4 CryptoAPI 는 실물 검증).

Legacy Office(.doc/.ppt/.xls)도 외부 변환 엔진 없이 native 로 읽습니다. .doc 와 .ppt 는 Microsoft 공개 명세 [MS-DOC]·[MS-PPT] 에 따라 문서 구조(글자 서식과 스타일, 셀 병합·중첩 표, 각주·주석·머리글/바닥글, 텍스트박스, 슬라이드·노트·마스터 상속, 도형 트리와 읽기 순서 등)를 해석해 DOCX·PPTX 와 같은 형태로 내고, 구조를 해석할 수 없는 문서는 이전의 텍스트 추출 경로로 처리합니다. .xls 는 BIFF8 해석을 넓혀 [MS-XLS] 함수 표에 기반한 수식 문자열, rich text, 내부 링크, 그림, 차트를 읽습니다. 세 형식 모두 공용 OfficeArt 파서로 그림과 대체 텍스트를 꺼내고, .doc·.ppt 에 내장된 OLE 차트(Excel·MS Graph)는 OOXML 차트와 같은 표로, Equation 3.0 수식은 LaTeX 로 바꿉니다. 암호화된 문서는 .doc·.xls 의 XOR·RC4·RC4 CryptoAPI 와 .ppt 의 RC4 CryptoAPI 를 password= 로 열 수 있으며, 항목별 지원 범위와 검증 한계는 위 표와 각주에 적었습니다.

Architecture

dochan/
├── reader.py          # 통합 진입점 (Dochan 클래스; password=·revision_mode=·include_assets=)
├── cli.py             # CLI 도구 (convert·batch·info, --images-dir, --password-stdin)
├── batch.py           # 디렉토리 일괄 변환
├── conversion.py      # AssetRef 등 변환 계약
├── cfb.py             # [MS-CFB] OLE 복합 파일 리더 (HWP·DOC·PPT·XLS·내장 OLE 공용, 외부 의존성 없음)
├── crypto/            # 암호화 Office 문서 ([MS-OFFCRYPTO], 외부 의존성 없음)
│   ├── ooxml.py       #   OOXML Standard/Agile (EncryptionInfo + EncryptedPackage)
│   ├── legacy.py      #   DOC·XLS XOR·RC4·RC4 CryptoAPI
│   └── ppt.py         #   PPT CryptSession10Container
├── hwp/               # HWP 5.0 바이너리 파서
│   ├── header.py      #   FileHeader (256바이트)
│   ├── doc_info.py    #   DocInfo (서식/스타일/변경 추적 정보)
│   ├── section.py     #   섹션 (레코드 트리 → 모델)
│   ├── distdoc.py     #   배포용 문서 ViewText 복호화 (한컴 공개 명세)
│   ├── revisions.py   #   변경 추적 범위 투영
│   ├── forms.py       #   양식 개체·누름틀 표시 텍스트
│   ├── bin_data.py    #   BinData 이미지 연결
│   └── records/       #   개별 레코드 파서
├── hwpx/              # HWPX (OWPML) XML 파서
│   ├── parser.py
│   ├── charts.py      #   내장 차트 캐시
│   └── revisions.py   #   변경 추적 투영
├── ooxml/             # Office Open XML native 파서 (Strict 정규화 포함)
│   ├── package.py     #   안전한 ZIP/XML 패키지 유틸, Strict → Transitional
│   ├── docx.py        #   DOCX 문단/서식/표/캡션/차트
│   ├── pptx.py        #   PPTX 슬라이드/텍스트/표/수식/미디어
│   ├── xlsx.py        #   XLSX workbook/sheet/cell/차트
│   ├── charts.py      #   DOCX·PPTX·XLSX 공용 차트(종류·축 제목·캐시 없는 참조·chartEx)
│   └── math.py        #   OMML → LaTeX
├── office_binary/     # Legacy Office OLE native 파서 ([MS-DOC]/[MS-PPT]/[MS-XLS])
│   ├── doc.py         #   DOC 진입점 (구조 해석 실패 시 텍스트 경로)
│   ├── doc_binary.py  #   FIB·CLX·FKP·sprm·STSH
│   ├── doc_tables.py · doc_stories.py · doc_images.py · doc_captions.py · doc_structure.py
│   ├── ppt.py         #   PPT 진입점
│   ├── ppt_structure.py · ppt_text.py · ppt_shapes.py · ppt_render.py
│   ├── xls.py         #   XLS BIFF workbook/sheet/cell
│   ├── xls_formula.py · xls_ftab.py · xls_chart.py · xls_drawing.py · xls_hyperlink.py
│   ├── officeart.py   #   [MS-ODRAW] 공용 OfficeArt(BLIP·도형·속성)
│   ├── ole_objects.py #   내장 OLE 차트(Excel·MS Graph)·수식 개체
│   ├── mtef.py        #   MathType MTEF → LaTeX
│   ├── symbol_fonts.py#   Symbol·Wingdings 문자 대응
│   └── structure.py   #   legacy 텍스트 경로의 구조화
├── pdf/               # 네이티브 PDF 파서
│   ├── objects.py     #   객체 문법 파서
│   ├── filters.py     #   Flate/LZW/ASCIIHex/ASCII85 + PNG·TIFF predictor
│   ├── structure.py   #   xref/트레일러/페이지 트리/객체 스트림
│   ├── crypto.py      #   표준 보안 핸들러(RC4/AES, 사용자 암호 R2–R6)
│   ├── cmap.py · widths.py · core14.py  # ToUnicode·글리프 폭·표준 14 글꼴(Adobe AFM 폭)
│   ├── content.py     #   콘텐츠 스트림 해석(CTM·텍스트 좌표·세로쓰기)
│   ├── paths.py · tables.py · text_tables.py · pagination.py  # 괘선·표·페이지 걸침
│   ├── layout.py · spacing.py  # 줄 → 문단, 한글 줄바꿈 공백 모델
│   ├── running.py     #   반복 머리글/바닥글
│   ├── annotations.py #   주석(코멘트)·링크·내부 목적지
│   ├── notes.py       #   각주 휴리스틱
│   ├── images.py      #   이미지 XObject 추출
│   └── reader.py      #   PDFReader (페이지 → Document)
├── model/             # Document 모델 (Document·Section·Paragraph·Table·Image·Equation·HeaderFooter·Footnote·Comment)
├── output/            # 출력 포맷 (markdown.py·json_out.py·plain_text.py)
├── quality/           # 품질 검사·교차 검증
└── utils/             # 유틸리티
    ├── aes.py         #   FIPS-197 AES (표 기반, 외부 의존성 없음)
    ├── bounded_io.py  #   신뢰할 수 없는 OLE 스트림의 상한 읽기
    ├── image_export.py#   이미지 바이너리 저장
    ├── ocr.py         #   Tesseract OCR (선택, Python 3.10+)
    └── safe_decompress.py  # Zip Bomb 방어

외부 출처와 의존성은 docs/THIRD_PARTY.md 에 정리돼 있다.

Security

dochan은 신뢰할 수 없는 문서도 안전하게 처리합니다:

• Zip Bomb 방어: raw zlib 출력 200MB(HWP 본문은 문서당 누적 200MB, 손상 스트림은 실제 해제한 양만 차감), OOXML/HWPX XML part 32MB, 일반 part 100MB, archive 합계 512MB 상한
• XXE 차단: XML 외부 엔티티 해석 비활성화
• Path Traversal 방지: 배치 처리 시 경로 탈출 차단
• 메모리 제한: HWP 레코드 섹션당 100만·문서당 130만·DocInfo 20만 개(넘으면 그때까지 읽은 본문을 보존하고 오류를 남김), HWP·HWPX 문서당 서식 런 524,288·150,000개와 HWPX 문단·각주 150,000개(넘으면 이후 본문을 서식·하이퍼링크 없이 보존하고 WARN 1회), HWP·HWPX·DOCX·XLSX·XLS·PDF 문서당 표 셀 20만 개, HWP·DOCX 일반 구조 깊이 64, HWP·DOCX 표 깊이 32, PPTX 그룹 깊이 64 상한. PDF 는 페이지 콘텐츠 합계 64MB, 괘선 2만 개, 괘선 교차 검사 200만 회, 스트림 해제 200MB 추가 상한
• 입력 검증: FileHeader/스트림명/OOXML 패키지명/바이너리 바운드 체크

이 상한들은 입력량과 구조 수를 묶을 뿐 메모리 사용량의 상한은 아닙니다(예: 상한 근처의 HWP 무서식 문단 64만 개는 약 2.5GB 를 쓴다). 신뢰할 수 없는 문서는 프로세스 메모리 제한(컨테이너·ulimit 등) 아래에서 처리하기를 권장합니다.

Contributing

기여를 환영합니다! Issues, Pull Requests 모두 열려 있습니다.

# 개발 환경 설정
git clone https://github.com/illuwa/dochan.git
cd dochan
python -m pip install "uv==0.12.3"
uv sync --locked --extra dev
uv run --locked --extra dev ruff check dochan scripts tests
uv run --locked --extra dev python -m pytest tests/

Acknowledgments

kordoc를 보고 자극받아 만들었습니다.

dochan은 다음 프로젝트와 자료를 기반으로 개발되었습니다:

스펙 참조

• 한글과컴퓨터 — HWP 문서 파일 형식 5.0 공개 스펙 (revision 1.3, 2018)
• OWPML (KS X 6101:2011) — HWPX 국가 표준

오픈소스

• lxml — XML 파싱 (BSD)
• pdfplumber — 품질 검증용 PDF 추출 (MIT)
• Tesseract OCR — 이미지 텍스트 추출 (Apache 2.0)

선행 연구 (공개 HWP 파서 프로젝트. dochan 의 구현 근거는 한컴 공개 명세와 실물 바이트 관찰이며, 이 프로젝트들의 코드는 쓰지 않는다. 과거 참고 이력은 docs/THIRD_PARTY.md 에 기록)

• hwplib (Java)
• hwp.js
• pyhwp — Python HWP 파서 선구자

OLE2(CFB) 컨테이너는 1.8.0 부터 [MS-CFB] 명세로 자체 구현한 dochan/cfb.py 로 읽는다(이전 버전은 olefile 을 썼다).

License

MIT License

본 소프트웨어는 한글과컴퓨터의 HWP 문서 파일(.hwp) 공개 문서를 참고하여 개발되었습니다. 자세한 내용은 NOTICE 파일을 참조하세요.