Skip to main content

A Python package for classifying Chinese characters phonologically based on the Middle Chinese Pingshui rhyme scheme

Project description

Pingshui Rhyme

Pingshui Rhyme is a Python package designed to classify tonal patterns ("ping" 平 and "ze" 仄 tones) and rhyme categories ("韻腳") of Chinese characters based on the Pingshui Rhyme (平水韻) rhyme scheme. You can read more about ping-ze, or tonal patterns, here. Modern Chinese varieties are not suitable for determining the phonological values of characters in middle Chinese due to sound changes, thus this package was built to use period accurate data to retrieve info about characters.

The package includes a pre-scraped JSON file that contains the complete data from the rhyme dictionary, and also provides a scraper to update the data if necessary.

Features

  • Classify Chinese characters: Easily classify characters as 'ping' or 'ze' based on the Pingshui Rhyme scheme.
  • Rhyme comparison: Check if two characters rhyme based on their tonal and rhyme categories.
  • Rhyme group lookup: Get detailed rhyme group information, such as tone type, tone group, and specific rhyme category for any given character.
  • Pre-packaged data: Includes a pre-scraped JSON file with the complete rhyme data.
  • Scraper: An optional scraper is included to regenerate the JSON file when the source data changes.

Installation

You can install the package by running:

pip install pingshui_rhyme

Usage

Classifying Characters

Once installed, you can use the PingZeClassifier class to classify Chinese characters based on their tone as either "ping" (平) or "ze" (仄) tones:

from pingshui_rhyme import PingZeClassifier

# Initialize the classifier (uses pre-packaged JSON by default)
classifier = PingZeClassifier()

# Classify a sentence
sentence = "知否?知否?應是綠肥紅瘦。"
result = classifier.classify(sentence)
print(result)
# Output: ['ping', 'ze', 'unknown', 'ping', 'ze', 'unknown', 'ping', 'ze', 'ze', 'ping', 'ping', 'ze', 'unknown']

Rhyme Checking

You can also use the RhymeChecker class to check if two characters rhyme based on their tone group and rhyme category.

from pingshui_rhyme import RhymeChecker

# Initialize the rhyme checker
rhyme_checker = RhymeChecker()

# Check if two characters rhyme
char1 = "東"
char2 = "同"
do_they_rhyme = rhyme_checker.do_rhyme(char1, char2)
print(do_they_rhyme)  # Output: True

# Get the rhyme group of a character
rhyme_group = rhyme_checker.get_rhyme_group(char1)
print(rhyme_group)
# Output: ('ping', '上平聲部', '上平聲一東')

Scraping and Regenerating the JSON Data

The package includes a pre-generated JSON file, but if the Pingshui Rhyme source from wikisource changes you can run the scraper.

Running the Scraper

By default, the scraper won't run if the JSON file already exists. To force a refresh and regenerate the JSON data, run the following command:

scrape-pingze --force-refresh

This will scrape the latest data from the source and regenerate the organized_ping_ze_rhyme_dict.json file.

Dependencies

`requests`: For web scraping the Pingshui Rhyme data.
`beautifulsoup4`: For parsing the HTML content from the Pingshui Rhyme source page.

Running Unit Tests

Unit tests for the classifiers and rhyme checker are included. You can run the tests using unittest:

python -m unittest discover

License

This package is licensed under the MIT License. See the LICENSE[LICENSE] file for details.

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

pingshui_rhyme-0.13.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

pingshui_rhyme-0.13-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file pingshui_rhyme-0.13.tar.gz.

File metadata

  • Download URL: pingshui_rhyme-0.13.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.3

File hashes

Hashes for pingshui_rhyme-0.13.tar.gz
Algorithm Hash digest
SHA256 bded7fb7922d065f93f71dea2f2634c20cbc790a0c96d2a98fb31b78575889e3
MD5 cc6acc1d564db467e5596d40a874c497
BLAKE2b-256 3fe53faee128a406349c5ab159d9b62eae3b8e14f3d188dd19d3332499c01e2e

See more details on using hashes here.

File details

Details for the file pingshui_rhyme-0.13-py3-none-any.whl.

File metadata

File hashes

Hashes for pingshui_rhyme-0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 c6d927ef1ad601082af8cbdfb1df8d22b4fba5aa0180cf90fe88397c53696e21
MD5 45d68966662c52f45204c6588847c230
BLAKE2b-256 a83b83d682897f7ce1c52f8018c497d80ca4e50d6a18a0cec9de9dd074d9781a

See more details on using hashes here.

Supported by

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