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
90 lines
2.6 KiB
Python
90 lines
2.6 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: router.py
|
|
@date: 01.03.2019
|
|
@author: Bastian Schroll
|
|
@description: Class for the BOSWatch packet router
|
|
"""
|
|
import logging
|
|
import copy
|
|
import time
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class Router:
|
|
r"""!Class for the Router"""
|
|
def __init__(self, name):
|
|
r"""!Create a new router
|
|
|
|
@param name: name of the router"""
|
|
self.name = name
|
|
self.routeList = []
|
|
|
|
# for time counting
|
|
self._cumTime = 0
|
|
self._routerTime = 0
|
|
|
|
# for statistics
|
|
self._runCount = 0
|
|
|
|
logging.debug("[%s] add new router", self.name)
|
|
|
|
def addRoute(self, route):
|
|
r"""!Adds a route point to the router
|
|
|
|
@param route: instance of the Route class
|
|
"""
|
|
logging.debug("[%s] add route: %s", self.name, route.name)
|
|
self.routeList.append(route)
|
|
|
|
def runRouter(self, bwPacket):
|
|
r"""!Run the router
|
|
|
|
@param bwPacket: instance of Packet class
|
|
@return a instance of Packet class
|
|
"""
|
|
self._runCount += 1
|
|
tmpTime = time.time()
|
|
|
|
logging.debug("[%s] started", self.name)
|
|
|
|
for routeObject in self.routeList:
|
|
logging.debug("[%s] -> run route: %s", self.name, routeObject.name)
|
|
bwPacket_tmp = routeObject.callback(copy.deepcopy(bwPacket)) # copy bwPacket to prevent edit the original
|
|
|
|
if bwPacket_tmp is None: # returning None doesnt change the bwPacket
|
|
continue
|
|
|
|
if bwPacket_tmp is False: # returning False stops the router immediately
|
|
logging.debug("[%s] stopped", self.name)
|
|
break
|
|
|
|
bwPacket = bwPacket_tmp
|
|
logging.debug("[%s] bwPacket returned", self.name)
|
|
logging.debug("[%s] finished", self.name)
|
|
|
|
self._routerTime = time.time() - tmpTime
|
|
self._cumTime += self._routerTime
|
|
|
|
return bwPacket
|
|
|
|
def _getStatistics(self):
|
|
r"""!Returns statistical information's from last router run
|
|
|
|
@return Statistics as pyton dict"""
|
|
stats = {"type": "router",
|
|
"runCount": self._runCount,
|
|
"cumTime": self._cumTime,
|
|
"moduleTime": self._routerTime}
|
|
return stats
|