hostname

validators.hostname.hostname(value: str, /, *, skip_ipv6_addr: bool = False, skip_ipv4_addr: bool = False, may_have_port: bool = True, maybe_simple: bool = True, consider_tld: bool = False, private: bool | None = None, rfc_1034: bool = False, rfc_2782: bool = False)

Return whether or not given value is a valid hostname.

Examples

>>> hostname("ubuntu-pc:443")
True
>>> hostname("this-pc")
True
>>> hostname("xn----gtbspbbmkef.xn--p1ai:65535")
True
>>> hostname("_example.com")
ValidationError(func=hostname, args={'value': '_example.com'})
>>> hostname("123.5.77.88:31000")
True
>>> hostname("12.12.12.12")
True
>>> hostname("[::1]:22")
True
>>> hostname("dead:beef:0:0:0:0000:42:1")
True
>>> hostname("[0:0:0:0:0:ffff:1.2.3.4]:-65538")
ValidationError(func=hostname, args={'value': '[0:0:0:0:0:ffff:1.2.3.4]:-65538'})
>>> hostname("[0:&:b:c:@:e:f::]:9999")
ValidationError(func=hostname, args={'value': '[0:&:b:c:@:e:f::]:9999'})

Parameters:

• value – Hostname string to validate.

• skip_ipv6_addr – When hostname string cannot be an IPv6 address.

• skip_ipv4_addr – When hostname string cannot be an IPv4 address.

• may_have_port – Hostname string may contain port number.

• maybe_simple – Hostname string maybe only hyphens and alpha-numerals.

• consider_tld – Restrict domain to TLDs allowed by IANA.

• private – Embedded IP address is public if False, private/local if True.

• rfc_1034 – Allow trailing dot in domain/host name. Ref: [RFC 1034](https://www.rfc-editor.org/rfc/rfc1034).

• rfc_2782 – Domain/Host name is of type service record. Ref: [RFC 2782](https://www.rfc-editor.org/rfc/rfc2782).

Returns:

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

Return type:

(Literal[True])