openstack/oslo.utils
Code Issues Proposed changes

Improve docstrings for IP verification functions

Browse Source 
Add input type and return type values for the new IP verification
functions.

Change-Id: I43bd86bd71fd2de61baee5b46e4843e59886f5d4
This commit is contained in:
Doug Hellmann 2014-09-28 11:36:39 -04:00
parent baacebcd46
commit d4e87e8c56
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
oslo/utils/netutils.py
View File

@ -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)