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
59 lines
2.2 KiB
Python
59 lines
2.2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: descriptor.py
|
|
@date: 27.10.2019
|
|
@author: Bastian Schroll
|
|
@description: Module to add descriptions to bwPackets
|
|
"""
|
|
import logging
|
|
from module.moduleBase import ModuleBase
|
|
|
|
# ###################### #
|
|
# Custom plugin includes #
|
|
|
|
# ###################### #
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class BoswatchModule(ModuleBase):
|
|
r"""!Adds descriptions to bwPackets"""
|
|
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"""
|
|
for descriptor in self.config:
|
|
if descriptor.get("wildcard", default=None):
|
|
self.registerWildcard(descriptor.get("wildcard"), descriptor.get("descrField"))
|
|
|
|
def doWork(self, bwPacket):
|
|
r"""!start an run of the module.
|
|
|
|
@param bwPacket: A BOSWatch packet instance"""
|
|
for descriptor in self.config:
|
|
if not bwPacket.get(descriptor.get("scanField")):
|
|
break # scanField is not available in this packet
|
|
bwPacket.set(descriptor.get("descrField"), bwPacket.get(descriptor.get("scanField")))
|
|
for description in descriptor.get("descriptions"):
|
|
if str(description.get("for")) == bwPacket.get(descriptor.get("scanField")):
|
|
logging.debug("Description '%s' added in packet field '%s'",
|
|
description.get("add"), descriptor.get("descrField"))
|
|
bwPacket.set(descriptor.get("descrField"), description.get("add"))
|
|
break # this descriptor has found a description - run next descriptor
|
|
return bwPacket
|
|
|
|
def onUnload(self):
|
|
r"""!Called by destruction of the plugin"""
|
|
pass
|