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
78 lines
2.5 KiB
Python
78 lines
2.5 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: configYaml.py
|
|
@date: 27.02.2019
|
|
@author: Bastian Schroll
|
|
@description: Module for the configuration in YAML format
|
|
"""
|
|
import logging
|
|
import yaml
|
|
import yaml.parser
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
|
|
class ConfigYAML:
|
|
|
|
def __init__(self, config=None):
|
|
self._config = config
|
|
|
|
def __iter__(self):
|
|
for item in self._config:
|
|
if type(item) is list or type(item) is dict:
|
|
yield ConfigYAML(item)
|
|
else:
|
|
yield item
|
|
|
|
def __len__(self):
|
|
r"""!returns the length of an config element"""
|
|
return len(self._config)
|
|
|
|
def __str__(self):
|
|
r"""!Returns the string representation of the internal config dict"""
|
|
return str(self._config)
|
|
|
|
def loadConfigFile(self, configPath):
|
|
r"""!loads a given configuration file
|
|
|
|
@param configPath: Path to the config file
|
|
@return True or False"""
|
|
logging.debug("load config file from: %s", configPath)
|
|
try:
|
|
with open(configPath) as file:
|
|
# use safe_load instead load
|
|
self._config = yaml.safe_load(file)
|
|
return True
|
|
except FileNotFoundError:
|
|
logging.error("config file not found: %s", configPath)
|
|
except yaml.parser.ParserError:
|
|
logging.exception("syntax error in config file: %s", configPath)
|
|
return False
|
|
|
|
def get(self, *args, default=None):
|
|
r"""!Get a single value from the config
|
|
or a value set in a new configYAML class instance
|
|
|
|
@param *args: Config section (one ore more strings)
|
|
@param default: Default value if section not found (None)
|
|
@return: A single value, a value set in an configYAML instance, the default value"""
|
|
tmp = self._config
|
|
try:
|
|
for arg in args:
|
|
tmp = tmp.get(arg, default)
|
|
if type(tmp) is list or type(tmp) is dict:
|
|
return ConfigYAML(tmp)
|
|
else:
|
|
return tmp
|
|
except AttributeError: # pragma: no cover
|
|
return default
|