ip_address¶

validators.ip_address.ipv4(value: str, /, *, cidr: bool = True, strict: bool = False, private: bool | None = None, host_bit: bool = True)¶

Returns whether a given value is a valid IPv4 address.

From Python version 3.9.5 leading zeros are no longer tolerated and are treated as an error. The initial version of ipv4 validator was inspired from [WTForms IPAddress validator][1].

[1]: https://github.com/wtforms/wtforms/blob/master/src/wtforms/validators.py

Examples

>>> ipv4('123.0.0.7')
True
>>> ipv4('1.1.1.1/8')
True
>>> ipv4('900.80.70.11')
ValidationError(func=ipv4, args={'value': '900.80.70.11'})

Parameters:

value – IP address string to validate.
cidr – IP address string may contain CIDR notation.
strict – IP address string is strictly in CIDR notation.
private – IP address is public if False, private/local/loopback/broadcast if True.
host_bit – If False and host bits (along with network bits) _are_ set in the supplied address, this function raises a validation error. ref [IPv4Network][2]. [2]: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network

Returns:

If value is a valid IPv4 address. (ValidationError): If value is an invalid IPv4 address.

Return type:

(Literal[True])

validators.ip_address.ipv6(value: str, /, *, cidr: bool = True, strict: bool = False, host_bit: bool = True)¶

Returns if a given value is a valid IPv6 address.

Including IPv4-mapped IPv6 addresses. The initial version of ipv6 validator was inspired from [WTForms IPAddress validator][1].