ipmongo
Why need ipmongo
When using pymongo to handle ipaddr (Google's IP address manipulation library, https://pypi.python.org/pypi/ipaddr) object, since MongoDB does not support such object type natively, pymongo returns error.
If you want to use ipaddr object without manual conversion of the object when inserting into or selecting from MongoDB, you can use ipmongo to handle it for you automatically.
How to install ipmongo
- ipmongo requires pymongo (https://pypi.python.org/pypi/pymongo/) and ipaddr (https://pypi.python.org/pypi/ipaddr).
- To install ipmongo, run
pip install ipmongo.
How to use ipmongo
- In pymongo, it supports adding 'custom type': http://api.mongodb.org/python/current/examples/custom_type.html
Based on 'custom type', ipmongo handles the logic of 'encoding' and 'decoding' ipaddr object for you. - All you need to do is to add the
TransformIP()class of ipmongo to database instance created from pymongo. - Please refer to test.py for details: https://github.com/wal1ybot/ipmongo/blob/master/test.py
- You can also download and run test.py to play with it.
Limitations of ipmongo
- It only supports ipaddr, Google's IP address manipulation library.
- It only supports IPv4Address, IPv4Network, IPv6Address, IPv6Network of ipaddr.
- It encodes the objects into str for storing in MongoDB. That means you cannot do network math on database level.
- It assumes that you use Python built-in list, set, dict type to store these objects.
Licence of ipmongo
ipmongo is an MIT-licensed Python module.
Change log
2014-09-30: 0.1.3
- Fixed #3: exception thrown when handling set type value
2014-09-29: 0.1.2
- The issue of altering variable processed by ipmongo is now handled by the module. No extra processing is needed by the caller.
2014-09-28: 0.1.1
- Fixed hashbang in test.py, single quote consistency in ipmongo.py. Contributed by Jimmy Wong.
- Address the issue of the content of the variable processed being altered by ipmongo. Please refer to test.py for details.
2014-09-25: 0.1.0
- First release
