Document all the things! (#117)

Add lots of docstrings everywhere
This commit is contained in:
2024-08-23 19:26:05 -05:00
committed by GitHub
parent 8bbf19cb30
commit af6d6e1525
10 changed files with 699 additions and 396 deletions

View File

@@ -1,11 +1,9 @@
''' app/init.py '''
import logging
import multiprocessing
import os
import socket
import sys
import threading
import time
from collections import deque
from src.api.api_server import start_server
@@ -22,8 +20,10 @@ logger = logging.getLogger()
def run(server_only=False) -> int:
"""
Initializes the application and runs it.
"""Initializes the application and runs it.
Args:
server_only: Run in server-only CLI mode. Default is False (runs in GUI mode).
Returns:
int: The exit status code.
@@ -84,9 +84,7 @@ def run(server_only=False) -> int:
'system_os_version': current_system_os_version()}
ZeroconfServer.start()
logger.info(f"Zordon Render Server started - Hostname: {local_hostname}")
RenderQueue.evaluation_inverval = Config.queue_eval_seconds
RenderQueue.start()
RenderQueue.start() # Start evaluating the render queue
# start in gui or server only (cli) mode
logger.debug(f"Launching in {'server only' if server_only else 'GUI'} mode")
@@ -137,8 +135,8 @@ def __setup_buffer_handler():
buffer_handler = BufferingHandler()
buffer_handler.setFormatter(logging.getLogger().handlers[0].formatter)
logger = logging.getLogger()
logger.addHandler(buffer_handler)
new_logger = logging.getLogger()
new_logger.addHandler(buffer_handler)
return buffer_handler