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
81 lines
2 KiB
Python
81 lines
2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: template_plugin.py
|
|
@date: 14.01.2018
|
|
@author: Bastian Schroll
|
|
@description: Template Plugin File
|
|
"""
|
|
import logging
|
|
from plugin.pluginBase import PluginBase
|
|
|
|
# ###################### #
|
|
# Custom plugin includes #
|
|
|
|
# ###################### #
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class BoswatchPlugin(PluginBase):
|
|
r"""!Description of the Plugin"""
|
|
def __init__(self, config):
|
|
r"""!Do not change anything here!"""
|
|
super().__init__(__name__, config) # you can access the config class on 'self.config'
|
|
|
|
def onLoad(self):
|
|
r"""!Called by import of the plugin
|
|
Remove if not implemented"""
|
|
pass
|
|
|
|
def setup(self):
|
|
r"""!Called before alarm
|
|
Remove if not implemented"""
|
|
pass
|
|
|
|
def fms(self, bwPacket):
|
|
r"""!Called on FMS alarm
|
|
|
|
@param bwPacket: bwPacket instance
|
|
Remove if not implemented"""
|
|
pass
|
|
|
|
def pocsag(self, bwPacket):
|
|
r"""!Called on POCSAG alarm
|
|
|
|
@param bwPacket: bwPacket instance
|
|
Remove if not implemented"""
|
|
pass
|
|
|
|
def zvei(self, bwPacket):
|
|
r"""!Called on ZVEI alarm
|
|
|
|
@param bwPacket: bwPacket instance
|
|
Remove if not implemented"""
|
|
pass
|
|
|
|
def msg(self, bwPacket):
|
|
r"""!Called on MSG packet
|
|
|
|
@param bwPacket: bwPacket instance
|
|
Remove if not implemented"""
|
|
pass
|
|
|
|
def teardown(self):
|
|
r"""!Called after alarm
|
|
Remove if not implemented"""
|
|
pass
|
|
|
|
def onUnload(self):
|
|
r"""!Called by destruction of the plugin
|
|
Remove if not implemented"""
|
|
pass
|