Add Server.mode to fetch output by LINE or TO_EOF

Author: pcisar

firebird/driver/__init__.py

@@ -47,7 +47,7 @@
      DbAccessMode, DbSpaceReservation, DbWriteMode, ShutdownMode, OnlineMode, \
      ShutdownMethod, \
      ServerCapability, SrvRepairFlag, SrvStatFlag, SrvBackupFlag, \
-     SrvRestoreFlag, SrvNBackupFlag, \
+     SrvRestoreFlag, SrvNBackupFlag, SrvInfoCode, \
      apilevel, threadsafety, paramstyle, DESCRIPTION_NAME, DESCRIPTION_TYPE_CODE, \
      DESCRIPTION_DISPLAY_SIZE, DESCRIPTION_INTERNAL_SIZE, DESCRIPTION_PRECISION, \
      DESCRIPTION_SCALE, DESCRIPTION_NULL_OK, Date, Time, Timestamp, DateFromTicks, \

firebird/driver/core.py

@@ -4720,6 +4720,8 @@ def __init__(self, svc: iService, spb: bytes, host: str):
         self.spb: bytes = spb
         #: Server host
         self.host: str = host
+        #: Service output mode (line or eof)
+        self.mode: SrvInfoCode = SrvInfoCode.TO_EOF
         #: Response buffer used to comunicate with service
         self.response: CBuffer = CBuffer(USHRT_MAX)
         self._eof: bool = False
@@ -4778,13 +4780,19 @@ def _fetch_line(self, timeout: int=-1) -> Optional[str]:
     def _read_output(self, *, init: str='', timeout: int=-1) -> None:
         assert self._svc is not None
         self.response.clear()
-        self._svc.query(self._make_request(timeout), bytes([SrvInfoCode.TO_EOF]), self.response.raw)
+        self._svc.query(self._make_request(timeout), bytes([self.mode]), self.response.raw)
         tag = self.response.get_tag()
-        if tag != SrvInfoCode.TO_EOF:  # pragma: no cover
+        if tag != self.mode:  # pragma: no cover
             raise InterfaceError(f"Service responded with error code: {tag}")
-        init += self.response.read_sized_string()
+        data = self.response.read_sized_string()
+        init += data
+        if data and self.mode is SrvInfoCode.LINE:
+            init += '\n'
         self.__line_buffer = init.splitlines(keepends=True)
-        self._eof = self.response.get_tag() == isc_info_end
+        if self.mode is SrvInfoCode.TO_EOF:
+            self._eof = self.response.get_tag() == isc_info_end
+        else:
+            self._eof = not data
     def _read_all_binary_output(self, *, timeout: int=-1) -> bytes:
         assert self._svc is not None
         send = self._make_request(timeout)
@@ -4793,8 +4801,7 @@ def _read_all_binary_output(self, *, timeout: int=-1) -> bytes:
         while not eof:
             self.response.clear()
             self._svc.query(send, bytes([SrvInfoCode.TO_EOF]), self.response.raw)
-            tag = self.response.get_tag()
-            if tag != SrvInfoCode.TO_EOF:  # pragma: no cover
+            if (tag := self.response.get_tag()) != SrvInfoCode.TO_EOF:  # pragma: no cover
                 raise InterfaceError(f"Service responded with error code: {tag}")
             result.append(self.response.read_bytes())
             eof = self.response.get_tag() == isc_info_end
@@ -4806,12 +4813,10 @@ def _read_next_binary_output(self, *, timeout: int=-1) -> bytes:
             send = self._make_request(timeout)
             self.response.clear()
             self._svc.query(send, bytes([SrvInfoCode.TO_EOF]), self.response.raw)
-            tag = self.response.get_tag()
-            if tag != SrvInfoCode.TO_EOF:  # pragma: no cover
+            if (tag := self.response.get_tag()) != SrvInfoCode.TO_EOF:  # pragma: no cover
                 raise InterfaceError(f"Service responded with error code: {tag}")
             result = self.response.read_bytes()
-            tag = self.response.get_tag()
-            self._eof = tag == isc_info_end
+            self._eof = self.response.get_tag() == isc_info_end
         return result
     def is_running(self) -> bool:
         """Returns True if service is running.

test/test_driver.py

@@ -1579,7 +1579,13 @@ def tearDown(self):
             os.remove(self.fbk)
         if os.path.exists(self.fbk2):
             os.remove(self.fbk2)
-    def test_log(self):
+    def test_01_output_by_line(self):
+        self.svc.mode = SrvInfoCode.LINE
+        self.test_03_log()
+    def test_02_output_to_eof(self):
+        self.svc.mode = SrvInfoCode.TO_EOF
+        self.test_03_log()
+    def test_03_log(self):
         def fetchline(line):
             output.append(line)
 
@@ -1598,11 +1604,11 @@ def fetchline(line):
         self.svc.info.get_log(callback=fetchline)
         self.assertGreater(len(output), 0)
         self.assertEqual(output, log)
-    def test_get_limbo_transaction_ids(self):
+    def test_04_get_limbo_transaction_ids(self):
         self.skipTest('Not implemented yet')
         ids = self.svc.get_limbo_transaction_ids(database='employee')
         self.assertIsInstance(ids, type(list()))
-    def test_trace(self):
+    def test_05_trace(self):
         #self.skipTest('Not implemented yet')
         trace_config = """database = %s
         {
@@ -1648,12 +1654,12 @@ def test_trace(self):
             self.assertNotIn(trace2_id, svcx.trace.sessions)
             # Finalize
             svcx.trace.stop(session_id=trace1_id)
-    def test_get_users(self):
+    def test_06_get_users(self):
         users = self.svc.user.get_all()
         self.assertIsInstance(users, type(list()))
         self.assertIsInstance(users[0], driver.core.UserInfo)
         self.assertEqual(users[0].user_name, 'SYSDBA')
-    def test_manage_user(self):
+    def test_07_manage_user(self):
         USER_NAME = 'DRIVER_TEST'
         try:
             self.svc.user.delete(USER_NAME)