Skip to content

# Execution time

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

::

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

Provides the interface for the generation of the execution time.

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.

## `ExecutionTime`

Provides the interface for the execution time.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`authorized` | `Optional[bool]` | The authorization to run. | `None`

Source code in `PyFunceble/cli/execution_time.py`

     63
     64
     65
     66
     67
     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

    class ExecutionTime:
        """
        Provides the interface for the execution time.

        :param authorized:
            The authorization to run.
        """

        STD_AUTHORIZED: bool = False

        _authorized: bool = False

        start_time: Optional[datetime.datetime] = None
        end_time: Optional[datetime.datetime] = None

        def __init__(
            self,
            authorized: Optional[bool] = None,
        ) -> None:
            if authorized is not None:
                self.authorized = authorized
            else:
                self.guess_and_set_authorized()

        def execute_if_authorized(default: Any = None):  # pylint: disable=no-self-argument
            """
            Executes the decorated method only if we are authorized to process.
            Otherwise, apply the given :code:`default`.
            """

            def inner_method(func):
                @functools.wraps(func)
                def wrapper(self, *args, **kwargs):
                    if self.authorized:
                        return func(self, *args, **kwargs)  # pylint: disable=not-callable
                    return self if default is None else default

                return wrapper

            return inner_method

        @staticmethod
        def split_difference(start: datetime.datetime, end: datetime.datetime) -> dict:
            """
            Calculates the difference between the two datetime object.

            :param start:
                The starting time.

            :param end:
                The ending time.

            :raise TypeError:
                When the given :code:`start` or :code:`end` is not a
                :py:class:`datetime.datetime`.
            """

            if not isinstance(start, datetime.datetime):
                raise TypeError(
                    f"<start> should be {datetime.datetime}, {type(start)} given."
                )

            if not isinstance(end, datetime.datetime):
                raise TypeError(
                    f"<start> should be {datetime.datetime}, {type(start)} given."
                )

            difference = end.timestamp() - start.timestamp()

            result = {}

            result["days"] = difference // (24 * 60 * 60)
            result["hours"] = (difference // (60 * 60)) % 24
            result["minutes"] = (difference % 3600) // 60
            result["seconds"] = difference % 60

            return result

        @property
        def authorized(self) -> Optional[bool]:
            """
            Provides the currently state of the :code:`_authorized` attribute.
            """

            return self._authorized

        @authorized.setter
        def authorized(self, value: bool) -> None:
            """
            Sets the value of the :code:`authorized` attribute.

            :param value:
                The value to set.

            :raise TypeError:
                When the given :code:`value` is not a :py:class:`bool`
            """

            if not isinstance(value, bool):
                raise TypeError(f"<value> should be {bool}, {type(value)} given.")

            self._authorized = value

        def set_authorized(self, value: bool) -> "ExecutionTime":
            """
            Sets the value of the :code:`authorized` attribute.

            :param value:
                The value to set.
            """

            self.authorized = value

            return self

        @execute_if_authorized(None)
        def set_start_time(self) -> "ExecutionTime":
            """
            Sets the starting time to now.
            """

            self.start_time = datetime.datetime.now(datetime.timezone.utc)

            return self

        @execute_if_authorized(None)
        def set_end_time(self) -> "ExecutionTime":
            """
            Sets the starting time to now.
            """

            self.end_time = datetime.datetime.now(datetime.timezone.utc)

            return self

        def guess_and_set_authorized(self) -> "ExecutionTime":
            """
            Try to guess and set the authorization from the configuration file.
            """

            if PyFunceble.facility.ConfigLoader.is_already_loaded():
                self.authorized = bool(
                    PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.execution_time
                )
            else:
                self.authorized = self.STD_AUTHORIZED

        @execute_if_authorized(None)
        def get_info(self) -> dict:
            """
            Provides the information to work with.
            """

            if not self.end_time:
                self.set_end_time()

            result = self.split_difference(self.start_time, self.end_time)

            result["days"] = str(int(result["days"])).zfill(2)
            result["hours"] = str(int(result["hours"])).zfill(2)
            result["minutes"] = str(int(result["minutes"])).zfill(2)
            result["seconds"] = str(round(result["seconds"], 6)).zfill(2)

            return result

### `authorized` `property` `writable`

Provides the currently state of the :code:`_authorized` attribute.

### `execute_if_authorized(default=None)`

Executes the decorated method only if we are authorized to process. Otherwise, apply the given :code:`default`.

Source code in `PyFunceble/cli/execution_time.py`

     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102

    def execute_if_authorized(default: Any = None):  # pylint: disable=no-self-argument
        """
        Executes the decorated method only if we are authorized to process.
        Otherwise, apply the given :code:`default`.
        """

        def inner_method(func):
            @functools.wraps(func)
            def wrapper(self, *args, **kwargs):
                if self.authorized:
                    return func(self, *args, **kwargs)  # pylint: disable=not-callable
                return self if default is None else default

            return wrapper

        return inner_method

### `get_info()`

Provides the information to work with.

Source code in `PyFunceble/cli/execution_time.py`

    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226

    @execute_if_authorized(None)
    def get_info(self) -> dict:
        """
        Provides the information to work with.
        """

        if not self.end_time:
            self.set_end_time()

        result = self.split_difference(self.start_time, self.end_time)

        result["days"] = str(int(result["days"])).zfill(2)
        result["hours"] = str(int(result["hours"])).zfill(2)
        result["minutes"] = str(int(result["minutes"])).zfill(2)
        result["seconds"] = str(round(result["seconds"], 6)).zfill(2)

        return result

### `guess_and_set_authorized()`

Try to guess and set the authorization from the configuration file.

Source code in `PyFunceble/cli/execution_time.py`

    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208

    def guess_and_set_authorized(self) -> "ExecutionTime":
        """
        Try to guess and set the authorization from the configuration file.
        """

        if PyFunceble.facility.ConfigLoader.is_already_loaded():
            self.authorized = bool(
                PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.execution_time
            )
        else:
            self.authorized = self.STD_AUTHORIZED

### `set_authorized(value)`

Sets the value of the :code:`authorized` attribute.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `bool` | The value to set. | required

Source code in `PyFunceble/cli/execution_time.py`

    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176

    def set_authorized(self, value: bool) -> "ExecutionTime":
        """
        Sets the value of the :code:`authorized` attribute.

        :param value:
            The value to set.
        """

        self.authorized = value

        return self

### `set_end_time()`

Sets the starting time to now.

Source code in `PyFunceble/cli/execution_time.py`

    188
    189
    190
    191
    192
    193
    194
    195
    196

    @execute_if_authorized(None)
    def set_end_time(self) -> "ExecutionTime":
        """
        Sets the starting time to now.
        """

        self.end_time = datetime.datetime.now(datetime.timezone.utc)

        return self

### `set_start_time()`

Sets the starting time to now.

Source code in `PyFunceble/cli/execution_time.py`

    178
    179
    180
    181
    182
    183
    184
    185
    186

    @execute_if_authorized(None)
    def set_start_time(self) -> "ExecutionTime":
        """
        Sets the starting time to now.
        """

        self.start_time = datetime.datetime.now(datetime.timezone.utc)

        return self

### `split_difference(start, end)` `staticmethod`

Calculates the difference between the two datetime object.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`start` | `datetime` | The starting time. | required
`end` | `datetime` | The ending time. | required

Raises:

Type | Description
--- | ---
`TypeError` | When the given :code:`start` or :code:`end` is not a class:`datetime.datetime`.

Source code in `PyFunceble/cli/execution_time.py`

    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

    @staticmethod
    def split_difference(start: datetime.datetime, end: datetime.datetime) -> dict:
        """
        Calculates the difference between the two datetime object.

        :param start:
            The starting time.

        :param end:
            The ending time.

        :raise TypeError:
            When the given :code:`start` or :code:`end` is not a
            :py:class:`datetime.datetime`.
        """

        if not isinstance(start, datetime.datetime):
            raise TypeError(
                f"<start> should be {datetime.datetime}, {type(start)} given."
            )

        if not isinstance(end, datetime.datetime):
            raise TypeError(
                f"<start> should be {datetime.datetime}, {type(start)} given."
            )

        difference = end.timestamp() - start.timestamp()

        result = {}

        result["days"] = difference // (24 * 60 * 60)
        result["hours"] = (difference // (60 * 60)) % 24
        result["minutes"] = (difference % 3600) // 60
        result["seconds"] = difference % 60

        return result