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 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: `Process`

Provides the base of all our workers.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`input_queue` | `Optional[Queue]` | The input queue to read. | required
`output_queue` | `Optional[Queue]` | The output queue to write. | `None`

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
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417

    class WorkerBase(multiprocessing.Process):
        """
        Provides the base of all our workers.

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

        STD_NAME: str = "pyfunceble_base_worker"

        MINING_WAIT_TIME: int = 60
        BREAKOFF: float = 2.0

        input_queue: Optional[queue.Queue] = None
        output_queue: Optional[queue.Queue] = None

        continuous_integration: ContinuousIntegrationBase = None

        global_exit_event: Optional[multiprocessing.Event] = None
        exit_it: Optional[multiprocessing.Event] = None

        send_stop_message: Optional[bool] = None
        accept_waiting_delay: Optional[bool] = None

        concurrent_worker_names: Optional[List[str]] = None
        db_session: Optional[PyFunceble.cli.factory.db_session] = None

        _parent_connection: Optional[multiprocessing.connection.Connection] = None
        _child_connection: Optional[multiprocessing.connection.Connection] = None
        _exception: Optional[multiprocessing.Pipe] = None

        _params: Optional[dict] = {}

        def __init__(
            self,
            input_queue: Optional[queue.Queue],
            output_queue: Optional[queue.Queue] = None,
            global_exit_event: Optional[multiprocessing.Event] = None,
            *,
            name: Optional[str] = None,
            daemon: Optional[bool] = None,
            continuous_integration: Optional[ContinuousIntegrationBase] = None,
            configuration: Optional[dict] = None,
        ) -> None:
            self.configuration = self._params["configuration"] = configuration
            self.input_queue = self._params["input_queue"] = input_queue
            self.output_queue = self._params["output_queue"] = output_queue

            self.continuous_integration = self._params["continuous_integration"] = (
                continuous_integration
            )

            self.global_exit_event = self._params["global_exit_event"] = global_exit_event
            self.exit_it = multiprocessing.Event()

            self._parent_connection, self._child_connection = multiprocessing.Pipe()
            self._exception = None

            self.send_stop_message = True
            self.accept_waiting_delay = True
            self.concurrent_worker_names = []

            try:
                self.db_session = (
                    PyFunceble.cli.factory.DBSession.get_db_session().get_new_session()()
                )
            except TypeError:
                self.db_session = None

            super().__init__(name=name, daemon=daemon)

            self.__post_init__()

        def __del__(self) -> None:
            if self.db_session is not None:
                self.db_session.close()

        def __post_init__(self) -> None:
            """
            A method which will be executed after the :code:`__init__` method.
            """

        @property
        def exception(self):
            """
            Provides the exception of the current worker.
            """

            if self._parent_connection.poll():
                self._exception = self._parent_connection.recv()

            return self._exception

        def add_to_input_queue(
            self,
            data: Any,
            *,
            worker_name: Optional[str] = None,
            destination_worker: Optional[str] = None,
        ) -> "WorkerBase":
            """
            Adds the given data to the current queue.

            :param data:
                The data to add into the queue.
            :param destination_worker:
                The name of the worker which is supposed to read the message.
            """

            if worker_name:
                to_send = (worker_name, destination_worker, data)
            else:
                to_send = (self.name, destination_worker, data)

            self.input_queue.put(to_send)

            PyFunceble.facility.Logger.debug("Added to the (input) queue: %r", data)

        def add_to_output_queue(
            self,
            data: Any,
            *,
            worker_name: Optional[str] = None,
            destination_worker: Optional[str] = None,
        ) -> "WorkerBase":
            """
            Adds the given data to the output queue queue.

            :param data:
                The data to add into the queue.
            """

            if worker_name:
                to_send = (worker_name, destination_worker, data)
            else:
                to_send = (self.name, destination_worker, data)

            if self.output_queue is not None:
                for output_queue in self.output_queue:
                    output_queue.put(to_send)

            PyFunceble.facility.Logger.debug("Added to the (output) queue: %r", data)

            return self

        def target(self, consumed: Any) -> Optional[Tuple[Any, ...]]:
            """
            This the target that is run to process something.
            This method should return a result which will pu send to the output
            queue.
            """

            raise NotImplementedError()

        def share_waiting_message(
            self,
            *,
            overall: bool = False,
            ignore_current_worker: bool = False,
            apply_breakoff: bool = False,
        ) -> "WorkerBase":
            """
            Shares a waiting message to both input and output queues.
            The idea is to keep our worker awake when necessary. This functionality
            is really important when running the mining worker because sometime
            the flow is so long, that we may need some time.

            :param overall:
                Shares the message multiple time to specific destination in our
                current stack.
            :param ignore_current_worker:
                Doesn't share the message with ourself.
            :param apply_breakoff:
                Activates the breakoff (sleep) before starting to share the message.
            """

            if overall:
                for worker_name in self.concurrent_worker_names:
                    if apply_breakoff:
                        time.sleep(self.BREAKOFF)

                    if not ignore_current_worker:
                        # Give the whole stack a bit more of time.
                        self.add_to_input_queue("wait", destination_worker=worker_name)

                    self.add_to_output_queue("wait")
            else:
                if apply_breakoff:
                    time.sleep(self.BREAKOFF)

                if not ignore_current_worker:
                    self.add_to_input_queue("wait", destination_worker=self.name)

                self.add_to_output_queue("wait")

        def run(self) -> None:  # pylint: disable=too-many-statements
            def break_now() -> bool:
                """
                Checks if it is time to make a break.
                """

                if not wait_for_stop or not self.accept_waiting_delay:
                    return True

                return datetime.now(timezone.utc) > break_time

            if self.configuration is not None:
                PyFunceble.facility.ConfigLoader.set_custom_config(self.configuration)

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

            # Be sure that all settings are loaded proprely!!
            PyFunceble.factory.Requester = PyFunceble.factory.requester()

            wait_for_stop = (
                bool(PyFunceble.storage.CONFIGURATION.cli_testing.mining) is True
            )
            break_time = datetime.now(timezone.utc) + timedelta(
                seconds=self.MINING_WAIT_TIME
            )

            try:  # pylint: disable=too-many-nested-blocks
                while True:
                    if self.global_exit_event.is_set():
                        PyFunceble.facility.Logger.info(
                            "Got global exit event. Stopping worker."
                        )

                        break

                    if self.exit_it.is_set():
                        PyFunceble.facility.Logger.info("Got exit event. Stopping worker.")
                        break

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

                        if break_now():
                            self.exit_it.set()
                            continue

                        continue

                    try:
                        worker_name, destination_worker, consumed = self.input_queue.get()
                    except (EOFError, KeyboardInterrupt):
                        PyFunceble.facility.Logger.info(
                            "Got EOFError/KeyboardInterrupt. Stopping worker."
                        )
                        self.global_exit_event.set()
                        break

                    if destination_worker and destination_worker != self.name:
                        self.add_to_input_queue(
                            consumed,
                            worker_name=worker_name,
                            destination_worker=destination_worker,
                        )
                        continue

                    PyFunceble.facility.Logger.info(
                        "Got (from %r): %r",
                        worker_name,
                        consumed,
                    )

                    if consumed == "stop":
                        if break_now():
                            PyFunceble.facility.Logger.info(
                                "Got stop message from %r. Applying.",
                                worker_name,
                            )

                            self.exit_it.set()
                            continue

                        self.share_waiting_message(apply_breakoff=wait_for_stop)
                        continue

                    if consumed == "wait":
                        if not wait_for_stop:
                            continue

                        if break_now():
                            PyFunceble.facility.Logger.debug(
                                "Waited sufficiently. Stopping current worker."
                            )

                            # The real (break) action shouldn't be handled here.
                            self.exit_it.set()
                            continue

                        PyFunceble.facility.Logger.debug(
                            "We need to wait a bit more. Continue waiting."
                        )

                        self.share_waiting_message(apply_breakoff=wait_for_stop)
                        continue

                    try:
                        result = self.target(consumed)
                    except (EOFError, KeyboardInterrupt):
                        PyFunceble.facility.Logger.info(
                            "Got EOFError/KeyboardInterrupt. Stopping worker."
                        )
                        self.global_exit_event.set()
                        break

                    if result is not None:
                        self.add_to_output_queue(result)

                        PyFunceble.facility.Logger.info(
                            "Produced: %r",
                            result,
                        )

                    break_time = datetime.now(timezone.utc) + timedelta(
                        seconds=self.MINING_WAIT_TIME
                    )

            except Exception as exception:  # pylint: disable=broad-except
                PyFunceble.facility.Logger.critical(
                    "Error while running target", exc_info=True
                )
                trace = traceback.format_exc()
                self._child_connection.send((exception, trace))

                self.exit_it.set()
                raise exception

        def terminate(self) -> None:
            """
            Terminate our worker.
            """

            self.exit_it.set()

            if self.input_queue:
                # Necessary to avoid blocking.
                self.add_to_input_queue("stop", destination_worker=self.name)

### `exception` `property`

Provides the exception of the current worker.

### `__post_init__()`

A method which will be executed after the :code:`__init__` method.

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

    147
    148
    149
    150

    def __post_init__(self) -> None:
        """
        A method which will be executed after the :code:`__init__` method.
        """

### `add_to_input_queue(data, *, worker_name=None, destination_worker=None)`

Adds the given data to the current queue.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`data` | `Any` | The data to add into the queue. | required
`destination_worker` | `Optional[str]` | The name of the worker which is supposed to read the message. | `None`

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

    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186

    def add_to_input_queue(
        self,
        data: Any,
        *,
        worker_name: Optional[str] = None,
        destination_worker: Optional[str] = None,
    ) -> "WorkerBase":
        """
        Adds the given data to the current queue.

        :param data:
            The data to add into the queue.
        :param destination_worker:
            The name of the worker which is supposed to read the message.
        """

        if worker_name:
            to_send = (worker_name, destination_worker, data)
        else:
            to_send = (self.name, destination_worker, data)

        self.input_queue.put(to_send)

        PyFunceble.facility.Logger.debug("Added to the (input) queue: %r", data)

### `add_to_output_queue(data, *, worker_name=None, destination_worker=None)`

Adds the given data to the output queue queue.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`data` | `Any` | The data to add into the queue. | required

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

    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213

    def add_to_output_queue(
        self,
        data: Any,
        *,
        worker_name: Optional[str] = None,
        destination_worker: Optional[str] = None,
    ) -> "WorkerBase":
        """
        Adds the given data to the output queue queue.

        :param data:
            The data to add into the queue.
        """

        if worker_name:
            to_send = (worker_name, destination_worker, data)
        else:
            to_send = (self.name, destination_worker, data)

        if self.output_queue is not None:
            for output_queue in self.output_queue:
                output_queue.put(to_send)

        PyFunceble.facility.Logger.debug("Added to the (output) queue: %r", data)

        return self

### `share_waiting_message(*, overall=False, ignore_current_worker=False, apply_breakoff=False)`

Shares a waiting message to both input and output queues. The idea is to keep our worker awake when necessary. This functionality is really important when running the mining worker because sometime the flow is so long, that we may need some time.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`overall` | `bool` | Shares the message multiple time to specific destination in our current stack. | `False`
`ignore_current_worker` | `bool` | Doesn't share the message with ourself. | `False`
`apply_breakoff` | `bool` | Activates the breakoff (sleep) before starting to share the message. | `False`

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

    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263

    def share_waiting_message(
        self,
        *,
        overall: bool = False,
        ignore_current_worker: bool = False,
        apply_breakoff: bool = False,
    ) -> "WorkerBase":
        """
        Shares a waiting message to both input and output queues.
        The idea is to keep our worker awake when necessary. This functionality
        is really important when running the mining worker because sometime
        the flow is so long, that we may need some time.

        :param overall:
            Shares the message multiple time to specific destination in our
            current stack.
        :param ignore_current_worker:
            Doesn't share the message with ourself.
        :param apply_breakoff:
            Activates the breakoff (sleep) before starting to share the message.
        """

        if overall:
            for worker_name in self.concurrent_worker_names:
                if apply_breakoff:
                    time.sleep(self.BREAKOFF)

                if not ignore_current_worker:
                    # Give the whole stack a bit more of time.
                    self.add_to_input_queue("wait", destination_worker=worker_name)

                self.add_to_output_queue("wait")
        else:
            if apply_breakoff:
                time.sleep(self.BREAKOFF)

            if not ignore_current_worker:
                self.add_to_input_queue("wait", destination_worker=self.name)

            self.add_to_output_queue("wait")

### `target(consumed)`

This the target that is run to process something. This method should return a result which will pu send to the output queue.

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

    215
    216
    217
    218
    219
    220
    221
    222

    def target(self, consumed: Any) -> Optional[Tuple[Any, ...]]:
        """
        This the target that is run to process something.
        This method should return a result which will pu send to the output
        queue.
        """

        raise NotImplementedError()

### `terminate()`

Terminate our worker.

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

    408
    409
    410
    411
    412
    413
    414
    415
    416
    417

    def terminate(self) -> None:
        """
        Terminate our worker.
        """

        self.exit_it.set()

        if self.input_queue:
            # Necessary to avoid blocking.
            self.add_to_input_queue("stop", destination_worker=self.name)