django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2024-11-24 08:53:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

refact(daphne/access.py): AccessLogGenerator refactor

Browse Source 
1. Used f-strings to make the code more concise and readable
2. Used the get method to get default values for status and length
3. Refactored the code to remove redundant code
4. Changed the order of the parameters of the write_entry method to match the order of the format string
5. Added default values to the parameters of the write_entry method to simplify the calls to it
This commit is contained in:
Valerii 2023-05-05 02:10:19 +03:00 committed by GitHub
parent 1eaf2206cc
commit 3f50e11065
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
daphne/access.py
View File

@ -1,6 +1,5 @@
import datetime import datetime
class AccessLogGenerator: class AccessLogGenerator:
""" """
Object that implements the Daphne "action logger" internal interface in Object that implements the Daphne "action logger" internal interface in
@ -14,57 +13,26 @@ class AccessLogGenerator:
""" """
Called when an action happens; use it to generate log entries. Called when an action happens; use it to generate log entries.
""" """
# HTTP requests
if protocol == "http" and action == "complete": if protocol == "http" and action == "complete":
self.write_entry( self.write_entry(
host=details["client"], host=details["client"],
date=datetime.datetime.now(), date=datetime.datetime.now(),
request="%(method)s %(path)s" % details, request=f"{details['method']} {details['path']}",
status=details["status"], status=details.get("status", "-"),
length=details["size"], length=details.get("size", "-"),
) )
# Websocket requests elif protocol == "websocket":
elif protocol == "websocket" and action == "connecting": message = f"WS{action.upper()} {details.get('path', '')}"
self.write_entry( self.write_entry(
host=details["client"], host=details["client"],
date=datetime.datetime.now(), date=datetime.datetime.now(),
request="WSCONNECTING %(path)s" % details, request=message,
)
elif protocol == "websocket" and action == "rejected":
self.write_entry(
host=details["client"],
date=datetime.datetime.now(),
request="WSREJECT %(path)s" % details,
)
elif protocol == "websocket" and action == "connected":
self.write_entry(
host=details["client"],
date=datetime.datetime.now(),
request="WSCONNECT %(path)s" % details,
)
elif protocol == "websocket" and action == "disconnected":
self.write_entry(
host=details["client"],
date=datetime.datetime.now(),
request="WSDISCONNECT %(path)s" % details,
) )
def write_entry( def write_entry(self, host, date, request, status="-", length="-", ident="-", user="-"):
self, host, date, request, status=None, length=None, ident=None, user=None
):
""" """
Writes an NCSA-style entry to the log file (some liberty is taken with Writes an NCSA-style entry to the log file (some liberty is taken with
what the entries are for non-HTTP) what the entries are for non-HTTP)
""" """
self.stream.write( formatted_date = date.strftime("%d/%b/%Y:%H:%M:%S")
'%s %s %s [%s] "%s" %s %s\n' self.stream.write(f"{host} {ident} {user} [{formatted_date}] \"{request}\" {status} {length}\n")
% (
host,
ident or "-",
user or "-",
date.strftime("%d/%b/%Y:%H:%M:%S"),
request,
status or "-",
length or "-",
)
)