diff options
author | Bob Halley <halley@dnspython.org> | 2017-01-03 15:19:15 -0800 |
---|---|---|
committer | Bob Halley <halley@dnspython.org> | 2017-01-03 15:19:15 -0800 |
commit | d18a3a7671ae3dc0589ecae1779eb9c847b11102 (patch) | |
tree | fa0c9fec01e643902f868ea9ccbd03dbc384a3f4 /dns/inet.py | |
parent | 8db7de470891dc78050f16a8f41b2582ae563e3b (diff) | |
download | dnspython-d18a3a7671ae3dc0589ecae1779eb9c847b11102.tar.gz |
doco overhaul
Diffstat (limited to 'dns/inet.py')
-rw-r--r-- | dns/inet.py | 50 |
1 files changed, 30 insertions, 20 deletions
diff --git a/dns/inet.py b/dns/inet.py index a8ff38d..f417749 100644 --- a/dns/inet.py +++ b/dns/inet.py @@ -1,4 +1,4 @@ -# Copyright (C) 2003-2007, 2009-2011 Nominum, Inc. +# Copyright (C) 2003-2017 Nominum, Inc. # # Permission to use, copy, modify, and distribute this software and its # documentation for any purpose with or without fee is hereby granted, @@ -39,13 +39,14 @@ except AttributeError: def inet_pton(family, text): """Convert the textual form of a network address into its binary form. - @param family: the address family - @type family: int - @param text: the textual address - @type text: string - @raises NotImplementedError: the address family specified is not + *family* is an ``int``, the address family. + + *text* is a ``text``, the textual address. + + Raises ``NotImplementedError`` if the address family specified is not implemented. - @rtype: string + + Returns a ``binary``. """ if family == AF_INET: @@ -59,14 +60,16 @@ def inet_pton(family, text): def inet_ntop(family, address): """Convert the binary form of a network address into its textual form. - @param family: the address family - @type family: int - @param address: the binary address - @type address: string - @raises NotImplementedError: the address family specified is not + *family* is an ``int``, the address family. + + *address* is a ``binary``, the network address in binary form. + + Raises ``NotImplementedError`` if the address family specified is not implemented. - @rtype: string + + Returns a ``text``. """ + if family == AF_INET: return dns.ipv4.inet_ntoa(address) elif family == AF_INET6: @@ -78,11 +81,14 @@ def inet_ntop(family, address): def af_for_address(text): """Determine the address family of a textual-form network address. - @param text: the textual address - @type text: string - @raises ValueError: the address family cannot be determined from the input. - @rtype: int + *text*, a ``text``, the textual address. + + Raises ``ValueError`` if the address family cannot be determined + from the input. + + Returns an ``int``. """ + try: dns.ipv4.inet_aton(text) return AF_INET @@ -97,10 +103,14 @@ def af_for_address(text): def is_multicast(text): """Is the textual-form network address a multicast address? - @param text: the textual address - @raises ValueError: the address family cannot be determined from the input. - @rtype: bool + *text*, a ``text``, the textual address. + + Raises ``ValueError`` if the address family cannot be determined + from the input. + + Returns a ``bool``. """ + try: first = maybe_ord(dns.ipv4.inet_aton(text)[0]) return first >= 224 and first <= 239 |