Check¶

Problematic¶

How can we efficiently check the syntax of IP, domains, and URL?

Documentation¶

The tool to check the availability or syntax of domains, IPv4 or URL.

██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

This submodule will provide a checking logic.

Author:: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:: https://pyfunceble.github.io/special-thanks.html
Contributors:: https://pyfunceble.github.io/contributors.html
Project link:: https://github.com/funilrys/PyFunceble
Project documentation:: https://pyfunceble.readthedocs.io/en/master/
Project homepage:: https://pyfunceble.github.io/

License:

MIT License

Copyright (c) 2017, 2018, 2019 Nissar Chababy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

class PyFunceble.check.Check(subject)[source]¶

Provide severar “checker” around URL, IP or domain syntax..

Parameters:	subject (str) – The subject (URL, IP or domain) to check.

is_domain(subdomain_check=False)[source]¶

Check if the given subject is a valid domain.

Parameters:	subdomain_check (bool) – Activate the subdomain checking.
Returns:	The validity.
Return type:	bool

is_ipv4()[source]¶

Check if the given subject is a valid IPv4.

Returns:	The validity.
Return type:	bool

Note

We only test IPv4 because for now we only them for now.

is_ipv4_range()[source]¶

Check if the given subject is a valid IPv4 range.

Returns:	The validity.
Return type:	bool

Note

We only test IPv4 because for now we only them for now.

is_reserved_ipv4()[source]¶

Check if the given subject is a reserved IPv4.

Note

This method has been written on basis of the following links:

Returns:	The validity.
Return type:	bool

is_subdomain()[source]¶

Check if the given subject is a valid subdomain.

Returns:	The validity.
Return type:	bool

is_url(return_base=False, return_formatted=False)[source]¶

Check if the given subject is a valid URL.

Parameters:	url (str) – The url to validate. return_base (bool) – Allow us the return of the url base (if URL formatted correctly). return_formatted (bool) – Allow us to get the URL converted to IDNA if the conversion is activated.
Returns:	The validity or the base if asked.
Return type:	bool\|str