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
65 lines
1.9 KiB
Python
65 lines
1.9 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: zvei.py
|
|
@date: 05.01.2018
|
|
@author: Bastian Schroll
|
|
@description: Decoder class for zvei
|
|
"""
|
|
|
|
import logging
|
|
import re
|
|
|
|
from boswatch.packet import Packet
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class ZveiDecoder:
|
|
r"""!ZVEI decoder class
|
|
|
|
This class decodes ZVEI data.
|
|
First step is to validate the data and _check if the format is correct.
|
|
After that the double-tone-sign 'E' is replaced.
|
|
In the last step a valid BOSWatch packet is created and returned"""
|
|
|
|
@staticmethod
|
|
def decode(data):
|
|
r"""!Decodes ZVEI
|
|
|
|
@param data: ZVEI for decoding
|
|
@return BOSWatch ZVEI packet or None"""
|
|
if re.search("[0-9E]{5}", data[7:12]):
|
|
logging.debug("found valid ZVEI")
|
|
|
|
bwPacket = Packet()
|
|
bwPacket.set("mode", "zvei")
|
|
bwPacket.set("tone", ZveiDecoder._solveDoubleTone(data[7:12]))
|
|
|
|
return bwPacket
|
|
|
|
logging.warning("no valid ZVEI")
|
|
return None
|
|
|
|
@staticmethod
|
|
def _solveDoubleTone(data):
|
|
r"""!Remove the doubleTone sign (here its the 'E')
|
|
|
|
@param data: ZVEI for double tone sign replacement
|
|
@return Double Tone replaced ZVEI"""
|
|
if "E" in data:
|
|
data_old = data
|
|
for i in range(1, len(data)):
|
|
if data[i] == "E":
|
|
data = data.replace("E", data[i - 1], 1)
|
|
logging.debug("solve doubleTone: %s -> %s", data_old, data)
|
|
return data
|