Skip to main content

A simple text filter for GFW friendly UGC applications.

Project description

A simple text filter for GFW friendly UGC applications.

Usage

Load Dict

Load dict from iterable:

>> words_filter = Filter([u'Word1', u'Word2'])

Or load from file using load_dict utility, one word per line:

>> words_iter = load_dict('/path/to/your/dict')
>> words_filter = Filter(words_iter)

This library also provided a default dict in it, but it is not recommended:

>> words_filter = Filter.default()

Note

All the words in the default dictionary are collected from internet, and just for testing purpose.

Contains

>> words_filter.contains(u'There is a keyword.')
True

Replace

>> words_filter.replace(u'There is a keyword.', u'*')
u'There is a *******.'

Performance

Python 2.7.8, MacBook Pro (Retina, 15-inch, Late 2013), 2.3 GHz Intel Core i7

$ ./env/bin/python -m timeit -s "import hgfw; f = hgfw.Filter.default()" "f.contains(u'测试字符串:在当前的形势下,我们要更加积极的举报黄色网站。')"
10000 loops, best of 3: 24.7 usec per loop

$ ./env/bin/python -m timeit -s "import hgfw; f = hgfw.Filter.default()" "f.search(u'测试字符串:在当前的形势下,我们要更加积极的举报黄色网站。')"
10000 loops, best of 3: 25.3 usec per loop

$ ./env/bin/python -m timeit -s "import hgfw; f = hgfw.Filter.default()" "f.replace(u'测试字符串:在当前的形势下,我们要更加积极的举报黄色网站。')"
10000 loops, best of 3: 34.5 usec per loop

TODO

  • Optimize matching algorithm
  • Add the ability to share data between processes
  • Provide higher-quality dictionaries
  • Provide different dictionary for contains, search and replace

License

The MIT License (MIT)

Copyright (c) 2015 Microdog

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Dependency DAWG is licensed under MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hello-gfw, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size hello_gfw-0.0.1-py2.py3-none-any.whl (9.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size hello-gfw-0.0.1.tar.gz (8.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page