Commit graph

6 commits

Author SHA1 Message Date
Luflosi d4dcc75711
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 17:49:09 +02:00
Bastian Schroll 8e4dba28e3 PEP8 new line at end 2020-04-15 09:24:02 +02:00
Bastian Schroll 61819cda08 little fix 2020-04-15 08:52:44 +02:00
Bastian Schroll 806a3d8669 add non existent field test 2020-04-15 08:35:00 +02:00
Bastian Schroll e5141c186d
add comments 2020-04-14 18:47:12 +02:00
Bastian Schroll 370ad5ac85
add descriptor unit test 2020-04-14 18:33:49 +02:00