updates comments and docstrings

This commit is contained in:
Mose Müller 2023-11-06 09:54:50 +01:00
parent 08512e945b
commit d66a3ad015

View File

@ -10,10 +10,7 @@ from types import FrameType
from typing import Any, Optional, Protocol, TypedDict from typing import Any, Optional, Protocol, TypedDict
import uvicorn import uvicorn
from rpyc import ( from rpyc import ForkingServer, ThreadedServer
ForkingServer, # can be used for multiprocessing, e.g. a database interface server
)
from rpyc import ThreadedServer
from uvicorn.server import HANDLED_SIGNALS from uvicorn.server import HANDLED_SIGNALS
import pydase.units as u import pydase.units as u
@ -101,8 +98,7 @@ class Server:
enable_web: bool enable_web: bool
Whether to enable the web server. Default is True. Whether to enable the web server. Default is True.
use_forking_server: bool use_forking_server: bool
Whether to use ForkingServer for multiprocessing (e.g. for a database interface Whether to use ForkingServer for multiprocessing. Default is False.
server). Default is False.
web_settings: dict[str, Any] web_settings: dict[str, Any]
Additional settings for the web server. Default is {} (an empty dictionary). Additional settings for the web server. Default is {} (an empty dictionary).
additional_servers : list[AdditionalServer] additional_servers : list[AdditionalServer]