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/boswatch/network/netCheck.py

49 lines
1.6 KiB
Python
Raw Permalink Normal View History

add timer and netCheck
2018-09-21 12:35:23 +02: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"""!
add timer and netCheck
2018-09-21 12:35:23 +02:00
____ ____ ______ __ __ __ _____
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
German BOS Information Script
by Bastian Schroll
@file: netCheck.py
@date: 21.09.2018
@author: Bastian Schroll
@description: Worker to check internet connection
"""
import logging
from urllib.request import urlopen
logging.debug("- %s loaded", __name__)
class NetCheck:
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"""!Worker class to check internet connection"""
add timer and netCheck
2018-09-21 12:35:23 +02:00
def __init__(self, hostname="https://www.google.com/", timeout=1):
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"""!Create a new NetCheck instance
add docu to NetCheck class
2018-09-21 12:39:36 +02:00
@param hostname: host against connection check is running ("https://www.google.com/")
edit docs
2019-10-26 16:23:42 +02:00
@param timeout: timeout for connection check in sec. (1)"""
add timer and netCheck
2018-09-21 12:35:23 +02:00
self._hostname = hostname
self._timeout = timeout
remove unneded properties
2019-10-25 13:43:50 +02:00
self.connectionState = False
some improvements
2018-09-23 18:44:58 +02:00
self.checkConn() # initiate a first check
add timer and netCheck
2018-09-21 12:35:23 +02:00
def checkConn(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"""!Check the connection
add docu to NetCheck class
2018-09-21 12:39:36 +02:00
@return True or False"""
add timer and netCheck
2018-09-21 12:35:23 +02:00
try:
urlopen(self._hostname, timeout=self._timeout)
insert logging
2018-09-21 15:27:02 +02:00
logging.debug("%s is reachable", self._hostname)
remove unneded properties
2019-10-25 13:43:50 +02:00
self.connectionState = True
add timer and netCheck
2018-09-21 12:35:23 +02:00
return True
remove generall exception handling
2019-03-02 09:15:40 +01:00
except: # todo find right exception type
insert logging
2018-09-21 15:27:02 +02:00
logging.warning("%s is not reachable", self._hostname)
remove unneded properties
2019-10-25 13:43:50 +02:00
self.connectionState = False
add timer and netCheck
2018-09-21 12:35:23 +02:00
return False
Reference in a new issue Copy permalink