PyFunceble.checker package¶
Subpackages¶
- PyFunceble.checker.availability package
- Subpackages
- PyFunceble.checker.availability.extras package
- Submodules
- PyFunceble.checker.availability.extras.base module
- PyFunceble.checker.availability.extras.dns module
- PyFunceble.checker.availability.extras.etoxic module
- PyFunceble.checker.availability.extras.parked module
- PyFunceble.checker.availability.extras.rules module
- PyFunceble.checker.availability.extras.subject_switch module
- Module contents
- PyFunceble.checker.availability.extras package
- Submodules
- PyFunceble.checker.availability.base module
- PyFunceble.checker.availability.domain module
- PyFunceble.checker.availability.domain_and_ip module
- PyFunceble.checker.availability.ip module
- PyFunceble.checker.availability.params module
- PyFunceble.checker.availability.status module
- PyFunceble.checker.availability.url module
- Module contents
- Subpackages
- PyFunceble.checker.reputation package
- Submodules
- PyFunceble.checker.reputation.base module
- PyFunceble.checker.reputation.domain module
- PyFunceble.checker.reputation.domain_and_ip module
- PyFunceble.checker.reputation.ip module
- PyFunceble.checker.reputation.params module
- PyFunceble.checker.reputation.status module
- PyFunceble.checker.reputation.url module
- Module contents
- PyFunceble.checker.syntax package
- Submodules
- PyFunceble.checker.syntax.base module
- PyFunceble.checker.syntax.domain module
- PyFunceble.checker.syntax.domain_and_ip module
- PyFunceble.checker.syntax.domain_base module
- PyFunceble.checker.syntax.ip module
- PyFunceble.checker.syntax.ipv4 module
- PyFunceble.checker.syntax.ipv6 module
- PyFunceble.checker.syntax.params module
- PyFunceble.checker.syntax.second_lvl_domain module
- PyFunceble.checker.syntax.status module
- PyFunceble.checker.syntax.subdomain module
- PyFunceble.checker.syntax.url module
- Module contents
- PyFunceble.checker.utils package
Submodules¶
PyFunceble.checker.base module¶
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the base of all checker.
- Author:
- Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- https://pyfunceble.github.io/#/special-thanks
- Contributors:
- https://pyfunceble.github.io/#/contributors
- Project link:
- https://github.com/funilrys/PyFunceble
- Project documentation:
- https://pyfunceble.readthedocs.io/en/latest/
- Project homepage:
- https://pyfunceble.github.io/
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
class
PyFunceble.checker.base.
CheckerBase
(subject: Optional[str] = None, *, do_syntax_check_first: Optional[bool] = None, db_session: Optional[sqlalchemy.orm.session.Session] = None, use_collection: Optional[bool] = None)[source]¶ Bases:
object
Provides the base of all checker.
Parameters: -
STD_DO_SYNTAX_CHECK_FIRST
= False¶
-
STD_USE_COLLECTION
= False¶
-
collection_query_tool
= None¶
-
db_session
= None¶
-
do_syntax_check_first
¶ Provides the current state of the
do_syntax_check_first
attribute.
-
ensure_subject_is_given
()[source]¶ Ensures that the subject is given before running the decorated method.
Raises: TypeError – If the subject is not a string.
-
get_status
() → Optional[PyFunceble.checker.status_base.CheckerStatusBase][source]¶ Provides the current state of the status.
Note
This method will automatically query status using the
PyFunceble.checker.base.CheckerBase.query_status()
if thePyFunceble.checker.status_base.CheckerStatusBase.status
attribute is not set.
-
guess_and_set_use_collection
() → PyFunceble.checker.base.CheckerBase[source]¶ Try to guess and set the value of the
use_collection
attribute.
-
idna_subject
¶ Provides the current state of the
_idna_subject
attribute.
-
params
= None¶
-
propagate_subject
()[source]¶ Propagates the subject to the object that need it after launching the decorated method.
-
query_common_checker
() → PyFunceble.checker.base.CheckerBase[source]¶ Queries the common checkers.
Warning
Be sure to use setup your status first.
-
set_do_syntax_check_first
(value: bool) → PyFunceble.checker.base.CheckerBase[source]¶ Sets the value which allow us to do a syntax check first.
Parameters: value – The subject to set.
-
set_idna_subject
(value: str) → PyFunceble.checker.base.CheckerBase[source]¶ Sets the subject to work with.
Parameters: value – The subject to set.
-
set_subject
(value: str) → PyFunceble.checker.base.CheckerBase[source]¶ Sets the subject to work with.
Parameters: value – The subject to set.
-
set_use_collection
(value: bool) → PyFunceble.checker.base.CheckerBase[source]¶ Sets the value which authorizes the usage of the Collection.
Parameters: value – The value to set.
-
status
= None¶
-
subject
¶ Provides the current state of the
_subject
attribute.
-
subject_propagator
() → PyFunceble.checker.base.CheckerBase[source]¶ Propagate the currently set subject.
Warning
Be sure to use setup your status first.
-
update_status_date_after_query
()[source]¶ Updates the status dates after running the decorated method.
-
url2netloc
= None¶
-
use_collection
¶ Provides the current value of the
_use_collection
attribute.
-
PyFunceble.checker.complex_json_encoder module¶
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides our very own complex JSON encoder. The purpose of this encoder compared to others is that it was built for the conversion of records or statuses provided by the checker(s).
- Author:
- Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- https://pyfunceble.github.io/#/special-thanks
- Contributors:
- https://pyfunceble.github.io/#/contributors
- Project link:
- https://github.com/funilrys/PyFunceble
- Project documentation:
- https://pyfunceble.readthedocs.io/en/latest/
- Project homepage:
- https://pyfunceble.github.io/
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
PyFunceble.checker.params_base module¶
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the base of all our params classes.
- Author:
- Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- https://pyfunceble.github.io/#/special-thanks
- Contributors:
- https://pyfunceble.github.io/#/contributors
- Project link:
- https://github.com/funilrys/PyFunceble
- Project documentation:
- https://pyfunceble.readthedocs.io/en/latest/
- Project homepage:
- https://pyfunceble.github.io/
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
PyFunceble.checker.status_base module¶
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the base of all our status classes.
- Author:
- Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- https://pyfunceble.github.io/#/special-thanks
- Contributors:
- https://pyfunceble.github.io/#/contributors
- Project link:
- https://github.com/funilrys/PyFunceble
- Project documentation:
- https://pyfunceble.readthedocs.io/en/latest/
- Project homepage:
- https://pyfunceble.github.io/
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
class
PyFunceble.checker.status_base.
CheckerStatusBase
(subject_kind: Optional[str] = None, subject: Optional[str] = None, idna_subject: Optional[str] = None, netloc: Optional[str] = None, status: Optional[str] = None, status_source: Optional[str] = None, tested_at: Optional[datetime.datetime] = None, params: Optional[PyFunceble.checker.params_base.CheckerParamsBase] = None)[source]¶ Bases:
object
Provides the base of all status classes.
-
idna_subject
= None¶
-
netloc
= None¶
-
params
= None¶
-
status
= None¶
-
status_source
= None¶
-
subject
= None¶
-
subject_kind
= None¶
-
tested_at
= None¶
-
Module contents¶
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the checkers.
- Author:
- Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- https://pyfunceble.github.io/#/special-thanks
- Contributors:
- https://pyfunceble.github.io/#/contributors
- Project link:
- https://github.com/funilrys/PyFunceble
- Project documentation:
- https://pyfunceble.readthedocs.io/en/latest/
- Project homepage:
- https://pyfunceble.github.io/
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.