From d4e87e8c56d7736753879ca4083669aa801a9c48 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Sun, 28 Sep 2014 11:36:39 -0400 Subject: [PATCH] Improve docstrings for IP verification functions Add input type and return type values for the new IP verification functions. Change-Id: I43bd86bd71fd2de61baee5b46e4843e59886f5d4 --- oslo/utils/netutils.py | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/oslo/utils/netutils.py b/oslo/utils/netutils.py index a435b268..3d2af679 100644 --- a/oslo/utils/netutils.py +++ b/oslo/utils/netutils.py @@ -77,7 +77,12 @@ def parse_host_port(address, default_port=None): def is_valid_ipv4(address): - """Verify that address represents a valid IPv4 address.""" + """Verify that address represents a valid IPv4 address. + + :param address: Value to verify + :type address: string + :returns: bool + """ try: return netaddr.valid_ipv4(address) except Exception: @@ -85,7 +90,12 @@ def is_valid_ipv4(address): def is_valid_ipv6(address): - """Verify that address represents a valid IPv6 address.""" + """Verify that address represents a valid IPv6 address. + + :param address: Value to verify + :type address: string + :returns: bool + """ try: return netaddr.valid_ipv6(address) except Exception: @@ -93,7 +103,12 @@ def is_valid_ipv6(address): def is_valid_ip(address): - """Verify that address represents a valid IP address.""" + """Verify that address represents a valid IP address. + + :param address: Value to verify + :type address: string + :returns: bool + """ return is_valid_ipv4(address) or is_valid_ipv6(address)