unihan-db ·

Database SQLAlchemy models for UNIHAN. Part of the cihai project. Powered by unihan-etl. See also: libUnihan.

By default, unihan-db creates a SQLite database in an XDG data directory. You can specify a custom database destination by passing a database url into get_session.

Example usage

#!/usr/bin/env python
"""Example for bootstrapping UNIHAN DB and print out a row."""
import pprint

from sqlalchemy.sql.expression import func

from unihan_db import bootstrap
from unihan_db.tables import Unhn

session = bootstrap.get_session()

bootstrap.bootstrap_unihan(session)

random_row_query = session.query(Unhn).order_by(func.random()).limit(1)

assert random_row_query is not None

random_row = random_row_query.first()

pprint.pprint(bootstrap.to_dict(random_row))

pprint.pprint(random_row.to_dict())  # type:ignore

Run:

$ ./examples/01_bootstrap.py

Output:

{'char': '鎷',
'kCantonese': [{'char_id': '鎷', 'definition': 'maa5', 'id': 24035}],
'kDefinition': [],
'kHanYu': [{'char_id': '鎷',
          'id': 24014,
          'locations': [{'character': 5,
                       'generic_indice_id': 24014,
                       'generic_reading_id': None,
                       'id': 42170,
                       'page': 4237,
                       'virtual': 0,
                       'volume': 6}],
          'type': 'kHanYu'}],
'kHanyuPinyin': [{'char_id': '鎷',
                'id': 18090,
                'locations': [{'character': 5,
                             'generic_indice_id': None,
                             'generic_reading_id': 18090,
                             'id': 42169,
                             'page': 4237,
                             'virtual': 0,
                             'volume': 6}],
                'readings': [{'generic_reading_id': 18090,
                            'id': 26695,
                            'reading': 'mǎ'}],
                'type': 'kHanyuPinyin'}],
'kMandarin': [{'char_id': '鎷', 'hans': 'mǎ', 'hant': 'mǎ', 'id': 23486}],
'ucn': 'U+93B7'}

Developing

$ git clone https://github.com/cihai/unihan-etl.git

$ cd unihan-etl

Bootstrap your environment and learn more about contributing. We use the same conventions / tools across all cihai projects: pytest, sphinx, mypy, ruff, tmuxp, and file watcher helpers (e.g. entr(1)).

Python versions

0.8.0:
- Last Python 3.7 release
- Last SQLAlchemy 1.3 release

More information

Release files for unihan-db 0.22.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for unihan-db 0.22.0
File	Size	Uploaded
unihan_db-0.22.0.tar.gz	256.3 kB	Jun 29, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for unihan-db 0.22.0
File	Interpreter	ABI	Platform	Reset
unihan_db-0.22.0-py3-none-any.whl 11.9 kB Jun 29, 2026	Python 3	none	any	Details

Total release size: 268.2 kB

Release files / unihan_db-0.22.0.tar.gz

Download URL	unihan_db-0.22.0.tar.gz
Size	256.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`83edfbac1e4a00447273ef9a078aca430452e9c87d186d9d370428dbfc81332a`
BLAKE2b-256 checksum How to use checksums	`30772fa22d2e253ec3198dc980545eb2d502d0197f12bda9f853253bc4e71ce7`
Upload date	Jun 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/cihai/unihan-db
Publishing commit: github.com/cihai/unihan-db/tree/e448080846f4c96b26be75aacfcaaccee5a30231

Workflow

Publishing configuration: github.com/cihai/unihan-db/blob/e448080846f4c96b26be75aacfcaaccee5a30231/.github/workflows/tests.yml
Publishing logs: github.com/cihai/unihan-db/actions/runs/28345216637/attempts/1

Artifact

Subject: unihan_db-0.22.0.tar.gz
SHA-256 checksum: 83edfbac1e4a00447273ef9a078aca430452e9c87d186d9d370428dbfc81332a Verifying attestations

Release files / unihan_db-0.22.0-py3-none-any.whl

Download URL	unihan_db-0.22.0-py3-none-any.whl
Size	11.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f2d7cc83ec181c6548b02f2c4bdcb2d5c6acae575450b5fa2be3c87707be4386`
BLAKE2b-256 checksum How to use checksums	`54a82eaa8ebdbe8703f6fe9126286a4da9ab154ffc1a8e6b45f51cb361ed340a`
Upload date	Jun 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/cihai/unihan-db
Publishing commit: github.com/cihai/unihan-db/tree/e448080846f4c96b26be75aacfcaaccee5a30231

Workflow

Publishing configuration: github.com/cihai/unihan-db/blob/e448080846f4c96b26be75aacfcaaccee5a30231/.github/workflows/tests.yml
Publishing logs: github.com/cihai/unihan-db/actions/runs/28345216637/attempts/1

Artifact

Subject: unihan_db-0.22.0-py3-none-any.whl
SHA-256 checksum: f2d7cc83ec181c6548b02f2c4bdcb2d5c6acae575450b5fa2be3c87707be4386 Verifying attestations