ConfigurationFileReader::ReadLine returns typing.Optional[str] (#4)

It returns str or None

None - it is EOF.

Author: dmitry-lipetsk

src/implementation/v00/configuration_base.py

@@ -3308,7 +3308,7 @@ def Helper__LoadFileContent(
             lineData = fileContent.ReadLine()
 
             if not lineData:
-                # assert lineData is None
+                assert lineData is None
                 break
 
             assert type(lineData) == str

src/os/abstract/configuration_os_ops.py

@@ -6,14 +6,15 @@
 from ...core.raise_error import RaiseError
 
 import datetime
+import typing
 
 
 # //////////////////////////////////////////////////////////////////////////////
 # class ConfigurationFileReader
 
 
 class ConfigurationFileReader:
-    def ReadLine(self) -> str:
+    def ReadLine(self) -> typing.Optional[str]:
         RaiseError.MethodIsNotImplemented(__class__, "ReadLine")
 
 

src/os/local/configuration_os_ops.py

@@ -8,6 +8,7 @@
 import os
 import io
 import datetime
+import typing
 
 # //////////////////////////////////////////////////////////////////////////////
 # class ConfigurationOsFile
@@ -49,9 +50,16 @@ def IsClosed(self) -> bool:
         return self.m_file is None
 
     # --------------------------------------------------------------------
-    def ReadLine(self) -> str:
+    def ReadLine(self) -> typing.Optional[str]:
         assert isinstance(self.m_file, io.TextIOWrapper)
-        return self.m_file.readline()
+        r = self.m_file.readline()
+        assert type(r) == str  # noqa: E721
+        if not r:
+            assert r == ""
+            return None
+
+        assert r != ""
+        return r
 
     # --------------------------------------------------------------------
     def Overwrite(self, text: str) -> None:

tests/CfgFileReader.py

@@ -4,6 +4,7 @@
 from src.os.abstract.configuration_os_ops import ConfigurationFileReader
 
 import io
+import typing
 
 # //////////////////////////////////////////////////////////////////////////////
 # class CfgFileReader
@@ -19,9 +20,17 @@ def __init__(self, text: str):
         self.m_file = io.StringIO(text)
 
     # --------------------------------------------------------------------
-    def ReadLine(self) -> str:
+    def ReadLine(self) -> typing.Optional[str]:
         assert type(self.m_file) == io.StringIO
-        return self.m_file.readline()
+
+        r = self.m_file.readline()
+        assert type(r) == str  # noqa: E721
+        if not r:
+            assert r == ""
+            return None
+
+        assert r != ""
+        return r
 
 
 # //////////////////////////////////////////////////////////////////////////////