Checkers
As of PyFunceble 4.0.0
, it is possible to use our checker without any
configuration of initialization of any sort. Simply choose your checker,
interact with it and get what you are looking for!
Getting started
Before starting to play with any checkers you need to understand 2 things:
The first one is the base of all checkers, and the second is the base of all
status you get when you call the
get_status()
method.
Interaction with checkers
Note
This method is the same for all available checkers.
Let’s say we want to test the availability of github.com
.
We first have to select and prepare the checker.
from PyFunceble import DomainAvailabilityChecker
# Here we take the default configuration.
checker = DomainAvailabilityChecker()
Then we just set the subject to work with.
checker.set_subject("github.com")
We can then get the status.
status = checker.get_status()
# Note: You can also do it in one shot.
status = checker.set_subject("github.com").get_status()
Once we have a status object, we can convert it to a different format.
# To dict.
status_dict = status.to_dict()
# To JSON.
status_json = status.to_json()
We can also interact with any of the attributes of the status object.
# This is the status.
print("GitHub is", status.status)
But finally, and probably most importantly, we can ask questions.
Warning
Each checker have their own set of methods. Be sure to read them or follow the autocomplete of your editor.
# Is it active ?
print("Is GitHub active ?", status.is_active())
# Is it inactive ?
print("Is GitHub inactive ?", status.is_inactive())
# Is it invalid ?
print("Is github.com invalid ?", status.is_invalid())
Available Checkers
In this section you can find the list of available checkers and how to import them.
Availability checkers
- Domain:
PyFunceble.checker.availability.domain.DomainAvailabilityChecker
or
from PyFunceble import DomainAvailabilityChecker
- Domain and IP:
PyFunceble.checker.availability.domain_and_ip.DomainAndIPAvailabilityChecker
or
from PyFunceble import DomainAndIPAvailabilityChecker
- URL:
PyFunceble.checker.availability.url.URLAvailabilityChecker
or
from PyFunceble import URLAvailabilityChecker
- IP (v4 / v6):
PyFunceble.checker.availability.ip.IPAvailabilityChecker
or
from PyFunceble import IPAvailabilityChecker
Syntax checkers
- Domain (Second level domain / Subdomain):
-
or
from PyFunceble import DomainAvailabilityChecker
- Second Level Domain:
-
or
from PyFunceble import SecondLvlDomainSyntaxChecker
- Subdomain:
-
or
from PyFunceble import SubDomainSyntaxChecker
- URL:
-
or
from PyFunceble import URLSyntaxChecker
- IP (v4 / v6):
-
or
from PyFunceble import IPSyntaxChecker
- IPv4
-
or
from PyFunceble import IPv4SyntaxChecker
- IPv6
-
or
from PyFunceble import IPv6SyntaxChecker
Reputation checkers
- Domain:
PyFunceble.checker.reputation.domain.DomainReputationChecker
or
from PyFunceble import DomainReputationChecker
- Domain and IP:
PyFunceble.checker.reputation.domain_and_ip.DomainAndIPReputationChecker
or
from PyFunceble import DomainAndIPReputationChecker
- URL:
PyFunceble.checker.reputation.url.URLReputationChecker
or
from PyFunceble import URLReputationChecker
- IP (v4 / v6):
PyFunceble.checker.reputation.ip.IPReputationChecker
or
from PyFunceble import IPReputationChecker