plane 0.0.6

A lib for text preprocessing

Plane is a tool for shaping wood using muscle power to force the cutting blade over the wood surface.

– from Wikipedia.

This package is used for extracting or replacing specific parts from text, like URL, Email, HTML tags, telephone numbers and so on. Or just remove all unicode punctuations.

Install

Python 3.x only.

pip

pip install plane

Install from source

python setup.py install

Usage

pattern

Regex is a namedtuple with 3 items:

• name

• pattern: Regular Expression

• repl: replacement tag, this will replace matched regex when using replace function

# create new pattern
from plane import build_new_regex
custom_regex = build_new_regex('my_regex', r'(\d{4})', '<my-replacement-tag>')

Default Regex:

• RESTRICT_URL: only ASCII

• EMAIL: local-part@domain

• TELEPHONE: like xxx-xxxx-xxxx

• SPACE: r'\s'

• HTML: HTML tags, Script part and CSS part

Use regex to extract or replace:

from plane import EMAIL, extract, replace
text = '[e-mail] & [e-mail]'

emails = extract(text, [EMAIL]) # this return a generator object
for e in emails:
    print(e)

>>> Token(name='Email', value='[e-mail]', start=0, end=11)
>>> Token(name='Email', value='[e-mail]', start=14, end=34)

replace(text, [EMAIL])

>>> '<Email> & <Email>'

punctuation

remove_punctuation will replace all unicode punctuations to ' ' or something you send to this function as paramter repl.

Attention: ‘+’, ‘^’, ‘$’, ‘~’ and some chars are not punctuation.

from plane import remove_punctuation

text = 'Hello world!'
remove_punctuation(text)

>>> 'Hello world '

# replace punctuation with special string
remove_punctuation(text, '<P>')

>>> 'Hello world<P>'