functionwords 0.4.4

Curated Chinese and English function words.

functionwords

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 three methods (.remove_function_words(), count_function_words(), and get_function_words()) 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 remove function words
fw.remove_function_words(raw)

# to count function words accordingly
# returns a dict
fw.count_function_words(raw)

# to list all function words in 
# returns a list
fw.get_function_words(raw)

Requirements

Only python 3.8+ is required.

Important links

• Source code: https://github.com/Wang-Haining/functionwords
• Issue tracker: https://github.com/Wang-Haining/functionwords/issues

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.