BW3-Core/boswatch/decoder/fmsDecoder.py
Luflosi d4dcc75711
Avoid "DeprecationWarning: invalid escape sequence"
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
2023-09-19 17:49:09 +02:00

71 lines
2.2 KiB
Python

#!/usr/bin/python
# -*- coding: utf-8 -*-
r"""!
____ ____ ______ __ __ __ _____
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
German BOS Information Script
by Bastian Schroll
@file: fms.py
@date: 06.01.2018
@author: Bastian Schroll
@description: Decoder class for fms
"""
import logging
import re
from boswatch.packet import Packet
logging.debug("- %s loaded", __name__)
class FmsDecoder:
r"""!FMS decoder class
This class decodes FMS data.
First step is to validate the data and _check if the format is correct.
In the last step a valid BOSWatch packet is created and returned"""
@staticmethod
def decode(data):
r"""!Decodes FMS
@param data: FMS for decoding
@return BOSWatch FMS packet or None"""
if "CRC correct" in data:
service = data[19]
country = data[36]
location = data[61:63]
vehicle = data[72:76]
status = data[84]
direction = data[101]
directionText = data[103:110]
tacticalInfo = data[114:117]
fms_id = service + country + location + vehicle + status + direction
if re.search("[0-9a-f]{8}[0-9a-f][01]", fms_id):
logging.debug("found valid FMS")
bwPacket = Packet()
bwPacket.set("mode", "fms")
bwPacket.set("fms", fms_id)
bwPacket.set("service", service)
bwPacket.set("country", country)
bwPacket.set("location", location)
bwPacket.set("vehicle", vehicle)
bwPacket.set("status", status)
bwPacket.set("direction", direction)
bwPacket.set("directionText", directionText)
bwPacket.set("tacticalInfo", tacticalInfo)
return bwPacket
logging.warning("no valid FMS")
return None
logging.warning("CRC Error")
return None