Skip to main content

Extract curated Chinese and English function words from texts.

Project description

functionwords

License: CC BY-NC-SA 4.0

The functionwords package aims at providing curated Chinese and English function words.

For now, it supports four function word lists: modern Chinese ([chinese_simplified_modern][1]), classical Chinese ([chinese_classical_naive][2] and [chinese_classical_comprehensive][3]), and modern English (english). Chinese function words are only available in simplified form.

The FunctionWords class does the heavy lifting. Initiate it with the desired function word list name. The instance has two methods transform() and get_feature_names()) and three attributes (name, function_words, and description).

Name # of function words        Description        
chinese_simplified_modern 819 compiled from the [dictionary][1]
chinese_classical_naive 32 harvested from the [platforms][2]
chinese_classical_comprehensive 466 compiled from the [dictionary][3]
english 512 found in software

For more details, see FunctionWords instance's attribute description.

Installation

pip install -U functionwords

Getting started

from functionwords import FunctionWords

raw = "The present King of Singapore is bald."

# to instantiate a FunctionWords instance
# `name` can be either 'chinese_classical_comprehensive', 
# 'chinese_classical_naive', 'chinese_simplified_modern', or 'english'
fw = FunctionWords(name='english')

# to count function words accordingly
# returns a list of counts
fw.transform(raw)

# to list all function words given `name`
# returns a list
fw.get_feature_names(raw)

Requirements

Only python 3.8+ is required.

Important links

Licence

This package is licensed under CC-BY-SA 4.0.

To do

  • Finish the tests.

References

[1]: Ziqiang, W. (1998). Modern Chinese Dictionary of Function Words. Shanghai Dictionary Press.

[2]: https://baike.baidu.com/item/%E6%96%87%E8%A8%80%E8%99%9A%E8%AF%8D and https://zh.m.wikibooks.org/zh-hans/%E6%96%87%E8%A8%80/%E8%99%9B%E8%A9%9E

[3]: Hai, W., Changhai, Z., Shan, H., Keying, W. (1996). Classical Chinese Dictionary of Function Words. Peking University Press.

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

functionwords-0.6.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

functionwords-0.6-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file functionwords-0.6.tar.gz.

File metadata

  • Download URL: functionwords-0.6.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.5 Darwin/21.1.0

File hashes

Hashes for functionwords-0.6.tar.gz
Algorithm Hash digest
SHA256 4e830f51f7fb570f2376624afa84558253d764e46108b0467930be02ef8e7548
MD5 e224248b5e7c69199fe17919de23c7ac
BLAKE2b-256 1c2e6e9637bb0297386ed2ee1597da715500fb9ccb5ff0dc648a84368fac8310

See more details on using hashes here.

File details

Details for the file functionwords-0.6-py3-none-any.whl.

File metadata

  • Download URL: functionwords-0.6-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.5 Darwin/21.1.0

File hashes

Hashes for functionwords-0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a974beffbb09f94eb8d413b23984cd2168fb300adcf097ad40b77e923945ffb9
MD5 9c36976b4ae86369652e86c801c122a3
BLAKE2b-256 8045b0ce848ce52ad279eea77698dedfb7f5010d3fb7c0d7a03fadc4bd4bd109

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