API documentation

Note

This section document what you can call directly when you use PyFunceble as an imported module.

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

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

This submodule is the main entry of PyFunceble.

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

License:

MIT License

Copyright (c) 2017-2018 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.
PyFunceble.ipv4_syntax_check(ip)[source]

Check the syntax of the given IPv4.

Parameters:ip (str) – The IPv4 to check the syntax for.
Returns:The syntax validity.
Return type:bool
PyFunceble.load_config(under_test=False)[source]

Load the configuration.

Parameters:under_test (bool) – Tell us if we only have to load the configuration file (True) or load the configuration file and initate the output directory if it does not exist (False).
PyFunceble.syntax_check(domain)[source]

Check the syntax of the given domain.

Parameters:domain (str) – The domain to check the syntax for.
Returns:The syntax validity.
Return type:bool
PyFunceble.test(domain, complete=False)[source]

Test the availability of the given domain or IP.

Parameters:
  • domain (str) – The domain or IP to test.
  • complete (bool) – Activate the return of a dict with some significant data from the test.
Returns:

The status or the informations of the domain.

Return type:

str|dict

Note

This function abstract and simplify for the access to the core for the end-user.

PyFunceble.url_syntax_check(url)[source]

Check the syntax of the given URL.

Parameters:url (str) – The URL to check the syntax for.
Returns:The syntax validity.
Return type:bool
PyFunceble.url_test(url, complete=False)[source]

Test the availability of the given URL.

Parameters:
  • url (str) – The URL to test.
  • complete (bool) – Activate the return of a dict with some significant data from the test.
Returns:

The status or the informations of the URL.

Return type:

str|dict

Note

This function abstract and simplify for the access to the core for the end-user.