PyFunceble package
Subpackages
- PyFunceble.checker package
- Subpackages
- PyFunceble.checker.availability package
- Subpackages
- 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
- 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
- PyFunceble.checker.availability package
- Submodules
- PyFunceble.checker.base module
CheckerBase
CheckerBase.STD_DO_SYNTAX_CHECK_FIRST
CheckerBase.STD_USE_PLATFORM
CheckerBase.db_session
CheckerBase.do_syntax_check_first
CheckerBase.ensure_subject_is_given()
CheckerBase.get_status()
CheckerBase.guess_and_set_use_platform()
CheckerBase.idna_subject
CheckerBase.is_valid()
CheckerBase.params
CheckerBase.platform_query_tool
CheckerBase.propagate_subject()
CheckerBase.query_common_checker()
CheckerBase.query_status()
CheckerBase.query_status_if_missing()
CheckerBase.set_do_syntax_check_first()
CheckerBase.set_idna_subject()
CheckerBase.set_subject()
CheckerBase.set_use_platform()
CheckerBase.status
CheckerBase.subject
CheckerBase.subject_propagator()
CheckerBase.update_status_date_after_query()
CheckerBase.url2netloc
CheckerBase.use_platform
- PyFunceble.checker.complex_json_encoder module
- PyFunceble.checker.params_base module
- PyFunceble.checker.status_base module
- Module contents
- Subpackages
- PyFunceble.cli package
- Subpackages
- PyFunceble.cli.continuous_integration package
- Submodules
- PyFunceble.cli.continuous_integration.base module
- PyFunceble.cli.continuous_integration.exceptions module
- PyFunceble.cli.continuous_integration.github_actions module
- PyFunceble.cli.continuous_integration.gitlab_ci module
- PyFunceble.cli.continuous_integration.jenkins module
- PyFunceble.cli.continuous_integration.standalone module
- PyFunceble.cli.continuous_integration.travis_ci module
- PyFunceble.cli.continuous_integration.utils module
- Module contents
- PyFunceble.cli.entry_points package
- PyFunceble.cli.filesystem package
- Subpackages
- Submodules
- PyFunceble.cli.filesystem.cleanup module
- PyFunceble.cli.filesystem.counter module
- PyFunceble.cli.filesystem.dir_base module
- PyFunceble.cli.filesystem.json_base module
- PyFunceble.cli.filesystem.registrar_counter module
- PyFunceble.cli.filesystem.status_file module
- Module contents
- PyFunceble.cli.migrators package
- PyFunceble.cli.processes package
- Subpackages
- Submodules
- PyFunceble.cli.processes.base module
- PyFunceble.cli.processes.chancy_producer module
- PyFunceble.cli.processes.chancy_tester module
- PyFunceble.cli.processes.dir_files_sorter module
- PyFunceble.cli.processes.file_sorter module
- PyFunceble.cli.processes.migrator module
- PyFunceble.cli.processes.miner module
- PyFunceble.cli.processes.producer module
- PyFunceble.cli.processes.tester module
- Module contents
- PyFunceble.cli.scripts package
- PyFunceble.cli.system package
- PyFunceble.cli.utils package
- PyFunceble.cli.continuous_integration package
- Submodules
- PyFunceble.cli.credential_loader module
CredentialLoader
CredentialLoader.DB_TYPE2OBJ
CredentialLoader.ask_for_info()
CredentialLoader.authorized
CredentialLoader.credential
CredentialLoader.db_type
CredentialLoader.ensure_db_type_is_given()
CredentialLoader.execute_if_authorized()
CredentialLoader.get_uri()
CredentialLoader.is_already_loaded()
CredentialLoader.set_credential_var()
CredentialLoader.set_db_type()
CredentialLoader.start()
CredentialLoader.start_if_not_started()
- PyFunceble.cli.execution_time module
ExecutionTime
ExecutionTime.STD_AUTHORIZED
ExecutionTime.authorized
ExecutionTime.end_time
ExecutionTime.execute_if_authorized()
ExecutionTime.get_info()
ExecutionTime.guess_and_set_authorized()
ExecutionTime.set_authorized()
ExecutionTime.set_end_time()
ExecutionTime.set_start_time()
ExecutionTime.split_difference()
ExecutionTime.start_time
- PyFunceble.cli.facility module
- PyFunceble.cli.factory module
- PyFunceble.cli.file_preloader module
FilePreloader
FilePreloader.STD_AUTHORIZED
FilePreloader.adblock_inputline2subject
FilePreloader.authorized
FilePreloader.checker_type
FilePreloader.cidr2subject
FilePreloader.continue_dataset
FilePreloader.continuous_integration
FilePreloader.does_preloader_description_file_exists()
FilePreloader.ensure_protocol_is_given()
FilePreloader.execute_if_authorized()
FilePreloader.guess_and_set_authorized()
FilePreloader.inputline2subject
FilePreloader.protocol
FilePreloader.rpz_inputline2subject
FilePreloader.rpz_policy2subject
FilePreloader.set_authorized()
FilePreloader.set_protocol()
FilePreloader.start()
FilePreloader.subject2complements
FilePreloader.url2netloc
FilePreloader.wildcard2subject
- PyFunceble.cli.storage module
- PyFunceble.cli.storage_facility module
- Module contents
- Subpackages
- PyFunceble.config package
- Submodules
- PyFunceble.config.compare module
ConfigComparison
ConfigComparison.DELETED_CORE
ConfigComparison.DELETED_LINKS
ConfigComparison.DELETE_FLATTEN
ConfigComparison.NEW_STATUS_CODES
ConfigComparison.OLD_TO_NEW
ConfigComparison.OLD_TO_NEW_NEGATE
ConfigComparison.dict_helper
ConfigComparison.get_merged()
ConfigComparison.is_local_identical()
ConfigComparison.local_config
ConfigComparison.set_local_config()
ConfigComparison.set_upstream_config()
ConfigComparison.upstream_config
- PyFunceble.config.loader module
ConfigLoader
ConfigLoader.conditional_switch()
ConfigLoader.config_file_exist()
ConfigLoader.custom_config
ConfigLoader.default_config_file_exist()
ConfigLoader.destroy()
ConfigLoader.dict_helper
ConfigLoader.download_dynamic_infrastructure_files()
ConfigLoader.file_helper
ConfigLoader.get_config_file_content()
ConfigLoader.get_configured_value()
ConfigLoader.install_missing_infrastructure_files()
ConfigLoader.is_already_loaded()
ConfigLoader.merge_upstream
ConfigLoader.path_to_config
ConfigLoader.path_to_default_config
ConfigLoader.path_to_overwrite_config
ConfigLoader.reload_config()
ConfigLoader.set_custom_config()
ConfigLoader.set_merge_upstream()
ConfigLoader.start()
- Module contents
- PyFunceble.converter package
- Submodules
- PyFunceble.converter.adblock_input_line2subject module
- PyFunceble.converter.base module
- PyFunceble.converter.cidr2subject module
- PyFunceble.converter.input_line2subject module
- PyFunceble.converter.internal_url module
- PyFunceble.converter.rpz_input_line2subject module
- PyFunceble.converter.rpz_policy2subject module
RPZPolicy2Subject
RPZPolicy2Subject.CLEANUP_MARKERS
RPZPolicy2Subject.IP_MARKERS
RPZPolicy2Subject.convert()
RPZPolicy2Subject.get_converted()
RPZPolicy2Subject.get_matching_cleanup_marker()
RPZPolicy2Subject.get_matching_ip_marker()
RPZPolicy2Subject.get_subject_from_ip_marker()
RPZPolicy2Subject.remove_marker()
RPZPolicy2Subject.set_soa()
RPZPolicy2Subject.set_soas()
RPZPolicy2Subject.soa
RPZPolicy2Subject.soas
RPZPolicy2Subject.wilcard2subject
- PyFunceble.converter.subject2complements module
- PyFunceble.converter.url2netloc module
- PyFunceble.converter.wildcard2subject module
- Module contents
- PyFunceble.data package
- PyFunceble.database package
- PyFunceble.dataset package
- Subpackages
- Submodules
- PyFunceble.dataset.base module
- PyFunceble.dataset.csv_base module
- PyFunceble.dataset.db_base module
DBDatasetBase
DBDatasetBase.COMPARISON_FIELDS
DBDatasetBase.FIELDS
DBDatasetBase.STD_AUTHORIZED
DBDatasetBase.STD_REMOVE_UNNEEDED_FIELDS
DBDatasetBase.add()
DBDatasetBase.are_equal()
DBDatasetBase.authorized
DBDatasetBase.cleanup()
DBDatasetBase.execute_if_authorized()
DBDatasetBase.exists()
DBDatasetBase.get_content()
DBDatasetBase.get_filtered_content()
DBDatasetBase.get_filtered_row()
DBDatasetBase.remove()
DBDatasetBase.remove_unneeded_fields
DBDatasetBase.set_authorized()
DBDatasetBase.set_remove_unneeded_fields()
DBDatasetBase.source_file
DBDatasetBase.update()
- PyFunceble.dataset.iana module
- PyFunceble.dataset.ipv4_reputation module
- PyFunceble.dataset.public_suffix module
- PyFunceble.dataset.sql_base module
SQLDBDatasetBase
SQLDBDatasetBase.ORM_OBJ
SQLDBDatasetBase.STD_KEEP_SESSION_OPEN
SQLDBDatasetBase.add()
SQLDBDatasetBase.db_session
SQLDBDatasetBase.ensure_orm_obj_is_given()
SQLDBDatasetBase.exists()
SQLDBDatasetBase.get_content()
SQLDBDatasetBase.get_existing_row()
SQLDBDatasetBase.get_existing_row_id()
SQLDBDatasetBase.remove()
SQLDBDatasetBase.update()
- PyFunceble.dataset.user_agent module
- Module contents
- PyFunceble.downloader package
- Submodules
- PyFunceble.downloader.base module
DownloaderBase
DownloaderBase.DOWNLOAD_FREQUENCY
DownloaderBase.DOWNTIME_INDEX
DownloaderBase.all_downtimes
DownloaderBase.authorized
DownloaderBase.destination
DownloaderBase.dict_helper
DownloaderBase.download_link
DownloaderBase.get_all_downtimes()
DownloaderBase.get_current_downtime()
DownloaderBase.is_downtime_set()
DownloaderBase.is_last_download_expired()
DownloaderBase.save_all_downtimes()
DownloaderBase.set_current_downtime()
DownloaderBase.set_destination()
DownloaderBase.set_download_link()
DownloaderBase.start()
- PyFunceble.downloader.exceptions module
- PyFunceble.downloader.iana module
- PyFunceble.downloader.ipv4_reputation module
- PyFunceble.downloader.public_suffix module
- PyFunceble.downloader.user_agents module
- Module contents
- PyFunceble.helpers package
- Submodules
- PyFunceble.helpers.command module
- PyFunceble.helpers.dict module
DictHelper
DictHelper.flatten()
DictHelper.from_json()
DictHelper.from_json_file()
DictHelper.from_yaml()
DictHelper.from_yaml_file()
DictHelper.has_same_keys_as()
DictHelper.remove_key()
DictHelper.rename_key()
DictHelper.set_subject()
DictHelper.subject
DictHelper.to_json()
DictHelper.to_json_file()
DictHelper.to_yaml()
DictHelper.to_yaml_file()
DictHelper.unflatten()
- PyFunceble.helpers.directory module
- PyFunceble.helpers.download module
- PyFunceble.helpers.environment_variable module
EnvironmentVariableHelper
EnvironmentVariableHelper.delete()
EnvironmentVariableHelper.delete_from_env_file()
EnvironmentVariableHelper.env_file_path
EnvironmentVariableHelper.exists()
EnvironmentVariableHelper.get_value()
EnvironmentVariableHelper.get_value_from_env_file()
EnvironmentVariableHelper.name
EnvironmentVariableHelper.set_env_file_path()
EnvironmentVariableHelper.set_name()
EnvironmentVariableHelper.set_value()
EnvironmentVariableHelper.set_value_in_env_file()
- PyFunceble.helpers.exceptions module
- PyFunceble.helpers.file module
- PyFunceble.helpers.hash module
- PyFunceble.helpers.list module
- PyFunceble.helpers.merge module
- PyFunceble.helpers.regex module
- Module contents
- PyFunceble.query package
- Subpackages
- Submodules
- PyFunceble.query.http_status_code module
HTTPStatusCode
HTTPStatusCode.STD_ALLOW_REDIRECTS
HTTPStatusCode.STD_TIMEOUT
HTTPStatusCode.STD_UNKNOWN_STATUS_CODE
HTTPStatusCode.STD_VERIFY_CERTIFICATE
HTTPStatusCode.allow_redirects
HTTPStatusCode.ensure_subject_is_given()
HTTPStatusCode.get_status_code()
HTTPStatusCode.guess_and_set_timeout()
HTTPStatusCode.guess_and_set_verify_certificate()
HTTPStatusCode.set_allow_redirects()
HTTPStatusCode.set_subject()
HTTPStatusCode.set_timeout()
HTTPStatusCode.set_verify_certificate()
HTTPStatusCode.subject
HTTPStatusCode.timeout
HTTPStatusCode.verify_certificate
- PyFunceble.query.platform module
PlatformQueryTool
PlatformQueryTool.STD_CHECKER_EXCLUDE
PlatformQueryTool.STD_CHECKER_PRIORITY
PlatformQueryTool.STD_PREFERRED_STATUS_ORIGIN
PlatformQueryTool.STD_TIMEOUT
PlatformQueryTool.SUBJECT
PlatformQueryTool.SUPPORTED_CHECKERS
PlatformQueryTool.SUPPORTED_STATUS_ORIGIN
PlatformQueryTool.checker_exclude
PlatformQueryTool.checker_priority
PlatformQueryTool.deliver_contract()
PlatformQueryTool.ensure_modern_api()
PlatformQueryTool.guess_all_settings()
PlatformQueryTool.guess_and_set_checker_exclude()
PlatformQueryTool.guess_and_set_checker_priority()
PlatformQueryTool.guess_and_set_is_modern_api()
PlatformQueryTool.guess_and_set_preferred_status_origin()
PlatformQueryTool.guess_and_set_timeout()
PlatformQueryTool.is_modern_api
PlatformQueryTool.preferred_status_origin
PlatformQueryTool.pull()
PlatformQueryTool.pull_contract()
PlatformQueryTool.push()
PlatformQueryTool.session
PlatformQueryTool.set_checker_exclude()
PlatformQueryTool.set_checker_priority()
PlatformQueryTool.set_is_modern_api()
PlatformQueryTool.set_preferred_status_origin()
PlatformQueryTool.set_timeout()
PlatformQueryTool.set_token()
PlatformQueryTool.set_url_base()
PlatformQueryTool.timeout
PlatformQueryTool.token
PlatformQueryTool.url_base
- Module contents
- PyFunceble.utils package
- Submodules
- PyFunceble.utils.platform module
- PyFunceble.utils.profile module
- PyFunceble.utils.version module
VersionUtility
VersionUtility.get_real_parsed_version()
VersionUtility.get_splitted()
VersionUtility.is_cloned()
VersionUtility.is_dev()
VersionUtility.is_equal_to()
VersionUtility.is_master()
VersionUtility.is_older_than()
VersionUtility.is_recent()
VersionUtility.literally_compare()
VersionUtility.local_version
VersionUtility.real_local_version
VersionUtility.set_local_version()
- Module contents
Submodules
PyFunceble.exceptions module
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides our exceptions.
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.
- exception PyFunceble.exceptions.NoInternetConnection[source]
Bases:
PyFuncebleException
Describes a missing connection.
- exception PyFunceble.exceptions.PleaseUpdatePyFunceble[source]
Bases:
PyFuncebleException
Describes the impossiblity to continue with an older version.
PyFunceble.facility module
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides everything which we may need while running.
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.factory module
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides everything which doesn’t get through the door of the facility.
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.logger module
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides our logger.
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.logger.Logger(*, activated: bool | None = None, min_level: int | None = None, output_dir: str | None = None)[source]
Bases:
object
Provides our logging logic.
Warning
There is several way to activate the logging.
Through the
PYFUNCEBLE_DEBUG_ON_SCREEN
environment variable.Through the
DEBUG_PYFUNCEBLE_ON_SCREEN
environment variable.Through the
PYFUNCEBLE_DEBUG
environment variable.Through the
DEBUG_PYFUNCEBLE
environment variable.Through the
PyFunceble.logger.Logger.set_activated()
method.
- OWN_FORMAT: str = '[%(asctime)s | %(levelname)s | %(origin_path)s:%(origin_line)s@%(origin_func)s | PPID%(process)d:%(processName)s]:\n%(message)s\n'
Our very own format.
- ROOT_FORMAT: str = '[%(asctime)s::%(levelname)s](PID%(process)s:%(processName)s): %(message)s'
The format of the root loggy.
- env_var_helper: EnvironmentVariableHelper = <PyFunceble.helpers.environment_variable.EnvironmentVariableHelper object>
- get_handler(level_name: str) StreamHandler | RotatingFileHandler | None [source]
Given a level name, this method provides the right handler for it!
- static get_origin() dict [source]
Provides the informatioon about where the logger was triggered.
- Returns:
A tuple, which is composed of the following.
(trigger file path, trigger line, trigger function/method name)
- property output_directory: str | None
Provides the current state of the
_output_directory
attribute.
- set_activated(value: bool) Logger [source]
Sets the value of the activated attribute.
- Parameters:
value – The value to set.
- set_min_level(value: int | str) Logger [source]
Sets the minimum level to log.
- Parameters:
value – The value to set.
- set_output_directory(value: str) Logger [source]
Sets the directory to write.
- Parameters:
value – The value to set.
PyFunceble.sessions module
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the location of all our sessions
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.storage module
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides a central storage place.
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.storage_facility module
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides some facilities for the storage module.
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.
Module contents
The tool to check the availability or syntax of domain, IP or URL.
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
- Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
- Special thanks:
- Contributors:
- Project link:
- Project documentation:
- Project homepage:
License:
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.get_complements(subject: str, include_given: bool = False) List[str] [source]
Provides the complements of a given subject.
A complement is a for example
example.org
ifwww.example.org
is given and vice-versa.Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import Subject2Complements my_subject = "example.org" complements = Subject2Complements( my_subject ).get_converted(include_given=True)
- Parameters:
subject – The subject to work with.
include_given – Include the given subject in the result.
- PyFunceble.is_domain(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid second level domain or subdomain.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import DomainSyntaxChecker my_subject = "example.org" the_status = DomainSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is a domain (2nd level or subdomain). print(f"{my_subject} is domain ? {the_status.is_valid()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_domain_malicious(subject: str, **kwargs) bool [source]
Checks if the given domain is malicious.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import DomainReputationChecker my_subject = "example.org" the_status = DomainReputationChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is malicious. print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_ip(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid IP range.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import IPSyntaxChecker my_subject = "192.168.0.0" the_status = IPSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is an IP (v4 or v6). print(f"{my_subject} is IP ? {the_status.is_valid()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_ip_range(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid IP range.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import IPSyntaxChecker my_subject = "192.168.0.0" the_status = IPSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is an IP range (v4 or v6). print(f"{my_subject} is IP range ? {the_status.is_valid_range()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_ipv4(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid IPv4.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import IPSyntaxChecker my_subject = "192.168.0.0" the_status = IPSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is an IPv4. print(f"{my_subject} is IPv4 ? {the_status.is_valid_v4()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_ipv4_malicious(subject: str, **kwargs) bool [source]
Checks if the given IPv4 is malicious.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import IPReputationChecker my_subject = "192.168.0.1" the_status = IPReputationChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is malicious. print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_ipv4_range(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid IPv4 range.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import IPSyntaxChecker my_subject = "192.168.0.0" the_status = IPSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is IPv4 range. print(f"{my_subject} is IPv4 range ? {the_status.is_valid_v4_range()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_ipv6(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid IPv6.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import IPSyntaxChecker my_subject = "192.168.0.0" the_status = IPSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is an IPv6. print(f"{my_subject} is IPv6 ? {the_status.is_valid_v6()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_ipv6_range(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid IPv6 range.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import IPSyntaxChecker my_subject = "::1" the_status = IPSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is IPv6 range. print(f"{my_subject} is IPv6 range ? {the_status.is_valid_v6_range()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_second_level_domain(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid second level domain.
Warning
This method was added for retrocompatibility. It may be removed in the future and is still available for convenience.
Please consider the following alternative example:
from PyFunceble import SecondLvlDomainSyntaxChecker my_subject = "example.org" the_status = SecondLvlDomainSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is a second level domain. print(f"{my_subject} is 2nd level domain ? {the_status.is_valid()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_subdomain(subject: str, **kwargs) bool [source]
Checks if the given subject is a syntactically valid subdomain.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import SubDomainSyntaxChecker my_subject = "hello.example.org" the_status = SubDomainSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is a subdomain. print(f"{my_subject} is subdomain ? {the_status.is_valid()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.is_url(subject: str, **kwargs) bool [source]
Checks if the given subject is syntactically a valid URL.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import DomainReputationChecker my_subject = "https://example.org" the_status = URLSyntaxChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is a URL. print(f"{my_subject} is URL ? {the_status.is_valid()}")
- Parma subject:
The subject to check.
- PyFunceble.is_url_malicious(subject: str, **kwargs) bool [source]
Checks if the given URL is malicious.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import URLReputationChecker my_subject = "https://example.org" the_status = URLReputationChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is malicious. print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.load_config(*args, **kwargs) None [source]
Placeholder before deletion.
Since 4.0.0, you are not required to load the configuration before hand. If you still want too because you may want to use a special CLI related method, you can doing it so:
import PyFunceble.facility PyFunceble.facility.ConfigLoader.start()
- PyFunceble.test(subject: str, **kwargs) AvailabilityCheckerStatus [source]
Checks the avaialbility of the given subject assuming that it is a domain or an IP.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import DomainAndIPAvailabilityChecker my_subject = "example.org" the_status = DomainAndIPAvailabilityChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is available. print(f"{my_subject} is available ? {the_status.is_available()}")
- Parameters:
subject – The subject to work with.
- PyFunceble.url_test(subject: str, **kwargs) AvailabilityCheckerStatus [source]
Checks the availability of the given subject assuming that it is a URL.
Warning
This method may be removed in the future. It is still available for convenience.
Please consider the following alternative example:
from PyFunceble import URLAvailabilityChecker my_subject = "http://example.org" the_status = URLAvailabilityChecker( my_subject ).get_status() # Get the status in dict format. print(the_status.to_dict()) # Get the status in json format. print(the_status.to_json()) # Check if it is available. print(f"{my_subject} is available ? {the_status.is_available()}")
- Parameters:
subject – The subject to work with.