commit 4dc4c37b533677b16f5614318b9bd5cad87607bc Author: Isis Lovecruft isis@torproject.org Date: Fri Dec 20 07:00:19 2013 +0000
Add Sphinx param docs for bridgedb.Dist.uniformMap(). --- lib/bridgedb/Dist.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/lib/bridgedb/Dist.py b/lib/bridgedb/Dist.py index 706873f..5fc8094 100644 --- a/lib/bridgedb/Dist.py +++ b/lib/bridgedb/Dist.py @@ -22,11 +22,13 @@ from bridgedb.Filters import filterBridgesByIP6
def uniformMap(ip): """Map an IP to an arbitrary 'area' string, such that any two /24 addresses - get the same string. + get the same string.
>>> from bridgedb import Dist >>> Dist.uniformMap('1.2.3.4') '1.2.3' + + :param str ip: A string representing an IPv4 or IPv6 address. """ if type(IPAddress(ip)) is IPv6Address: return ":".join(IPv6Address(ip).exploded.split(':')[:4])