Skip to content

Commit 8aa75f2

Browse files
author
Joel Collins
committed
Added docstrings
1 parent d7301cb commit 8aa75f2

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

src/labthings/server/wsgi/handler.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
from logging import getLogger, StreamHandler, getLoggerClass, Formatter, DEBUG
44

55

6-
def create_logger(name, handlers=None, debug=False):
6+
def create_logger(name, handlers=None):
7+
"""Created a logger object from a list of log handlers
8+
9+
Args:
10+
name (str): Name for the logger
11+
handlers ([logging.Handler], optional): [List of log handlers]. Defaults to None.
12+
13+
Returns:
14+
[logging.Logger]: Logger object containing the passed handlers
15+
"""
716
if not handlers:
817
handlers = ()
918

@@ -16,6 +25,12 @@ def create_logger(name, handlers=None, debug=False):
1625

1726

1827
class WebSocketHandler(_WebSocketHandler):
28+
"""
29+
Override geventwebsocket.handler.WebSocketHandler logger behaviour.
30+
This allows geventwebsocket to properly interact with the
31+
gevent.pywsgi.WSGIServer logger.
32+
"""
33+
1934
@property
2035
def logger(self):
2136
if not hasattr(self, "_logger"):

0 commit comments

Comments
 (0)