Skip to content

# Base

The tool to check the availability or syntax of domain, IP or URL.

::

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

Provides the base of all our workers.

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://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 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.

## `WorkerBase`

Bases: `WorkerCore`

Provides the base of all our workers.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`input_queue` |  | The input queue to read. | required
`output_queue` |  | The output queue to write. | required

Source code in `PyFunceble/cli/processes/workers/base.py`

     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132

    class WorkerBase(PyFunceble.ext.process_manager.WorkerCore):
        """
        Provides the base of all our workers.

        :param input_queue:
            The input queue to read.
        :param output_queue:
            The output queue to write.
        """

        db_session: Optional[PyFunceble.cli.factory.db_session] = None
        requester: Optional[Requester] = None

        def __del__(self) -> None:
            if self.db_session is not None:
                try:
                    self.db_session.close()
                except sqlalchemy.exc.OperationalError:
                    pass

        def __post_init__(self) -> None:
            self.requester = Requester(config=PyFunceble.storage.CONFIGURATION)
            try:
                self.db_session = (
                    PyFunceble.cli.factory.DBSession.get_db_session().get_new_session()()
                )
            except TypeError:
                self.db_session = None

        def perform_external_poweron_checks(self) -> bool:
            """
            Perform the external poweron checks.
            """

            if hasattr(self, "configuration") and self.configuration is not None:
                PyFunceble.facility.ConfigLoader.set_custom_config(self.configuration)

            if (
                multiprocessing.get_start_method() != "fork"
                or not PyFunceble.storage.CONFIGURATION
            ):
                PyFunceble.facility.ConfigLoader.start()
                PyFunceble.cli.facility.CredentialLoader.start()
                PyFunceble.cli.factory.DBSession.init_db_sessions()

            return super().perform_external_poweron_checks()

        def perform_external_preflight_checks(self) -> bool:
            """
            Perform the external preflight checks.
            """

            if (
                hasattr(self, "continuous_integration")
                and self.continuous_integration
                and self.continuous_integration.is_time_exceeded()
            ):
                PyFunceble.facility.Logger.info("CI time exceeded. Stopping worker.")

                if not self.delay_shutdown:
                    self.exit_event.set()

                return False

            return super().perform_external_preflight_checks()

### `perform_external_poweron_checks()`

Perform the external poweron checks.

Source code in `PyFunceble/cli/processes/workers/base.py`

     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113

    def perform_external_poweron_checks(self) -> bool:
        """
        Perform the external poweron checks.
        """

        if hasattr(self, "configuration") and self.configuration is not None:
            PyFunceble.facility.ConfigLoader.set_custom_config(self.configuration)

        if (
            multiprocessing.get_start_method() != "fork"
            or not PyFunceble.storage.CONFIGURATION
        ):
            PyFunceble.facility.ConfigLoader.start()
            PyFunceble.cli.facility.CredentialLoader.start()
            PyFunceble.cli.factory.DBSession.init_db_sessions()

        return super().perform_external_poweron_checks()

### `perform_external_preflight_checks()`

Perform the external preflight checks.

Source code in `PyFunceble/cli/processes/workers/base.py`

    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132

    def perform_external_preflight_checks(self) -> bool:
        """
        Perform the external preflight checks.
        """

        if (
            hasattr(self, "continuous_integration")
            and self.continuous_integration
            and self.continuous_integration.is_time_exceeded()
        ):
            PyFunceble.facility.Logger.info("CI time exceeded. Stopping worker.")

            if not self.delay_shutdown:
                self.exit_event.set()

            return False

        return super().perform_external_preflight_checks()