BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2025-12-06 07:12:04 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
BW3-Core/module/descriptor.py

59 lines
2.2 KiB
Python
Raw Normal View History

refactor regexFilter config
2019-10-27 20:12:54 +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"""!
refactor regexFilter config
2019-10-27 20:12:54 +01:00
____ ____ ______ __ __ __ _____
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
German BOS Information Script
by Bastian Schroll
add descriptor module and docu
2019-10-27 21:08:23 +01:00
@file: descriptor.py
@date: 27.10.2019
refactor regexFilter config
2019-10-27 20:12:54 +01:00
@author: Bastian Schroll
add descriptor module and docu
2019-10-27 21:08:23 +01:00
@description: Module to add descriptions to bwPackets
refactor regexFilter config
2019-10-27 20:12:54 +01:00
"""
import logging
some refactorings
2019-10-28 21:20:05 +01:00
from module.moduleBase import ModuleBase
refactor regexFilter config
2019-10-27 20:12:54 +01:00
# ###################### #
# Custom plugin includes #
# ###################### #
logging.debug("- %s loaded", __name__)
fix some errors
2019-10-28 21:27:15 +01:00
class BoswatchModule(ModuleBase):
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"""!Adds descriptions to bwPackets"""
refactor regexFilter config
2019-10-27 20:12:54 +01:00
def __init__(self, config):
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"""!Do not change anything here!"""
refactor regexFilter config
2019-10-27 20:12:54 +01:00
super().__init__(__name__, config) # you can access the config class on 'self.config'
def onLoad(self):
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"""!Called by import of the plugin"""
add descriptor module and docu
2019-10-27 21:08:23 +01:00
for descriptor in self.config:
edit docs
2019-10-27 21:53:00 +01:00
if descriptor.get("wildcard", default=None):
add descriptor module and docu
2019-10-27 21:08:23 +01:00
self.registerWildcard(descriptor.get("wildcard"), descriptor.get("descrField"))
refactor regexFilter config
2019-10-27 20:12:54 +01:00
def doWork(self, bwPacket):
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"""!start an run of the module.
refactor regexFilter config
2019-10-27 20:12:54 +01:00
@param bwPacket: A BOSWatch packet instance"""
add descriptor module and docu
2019-10-27 21:08:23 +01:00
for descriptor in self.config:
fix error
2020-04-18 14:14:56 +02:00
if not bwPacket.get(descriptor.get("scanField")):
break # scanField is not available in this packet
Add Fix for descriptor
2020-04-14 22:34:17 +02:00
bwPacket.set(descriptor.get("descrField"), bwPacket.get(descriptor.get("scanField")))
add descriptor module and docu
2019-10-27 21:08:23 +01:00
for description in descriptor.get("descriptions"):
edit descriptor module
2019-10-27 21:58:06 +01:00
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"))
add descriptor module and docu
2019-10-27 21:08:23 +01:00
bwPacket.set(descriptor.get("descrField"), description.get("add"))
break # this descriptor has found a description - run next descriptor
refactor regexFilter config
2019-10-27 20:12:54 +01:00
return bwPacket
def onUnload(self):
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"""!Called by destruction of the plugin"""
refactor regexFilter config
2019-10-27 20:12:54 +01:00
pass
Reference in a new issue Copy permalink