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
37 lines
1.2 KiB
Python
37 lines
1.2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: route.py
|
|
@date: 04.03.2019
|
|
@author: Bastian Schroll
|
|
@description: Class for a single BOSWatch packet router route point
|
|
"""
|
|
|
|
import logging
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class Route:
|
|
r"""!Class for single routing points"""
|
|
def __init__(self, name, callback, statsCallback=None, cleanupCallback=None):
|
|
r"""!Create a instance of an route point
|
|
|
|
@param name: name of the route point
|
|
@param callback: instance of the callback function
|
|
@param statsCallback: instance of the callback to get statistics (None)
|
|
@param cleanupCallback: instance of the callback to run a cleanup method (None)
|
|
"""
|
|
self.name = name
|
|
self.callback = callback
|
|
self.statistics = statsCallback
|
|
self.cleanup = cleanupCallback
|