From: Michael Orlitzky <michael@orlitzky.com>
Date: Thu, 15 Sep 2022 13:46:16 +0000 (-0400)
Subject: bin/djbdns-logparse.py: add docs for parse_logfile().
X-Git-Tag: 0.0.1~48
X-Git-Url: http://gitweb.michael.orlitzky.com/?p=djbdns-logparse.git;a=commitdiff_plain;h=dde706b0f337a37793d3a507802ee6e5ae3ef564

bin/djbdns-logparse.py: add docs for parse_logfile().
---

diff --git a/bin/djbdns-logparse.py b/bin/djbdns-logparse.py
index 5067116..95bc4e0 100755
--- a/bin/djbdns-logparse.py
+++ b/bin/djbdns-logparse.py
@@ -3,7 +3,7 @@
 Convert tinydns and dnscache logs to human-readable form
 """
 
-import re
+import re, typing
 from struct import pack
 from time import strftime, gmtime
 from subprocess import Popen, PIPE
@@ -247,7 +247,17 @@ def handle_tinydns_log(line : str, match: re.Match):
                % (code, ip, port, id, type, name))
 
 
-def parse_logfile(file):
+def parse_logfile(file : typing.TextIO):
+    """
+    Process a single log ``file``.
+
+    Parameters
+    ----------
+
+    file : typing.TextIO
+        An open log file, or stdin.
+
+    """
     # Open pipe to tai64nlocal: we will write lines of our input (the
     # raw log file) to it, and read log lines with readable timestamps
     # from it.
@@ -290,7 +300,5 @@ def main():
         parse_logfile(f)
 
 
-
-
 if __name__ == "__main__":
     main()