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
45 lines
1.3 KiB
Python
45 lines
1.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: paths.py
|
|
@date: 07.01.2018
|
|
@author: Bastian Schroll
|
|
@description: Important paths for some functions
|
|
"""
|
|
import logging
|
|
import os
|
|
import sys
|
|
|
|
logging.debug("- %s loaded", __name__)
|
|
|
|
# note searching for root part is not a nice solution atm
|
|
ROOT_PATH = os.path.dirname(sys.modules['boswatch'].__file__).replace("\\", "/") + "/../"
|
|
|
|
LOG_PATH = ROOT_PATH + "log/"
|
|
CONFIG_PATH = ROOT_PATH + "config/"
|
|
BIN_PATH = ROOT_PATH + "_bin/"
|
|
TEST_PATH = ROOT_PATH + "test/"
|
|
|
|
|
|
def fileExist(filePath):
|
|
return os.path.exists(filePath)
|
|
|
|
|
|
def makeDirIfNotExist(dirPath):
|
|
r"""!Checks if an directory is existing and create it if not
|
|
|
|
@param dirPath: Path of the directory
|
|
@return Path of the directory or False"""
|
|
if not os.path.exists(dirPath):
|
|
os.mkdir(dirPath)
|
|
logging.debug("directory created: %s", dirPath)
|
|
return dirPath
|