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
55 lines
1.8 KiB
Python
55 lines
1.8 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: misc.py
|
|
@date: 11.03.2019
|
|
@author: Bastian Schroll
|
|
@description: Some misc functions
|
|
"""
|
|
import logging
|
|
from boswatch.utils import version
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
def addClientDataToPacket(bwPacket, config):
|
|
r"""!Add the client information to the decoded data
|
|
|
|
This function adds the following data to the bwPacket:
|
|
- clientName
|
|
- clientVersion
|
|
- clientBuildDate
|
|
- clientBranch
|
|
- inputSource
|
|
- frequency"""
|
|
logging.debug("add client data to bwPacket")
|
|
bwPacket.set("clientName", config.get("client", "name"))
|
|
bwPacket.set("clientVersion", version.client)
|
|
bwPacket.set("clientBuildDate", version.date)
|
|
bwPacket.set("clientBranch", version.branch)
|
|
bwPacket.set("inputSource", config.get("client", "inputSource"))
|
|
bwPacket.set("frequency", config.get("inputSource", "sdr", "frequency"))
|
|
|
|
|
|
def addServerDataToPacket(bwPacket, config):
|
|
r"""!Add the server information to the decoded data
|
|
|
|
This function adds the following data to the bwPacket:
|
|
- serverName
|
|
- serverVersion
|
|
- serverBuildDate
|
|
- serverBranch"""
|
|
logging.debug("add server data to bwPacket")
|
|
bwPacket.set("serverName", config.get("server", "name"))
|
|
bwPacket.set("serverVersion", version.server)
|
|
bwPacket.set("serverBuildDate", version.date)
|
|
bwPacket.set("serverBranch", version.branch)
|