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()
Contains
>> words_filter.contains(u'There is a keyword.')
True
Search
>> words_filter.search(u'There is a keyword.')
[(11, u'keyword')]
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.
Source Distribution
Built Distribution
Hashes for hello_gfw-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f778b573ae58667cfc94c63e37e9e04e10c841d45dc1326a3711290345986b0e |
|
MD5 | faeb1ed5c182063f74b2d9dd4b9c505f |
|
BLAKE2b-256 | fda5782c81594c55a8f3f27aed8926ded748e2d4d1a19fd33512358ad0dceff8 |