Skip to main content

SQLAlchemy models for UNIHAN CJK database

Project description

unihan-db · Python Package License Code Coverage

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

Docs Build Status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unihan_db-0.18.0.tar.gz (178.9 kB view details)

Uploaded Source

Built Distribution

unihan_db-0.18.0-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file unihan_db-0.18.0.tar.gz.

File metadata

  • Download URL: unihan_db-0.18.0.tar.gz
  • Upload date:
  • Size: 178.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for unihan_db-0.18.0.tar.gz
Algorithm Hash digest
SHA256 e00bc28e85247e77d0ca3bb821e02ce7ec14da74390e2ee00947e2bebbc3194a
MD5 bee98e80ea4187bdef09219657956b65
BLAKE2b-256 4325f99ccc47b161eaa1fd1f1837fac0d70370ae733b7078139b0ba222dafdcf

See more details on using hashes here.

File details

Details for the file unihan_db-0.18.0-py3-none-any.whl.

File metadata

  • Download URL: unihan_db-0.18.0-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for unihan_db-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 12a2bd5f22f9ef7cf583fd47c8df841fa3317da048299fb41eaf9fe1c8890e7a
MD5 6515a8846887276b6c238593bbee3bc9
BLAKE2b-256 d328deeb9da81c2ae3b51be7911725b57c0e7f17707c96a2eb4defba2a4ba1dd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page