Usage

Usage

To use String Pod in a project

import stringpod

Normalizer

>>> from stringpod import Normalizer, NormalizerOptions
>>> normalizer = Normalizer()
>>> normalizer.normalize("Hello, world!")

With Options

# Pass options (as a NormalizerOptions object) during initialization
>>> options = NormalizerOptions(ignore_case=True)
>>> normalizer = Normalizer(options=options)
>>> normalizer.normalize("Hello, world!")
"hello, world!"

# Pass options (as a string) during initialization
>>> normalizer_from_string = Normalizer(options="ignore_case,strip_whitespace")
>>> normalizer_from_string.normalize("Hello, world!")
"hello, world!"

# Pass options after initialization
>>> normalizer = Normalizer()
>>> normalizer.options = NormalizerOptions(ignore_case=True) # Must be a NormalizerOptions object
>>> normalizer.normalize("Hello, world!")
"hello, world!"

# Pass options during normalization (will only be applied to this normalization)
>>> normalizer = Normalizer()
>>> normalizer.normalize("Hello, world!", options=NormalizerOptions(ignore_case=True))
"hello, world!"

String Contains Substring

>>> from stringpod import contains_substring
>>> contains_substring("Hello, world!", "world")
True
>>> contains_substring("Hello, world!", "WORLD", options="ignore_case")
True

Number Parser

>>> from stringpod import number_parser
>>> number_parser("One hundred and twenty-three")
123
>>> number_parser("One hundred and twenty-three", language="en")
123
>>> number_parser("一萬三", language="zh")
130000

Compare using Pinyin

>>> stringpod cmp-pinyin "你好" "你号"
True # Default: 忽略聲調
>>> stringpod cmp-pinyin "你好" "你号" -t
False # 考慮聲調
>>> stringpod cmp-pinyin "你好" "你号" -s
False # 考慮聲調，使用口語變調