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
66 lines
2.1 KiB
Python
66 lines
2.1 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: packet.py
|
|
@date: 06.01.2018
|
|
@author: Bastian Schroll
|
|
@description: Class for a BOSWatch data packet
|
|
"""
|
|
import logging
|
|
import time
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class Packet:
|
|
r"""!Class implementation of an BOSWatch packet"""
|
|
|
|
def __init__(self, bwPacket=None):
|
|
r"""!Build a new BOSWatch packet or copy existing data in it
|
|
|
|
@param bwPacket: Existing data to copy"""
|
|
if bwPacket is None:
|
|
logging.debug("create new bwPacket")
|
|
self._packet = {"timestamp": time.time()}
|
|
else:
|
|
logging.debug("create bwPacket from string")
|
|
self._packet = eval(str(bwPacket.strip()))
|
|
|
|
def __str__(self):
|
|
r"""!Return the intern _packet dict as string"""
|
|
return str(self._packet)
|
|
|
|
def set(self, fieldName, value):
|
|
r"""!Set a field in the intern _packet dict
|
|
|
|
@param fieldName: Name of the data to set
|
|
@param value: Value to set"""
|
|
self._packet[fieldName] = str(value)
|
|
|
|
def get(self, fieldName):
|
|
r"""!Returns the value from a single field.
|
|
If field not existing `None` is returned
|
|
|
|
@param fieldName: Name of the field
|
|
@return Value or None"""
|
|
try:
|
|
return str(self._packet[fieldName])
|
|
except:
|
|
logging.warning("field not found: %s", fieldName)
|
|
return None
|
|
|
|
def printInfo(self):
|
|
r"""!Print a info message to the log on INFO level.
|
|
Contains the most useful info about this packet.
|
|
@todo not complete yet - must be edit to print nice formatted messages on console
|
|
"""
|
|
logging.info("[%s]", self.get("mode"))
|