mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2025-12-06 07:12:04 +01:00
d4dcc75711
Without this change, many warnings like this will be generated while running pytest:
```
test/test_template.py:3
/build/source/test/test_template.py:3: DeprecationWarning: invalid escape sequence '\/'
"""!
```
This can also be seen when manually running python with warnings enabled.
This happens because the comment uses a multiline string and Python interprets the backslash in the logo as an escape character and complains that \/ is not a valid escape sequence. To fix this, prepend the string with the letter r to indicate that the backslash should be treated as a literal character, see https://docs.python.org/3/reference/lexical_analysis.html#index-20.
I also applied this change to all the comment strings since that shouldn't break anything and to establish it as a pattern for the future so this problem hopefully never happens again.
This is what I did specifically:
- Change the comment at the top of bw_client.py and bw_server.py to start with `"""!` since that seems to be the pattern here
- Search-and-Replace all occurances of `"""!` with `r"""!`
- Manually change the strings in `logoToLog()` in boswatch/utils/header.py
108 lines
3.8 KiB
Python
108 lines
3.8 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: timer.py
|
|
@date: 21.09.2018
|
|
@author: Bastian Schroll
|
|
@description: Timer class for interval timed events
|
|
"""
|
|
import logging
|
|
import time
|
|
from threading import Thread, Event
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class RepeatedTimer:
|
|
|
|
def __init__(self, interval, targetFunction, *args, **kwargs):
|
|
r"""!Create a new instance of the RepeatedTimer
|
|
|
|
@param interval: interval in sec. to recall target function
|
|
@param targetFunction: function to call on timer event
|
|
@param *args: arguments for the called function
|
|
@param *kwargs: keyword arguments for the called function
|
|
"""
|
|
self._interval = interval
|
|
self._function = targetFunction
|
|
self._args = args
|
|
self._kwargs = kwargs
|
|
self._start = 0
|
|
self.overdueCount = 0
|
|
self.lostEvents = 0
|
|
self._isRunning = False
|
|
self._event = Event()
|
|
self._thread = None
|
|
|
|
def start(self):
|
|
r"""!Start a new timer worker thread
|
|
|
|
@return True or False"""
|
|
if self._thread is None:
|
|
self._event.clear()
|
|
self._thread = Thread(target=self._target)
|
|
self._thread.name = "RepTim(" + str(self._interval) + ")"
|
|
self._thread.daemon = True # start as daemon (thread dies if main program ends)
|
|
self._thread.start()
|
|
logging.debug("start repeatedTimer: %s", self._thread.name)
|
|
return True
|
|
logging.debug("repeatedTimer always started")
|
|
return True
|
|
|
|
def stop(self):
|
|
r"""!Stop the timer worker thread
|
|
|
|
@return True or False"""
|
|
if self._thread is not None:
|
|
logging.debug("stop repeatedTimer: %s", self._thread.name)
|
|
self._event.set()
|
|
if self._thread is not None:
|
|
self._thread.join()
|
|
return True
|
|
logging.warning("repeatedTimer always stopped")
|
|
return True
|
|
|
|
def _target(self):
|
|
r"""!Runs the target function with his arguments in own thread"""
|
|
self._start = time.time()
|
|
while not self._event.wait(self.restTime):
|
|
logging.debug("work")
|
|
startTime = time.time()
|
|
|
|
try:
|
|
self._function(*self._args, **self._kwargs)
|
|
except: # pragma: no cover
|
|
logging.exception("target throws an exception")
|
|
|
|
runTime = time.time() - startTime
|
|
if runTime < self._interval:
|
|
logging.debug("ready after: %0.3f sec. - next call in: %0.3f sec.", runTime, self.restTime)
|
|
else:
|
|
lostEvents = int(runTime / self._interval)
|
|
logging.warning("timer overdue! interval: %0.3f sec. - runtime: %0.3f sec. - "
|
|
"%d events lost - next call in: %0.3f sec.", self._interval, runTime, lostEvents, self.restTime)
|
|
self.lostEvents += lostEvents
|
|
self.overdueCount += 1
|
|
logging.debug("repeatedTimer thread stopped: %s", self._thread.name)
|
|
self._thread = None # set to none after leave teh thread (running recognize)
|
|
|
|
@property
|
|
def isRunning(self):
|
|
r"""!Property for repeatedTimer running state"""
|
|
if self._thread:
|
|
return True
|
|
return False
|
|
|
|
@property
|
|
def restTime(self):
|
|
r"""!Property to get remaining time till next call"""
|
|
return self._interval - ((time.time() - self._start) % self._interval)
|