djbdns/io.py: add a comment about an early return.

[djbdns-logparse.git] / djbdns / io.py

diff --git a/djbdns/io.py b/djbdns/io.py
index 1e41470452a30e4c56438ff2ab1ea84a210b0566..a3e6e430e8a7e7a19890b7d94af36eff3e42b86d 100644 (file)
--- a/djbdns/io.py
+++ b/djbdns/io.py
@@ -1,3 +1,7 @@
+r"""
+Functions that perform input/output. This forms a layer between the
+executable itself and the more libraryish modules.
+"""
 from subprocess import Popen, PIPE
 from typing import TextIO
 from djbdns.dnscache import handle_dnscache_log
@@ -38,6 +42,8 @@ def parse_logfile(file : TextIO):
                bufsize=0) as tai:
 
         if not tai.stdin or not tai.stdout:
+            # Mypy tells me that this can happen, based on the type
+            # annotations in the standard library I guess?
             return
 
         for line in file: