timed_function.py

''' Decorator to time a function and log the result using the `log.Log` class (if available)

    Copyright (c) 2025 Harm Lammers
    
    This as an adaptation of a `timed_function` function recommended in https://docs.micropython.org/en/latest/reference/speed_python.html,
    copyright (c) 2014-2025, MicroPython authors and contributors, published under MIT licence

    MIT licence:

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to
    the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
'''

import time

try:
    from log import Log # pyright: ignore[reportMissingImports, reportAssignmentType]
except:
    class Log:
        ''' Minimalist logger for if the log module is not avaialble '''

        def write(self, msg: str|bytes|bytearray) -> None:
            ''' Print message '''
            print(msg if type(msg) == str else msg.decode('ascii')) # pyright: ignore[reportAttributeAccessIssue]

avg_time = 0
avg_count = 0

def timed_function(f, *args, **kwargs):
    ''' Decorator function to time a function and log the result using the `log.Log` class (if available); gives the average of each time
    the function was called
    '''
    words = str(f).split()
    myname = 'viper func' if len(words) == 1 else words[1]
    # myname = str(f) # .split(' ')[1] # `split(' ')[1]` doesn’t work for viper functions
    def new_func(*args, **kwargs):
        global avg_time, avg_count
        t = time.ticks_us()
        result = f(*args, **kwargs)
        delta = time.ticks_diff(time.ticks_us(), t)
        avg_time += (delta - avg_time) / (avg_count + 1)
        avg_count += 1
        _log = Log()
        _log.write(f'{myname}: avg {avg_time} us')
        return result
    return new_func