BW3-Core/boswatch/decoder/decoder.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
r"""!
    ____  ____  ______       __      __       __       _____
   / __ )/ __ \/ ___/ |     / /___ _/ /______/ /_     |__  /
  / __  / / / /\__ \| | /| / / __ `/ __/ ___/ __ \     /_ <
 / /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / /   ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/   /____/
                German BOS Information Script
                     by Bastian Schroll

@file:        decoder.py
@date:        06.01.2018
@author:      Bastian Schroll
@description: Some utils for the decoding
"""
import logging

from boswatch.decoder.fmsDecoder import FmsDecoder
from boswatch.decoder.pocsagDecoder import PocsagDecoder
from boswatch.decoder.zveiDecoder import ZveiDecoder

logging.debug("- %s loaded", __name__)


class Decoder:

    @staticmethod
    def decode(data):
        r"""!Choose the right decoder and return a bwPacket instance

        @param data: data to decode
        @return bwPacket instance"""
        data = str(data)
        if "FMS" in data:
            return FmsDecoder.decode(data)
        elif "POCSAG" in data:
            return PocsagDecoder.decode(data)
        elif "ZVEI" in data:
            return ZveiDecoder.decode(data)
        else:
            logging.warning("no decoder found for: %s", data)
            return None
add decoders and tests 2018-01-07 14:09:40 +01:00			`#!/usr/bin/python`
			`# -- coding: utf-8 --`
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 16:13:23 +02:00			`r"""!`
add decoders and tests 2018-01-07 14:09:40 +01:00			`____ ____ ______ __ __ __ _____`
			`/ __ )/ __ \/ ___/ \| / /___ _/ /______/ /_ \|__ /`
			/ __ / / / /\__ \\| \| /\| / / __ `/ __/ ___/ __ \ /_ <
			`/ /_/ / /_/ /___/ /\| \|/ \|/ / /_/ / /_/ /__/ / / / ___/ /`
			`/_____/\____//____/ \|__/\|__/\__,_/\__/\___/_/ /_/ /____/`
			`German BOS Information Script`
			`by Bastian Schroll`

			`@file: decoder.py`
			`@date: 06.01.2018`
			`@author: Bastian Schroll`
			`@description: Some utils for the decoding`
			`"""`
			`import logging`

rename Decoder 2019-09-20 18:27:20 +02:00			`from boswatch.decoder.fmsDecoder import FmsDecoder`
			`from boswatch.decoder.pocsagDecoder import PocsagDecoder`
			`from boswatch.decoder.zveiDecoder import ZveiDecoder`
add decoders and tests 2018-01-07 14:09:40 +01:00
			`logging.debug("- %s loaded", __name__)`


make decoder classes <<static>> 2018-09-09 16:34:44 +02:00			`class Decoder:`
add decoders and tests 2018-01-07 14:09:40 +01:00
make decoder classes <<static>> 2018-09-09 16:34:44 +02:00			`@staticmethod`
			`def decode(data):`
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 16:13:23 +02:00			`r"""!Choose the right decoder and return a bwPacket instance`
make decoder classes <<static>> 2018-09-09 16:34:44 +02:00
			`@param data: data to decode`
			`@return bwPacket instance"""`
fix decoder 2019-09-20 17:38:33 +02:00			`data = str(data)`
make decoder classes <<static>> 2018-09-09 16:34:44 +02:00			`if "FMS" in data:`
			`return FmsDecoder.decode(data)`
			`elif "POCSAG" in data:`
			`return PocsagDecoder.decode(data)`
			`elif "ZVEI" in data:`
			`return ZveiDecoder.decode(data)`
			`else:`
improve bw_client input thread 2019-10-10 19:34:03 +02:00			`logging.warning("no decoder found for: %s", data)`
make decoder classes <<static>> 2018-09-09 16:34:44 +02:00			`return None`