Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-20 20:22:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

add docstring to has_started and indentation edits

Browse Source
This commit is contained in:
Ziad-I
2024-07-31 21:24:28 +03:00
committed by Dion Moult
parent bdf4258895
commit 281da8ed77
1 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/blenderbim/blenderbim/tool/web.py
+20 -8
View File
@@ -61,7 +61,7 @@ class Web(blenderbim.core.tool.Web):
It then retrieves the port number, and returns it. It then retrieves the port number, and returns it.
Returns: Returns:
int: The port number that was generated. - int: The port number that was generated.
""" """
print("Generating port number") print("Generating port number")
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
@@ -81,7 +81,7 @@ class Web(blenderbim.core.tool.Web):
- port (int): The port number to check. - port (int): The port number to check.
Returns: Returns:
bool: True if the port is available, False if it is in use. - bool: True if the port is available, False if it is in use.
""" """
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
# connect_ex returns errno.SUCCESS (0) if the connection succeeds # connect_ex returns errno.SUCCESS (0) if the connection succeeds
@@ -219,7 +219,19 @@ class Web(blenderbim.core.tool.Web):
print("Websocket server killed successfully") print("Websocket server killed successfully")
@classmethod @classmethod
def has_started(cls, port): def has_started(cls, port: int) -> bool:
"""
Check if the WebSocket server has started on the specified port.
This function continuously checks for the existence of the WebSocket server's process ID (PID) in the running_pid JSON file.
It waits for a maximum of 5 seconds before returning False.
Args:
- port (int): The port number on which the WebSocket server is expected to be running.
Returns:
- bool: True if the WebSocket server has started on the specified port within the maximum time limit, False otherwise.
"""
max_time = 5 max_time = 5
start = time.time() start = time.time()
while True: while True:
@@ -249,11 +261,11 @@ class Web(blenderbim.core.tool.Web):
Sends data to the Web UI via Websocket connection. Sends data to the Web UI via Websocket connection.
Args: Args:
- data (Optional[Any]): The data to send. If None, just sends data from WebData. - data (Optional[Any]): The data to send. If None, just sends data from WebData.
- data_key (str): The key under which to store the data in the payload. Defaults to "data". - data_key (str): The key under which to store the data in the payload. Defaults to "data".
- event (str): The WebSocket event to emit. Defaults to "data". - event (str): The WebSocket event to emit. Defaults to "data".
- namespace (str): The namespace for the WebSocket event. Defaults to "/blender". - namespace (str): The namespace for the WebSocket event. Defaults to "/blender".
- use_web_data (bool): Whether to use data from WebData. Defaults to True. - use_web_data (bool): Whether to use data from WebData. Defaults to True.
""" """
global ws_thread global ws_thread