Source code for PyFunceble.cli.execution_time

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

::


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

Provides the execution time logic.

Author:
    Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks:
    https://pyfunceble.github.io/special-thanks.html

Contributors:
    https://pyfunceble.github.io/contributors.html

Project link:
    https://github.com/funilrys/PyFunceble

Project documentation:
    https://pyfunceble.readthedocs.io/en/master/

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

License:
::


    Copyright 2017, 2018, 2019, 2020 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.
"""

from collections import OrderedDict
from datetime import datetime

from colorama import Fore, Style

import PyFunceble


[docs]class ExecutionTime: # pylint: disable=too-few-public-methods """ Sets and returns the execution time of the program. :param str action: The action related the execution time. Can be `start` or `stop`. :param bool last: Tell the subsystem if we are at the very end of the file testing. """ authorized = False def __init__(self, action="start", last=False): self.authorized = self.authorization() # We parse the action to the class scope. self.action = action if self.action == "start": # The action is equal to `start`. # We set the starting time. self.set_starting_time() elif self.action == "stop": # * The action is not equal to `start`. # and # * The action is equal to `stop` # We set the ending time. self.set_stoping_time() if self.authorized and self.action == "stop": # * We are authorized to operate. # and # * The given action is stop. formatted_time = self.format_execution_time() # We print the execution time. print(Fore.MAGENTA + Style.BRIGHT + "\nExecution time: " + formatted_time) percentage_output = ( PyFunceble.OUTPUT_DIRECTORY + PyFunceble.OUTPUTS.parent_directory + PyFunceble.OUTPUTS.logs.directories.parent + PyFunceble.OUTPUTS.logs.directories.percentage + PyFunceble.OUTPUTS.logs.filenames.percentage ) file_instance = PyFunceble.helpers.File(percentage_output) if PyFunceble.CONFIGURATION.show_percentage and file_instance.exists(): file_instance.write( "\nExecution time: {0}".format(formatted_time), overwrite=False ) self.save(last=last)
[docs] @classmethod def authorization(cls): """ Checks the execution authorization. :return: The authorization status. :rtype: bool """ if PyFunceble.CONFIGURATION.show_execution_time or PyFunceble.CONFIGURATION.ci: return True return False
[docs] def save(self, last=False): """ Saves the current time to our backup file. :param bool last: Tell us if we are at the very end of the file testing. """ if ( self.authorized and PyFunceble.CONFIGURATION.logs and "file_to_test" in PyFunceble.INTERN and PyFunceble.INTERN["file_to_test"] ): # * We are authorized to work. # and # * The generation of logs is activated. # and # * We are not testing as an imported module. # We set the location of the file we are working with. self.file = ( PyFunceble.OUTPUT_DIRECTORY + PyFunceble.OUTPUTS.parent_directory + PyFunceble.OUTPUTS.logs.directories.parent + PyFunceble.OUTPUTS.logs.filenames.execution_time ) if PyFunceble.helpers.File(self.file).exists(): # The file we are working with exist. # We get its content so we can directly work with it. content = PyFunceble.helpers.Dict().from_json_file(self.file) else: # The file we are working with does not exist. # We generate a dummy content. content = {} if self.action == "start": # The action is equal to `start`. if "final_total" in content and content["final_total"]: # The final total index exist. # We delete it. del content["final_total"] if "data" in content: # The data index exist. # We append the current start time inside it at # a new sublist. content["data"].append([PyFunceble.INTERN["start"]]) else: # The data index does not exist. # We create the index along with the current start time. content["data"] = [[PyFunceble.INTERN["start"]]] elif self.action == "stop": # The action is equal to `stop`. try: # We try to work with the data index. # We append the end time at the end of the last element # of data. # # Note: It is at the end because we should have as first # the star time. content["data"][-1].append(PyFunceble.INTERN["end"]) # We get the start time. start = content["data"][0][0] # We get the end time. end = content["data"][-1][-1] # We calculate the execution time of the test. content["current_total"] = self.format_execution_time(start, end) if last: # We are at the very end of the file testing. # We initiate the global execution time. content["final_total"] = content["current_total"] # We inform the user about the global execution time. print( Fore.MAGENTA + Style.BRIGHT + "Global execution time: " + content["final_total"] ) except KeyError: # pragma: no cover # It is not possible to work with the data index because # it does not exist. # We ignore the problem. pass # We try to save the whole data at its final location. PyFunceble.helpers.Dict(content).to_json_file(self.file)
[docs] @classmethod def set_starting_time(cls): # pragma: no cover """ Sets the starting time. """ # We set the starting time as the current time. PyFunceble.INTERN["start"] = datetime.utcnow().timestamp() PyFunceble.LOGGER.debug( f'Starting time: {PyFunceble.INTERN["start"]} ' f'| {datetime.fromtimestamp(PyFunceble.INTERN["start"])}' )
[docs] @classmethod def set_stoping_time(cls): # pragma: no cover """ Sets the ending time. """ # We set the ending time as the current time. PyFunceble.INTERN["end"] = datetime.utcnow().timestamp() PyFunceble.LOGGER.debug( f'Stoping time: {PyFunceble.INTERN["start"]} ' f'| { datetime.fromtimestamp(PyFunceble.INTERN["end"])}' )
[docs] @classmethod def calculate(cls, start=None, end=None): """ Calculates the difference between starting and ending time. :param start: A starting time. :type start: int, str :param stop: A ending time. :type stop: int, str :return: A dict with following as index. * :code:`days` * :code:`hours` * :code:`minutes` * :code:`seconds` as index. :rtype: dict """ if start and end: # The start and end time is explicitly given. # We get the difference between the ending and the starting time. time_difference = float(end) - float(start) else: # The start and end time is not explicitly given. # We get the difference between the ending and the starting time. time_difference = float(PyFunceble.INTERN["end"]) - float( PyFunceble.INTERN["start"] ) # We initiate an OrderedDict. # Indeed, we use an ordered dict because we want the structuration and the # order to stay always the same. # As a dictionnary is always unordered, we can use it. Otherwise the time will # not be shown correctly. data = OrderedDict() # We calculate and append the day to our data. data["days"] = str(int(time_difference // (24 * 60 * 60))).zfill(2) # We calculate and append the hours to our data. data["hours"] = str(int((time_difference // (60 * 60)) % 24)).zfill(2) # We calculate and append the minutes to our data. data["minutes"] = str(int((time_difference % 3600) // 60)).zfill(2) # We calculate and append the minutes to our data. data["seconds"] = str(round(time_difference % 60, 6)).zfill(2) # We finaly return our data. return data
[docs] def format_execution_time(self, start=None, end=None): """ Formats the calculated time into a human readable format. :param start: A starting time. :type start: int, str :param stop: A ending time. :type stop: int, str :return: A human readable date. :rtype: str """ # We return the formatted execution time. return ":".join(list(self.calculate(start, end).values()))