Release 1.3.4

Author: pcisar

docs/changelog.txt

@@ -2,6 +2,21 @@
 Changelog
 #########
 
+Version 1.3.4
+=============
+
+* `.FirebirdWarning` is not raised as exception, but reported via `warnings.warn`  mechanism.
+* User-defined encoding for string parameter and response values exchanged between driver
+  and Firebird engine. This includes TPB, DPB, SPB and various service values:
+
+  - `.TPB`: New `encoding` constructor parameter & attribute. Used for `table names` in table reservation.
+  - `.DPB`: Encoding based on connection charset for `config`, `user name`, `password` and `role`.
+  - `.SPB`: New `encoding` constructor parameter & attribute. Used for `config`, `user name`, `password` and `expected database`.
+  - Connection-related providers: Encoding based on connection charset.
+  - Server and Service providers: New `.Server.encoding` attribute.
+* Fixed bug in `.ServerDbServices3.get_statistics` when `tables` are specified.
+
+
 Version 1.3.3
 =============
 

docs/conf.py

@@ -23,10 +23,10 @@
 author = 'Pavel Císař'
 
 # The short X.Y version
-version = '1.3.3'
+version = '1.3.4'
 
 # The full version, including alpha/beta/rc tags
-release = '1.3.3'
+release = '1.3.4'
 
 
 # -- General configuration ---------------------------------------------------

firebird/driver/__init__.py

@@ -59,4 +59,4 @@
      Server, Statement
 
 #: Current driver version, SEMVER string.
-__VERSION__ = '1.3.2'
+__VERSION__ = '1.3.4'

firebird/driver/core.py

@@ -39,7 +39,7 @@
 import sys
 import threading
 import datetime
-#from warnings import warn
+from warnings import warn
 from ctypes import memmove, memset, create_string_buffer, cast, byref, string_at, sizeof, \
      c_char_p, c_void_p, c_byte, c_ulong
 from .types import Error, DatabaseError, InterfaceError, FirebirdWarning, BCD, \
@@ -104,9 +104,9 @@ def _check(self) -> None:
         if StateFlag.ERRORS in state:
             raise self.__report(DatabaseError, self.status.get_errors())
         if StateFlag.WARNINGS in state:  # pragma: no cover
-            raise self.__report(FirebirdWarning, self.status.get_warning())
-            #warn(self.__report(FirebirdWarning, self.status.get_warning()).args[0],
-                 #FirebirdWarning, 2)
+            #raise self.__report(FirebirdWarning, self.status.get_warning())
+            warn(self.__report(FirebirdWarning, self.status.get_warning()),
+                 stacklevel=2)
     @property
     def status(self) -> iStatus:
         "iStatus for interface"
@@ -868,7 +868,7 @@ class iAttachment_v3(iReferenceCounted):
     VERSION = 3
     def __init__(self, intf):
         super().__init__(intf)
-        self.charset: str = 'ascii'
+        self.encoding: str = 'ascii'
     def get_info(self, items: bytes, buffer: bytes) -> None:
         "Replaces `isc_database_info()`"
         self.vtable.getInfo(self, self.status, len(items), items, len(buffer), buffer)
@@ -930,7 +930,7 @@ def prepare(self, transaction: iTransaction, stmt: str, dialect: int,
         """Replaces `isc_dsql_prepare()`. Additional parameter flags makes it
 possible to control what information will be preloaded from engine at once
 (i.e. in single network packet for remote operation)."""
-        b_stmt: bytes = stmt.encode(self.charset)
+        b_stmt: bytes = stmt.encode(self.encoding)
         result = self.vtable.prepare(self, self.status, transaction, len(b_stmt), b_stmt,
                                      dialect, flags)
         self._check()
@@ -941,7 +941,7 @@ def execute(self, transaction: iTransaction, stmt: str, dialect: int,
         """Executes any SQL statement except returning multiple rows of data.
 Partial analogue of `isc_dsql_execute2()` - in and out XSLQDAs replaced with
 input and output messages with appropriate buffers."""
-        b_stmt: bytes = stmt.encode(self.charset)
+        b_stmt: bytes = stmt.encode(self.encoding)
         result = self.vtable.execute(self, self.status, transaction, len(b_stmt), b_stmt,
                                      dialect, in_metadata, in_buffer, out_metadata, out_buffer)
         self._check()
@@ -955,10 +955,10 @@ def open_cursor(self, transaction: iTransaction, stmt: str, dialect: int,
 may be used. Parameter cursor_name specifies name of opened cursor (analogue of
 `isc_dsql_set_cursor_name()`). Parameter cursor_flags is needed to open
 bidirectional cursor setting it's value to Istatement::CURSOR_TYPE_SCROLLABLE."""
-        b_stmt: bytes = stmt.encode(self.charset)
+        b_stmt: bytes = stmt.encode(self.encoding)
         result = self.vtable.openCursor(self, self.status, transaction, len(b_stmt), b_stmt,
                                         dialect, in_metadata, in_buffer, out_metadata,
-                                        cursor_name.encode(self.charset), cursor_flags)
+                                        cursor_name.encode(self.encoding), cursor_flags)
         self._check()
         return iResultSet(result)
     def que_events(self, callback: iEventCallbackImpl, events: bytes) -> iEvents:
@@ -1011,7 +1011,7 @@ def set_statement_timeout(self, timeout: int) -> None:
     def create_batch(self, transaction: iTransaction, stmt: str, dialect: int,
                      in_metadata: iMessageMetadata, params: bytes) -> iBatch:
         "TODO"
-        b_stmt: bytes = stmt.encode(self.charset)
+        b_stmt: bytes = stmt.encode(self.encoding)
         result = self.vtable.createBatch(self, self.status, transaction, len(b_stmt), b_stmt,
                                          dialect, in_metadata, len(params), params)
         self._check()
@@ -1146,7 +1146,7 @@ def insert_bytes(self, tag: int, value: bytes) -> None:
         "Inserts a clumplet with value containing passed bytes."
         self.vtable.insertBytes(self, self.status, tag, value, len(value))
         self._check()
-    def insert_string(self, tag: int, value: str, encoding='ascii') -> None:
+    def insert_string(self, tag: int, value: str, *, encoding='ascii') -> None:
         "Inserts a clumplet with value containing passed string."
         self.vtable.insertString(self, self.status, tag, value.encode(encoding))
         self._check()
@@ -1197,11 +1197,11 @@ def get_bigint(self) -> int:
         result = self.vtable.getBigInt(self, self.status)
         self._check()
         return result
-    def get_string(self) -> str:
+    def get_string(self, *, encoding='ascii') -> str:
         "Returns value of current clumplet as string."
         result = self.vtable.getString(self, self.status)
         self._check()
-        return string_at(result).decode()
+        return string_at(result).decode(encoding)
     def get_bytes(self) -> bytes:
         "Returns value of current clumplet as bytes."
         buffer = self.vtable.getBytes(self, self.status)

firebird/driver/interfaces.py

@@ -112,9 +112,36 @@ class NotSupportedError(DatabaseError):
 
 # Firebird engine warning via Python Warning mechanism
 
-class FirebirdWarning(Warning):
+class FirebirdWarning(UserWarning):
     """Warning from Firebird engine.
-    """
+
+    The important difference from `Warning` class is that `FirebirdWarning` accepts keyword
+    arguments, that are stored into instance attributes with the same name.
+
+    Important:
+        Attribute lookup on this class never fails, as all attributes that are not actually
+        set, have `None` value.
+
+    Example::
+
+        try:
+            if condition:
+                raise FirebirdWarning("Error message", err_code=1)
+            else:
+                raise FirebirdWarning("Unknown error")
+        except FirebirdWarning as e:
+            if e.err_code is None:
+                ...
+            elif e.err_code == 1:
+                ...
+
+    """
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args)
+        for name, value in kwargs.items():
+            setattr(self, name, value)
+    def __getattr__(self, name):
+        return None
 
 # Enums
 
@@ -1077,7 +1104,7 @@ class SrvStatFlag(IntFlag):
     RECORD_VERSIONS = 0x20
     NOCREATION = 0x80
     ENCRYPTION = 0x100
-    DEFAULT = DATA_PAGES | DATA_PAGES | IDX_PAGES
+    DEFAULT = DATA_PAGES | IDX_PAGES
 
 class SrvBackupFlag(IntFlag):
     """isc_spb_bkp_* flags for ServerAction.BACKUP.

firebird/driver/types.py

@@ -5,7 +5,7 @@ all-files=True
 
 [metadata]
 name = firebird-driver
-version = 1.3.3
+version = 1.3.4
 description = Firebird driver
 long_description = file: README.rst
 long_description_content_type = text/x-rst; charset=UTF-8

setup.cfg

@@ -53,6 +53,11 @@
 
 trace = False
 
+if not sys.warnoptions:
+    import warnings
+    warnings.simplefilter("always") # Change the filter in this process
+    #os.environ["PYTHONWARNINGS"] = "default" # Also affect subprocesses
+
 def os_environ_get_mock(key, default):
     return f'MOCK_{key}'
 
@@ -441,7 +446,10 @@ def test_db_info(self):
             self.assertGreaterEqual(con.info.ods_version, 11)
             self.assertGreaterEqual(con.info.ods_minor_version, 0)
             self.assertGreaterEqual(con.info.page_cache_size, 75)
-            self.assertEqual(con.info.pages_allocated, 367)
+            if self.version == FB30:
+                self.assertEqual(con.info.pages_allocated, 367)
+            else:
+                self.assertEqual(con.info.pages_allocated, 389)
             self.assertGreater(con.info.pages_used, 300)
             self.assertGreaterEqual(con.info.pages_free, 0)
             self.assertEqual(con.info.sweep_interval, 20000)
@@ -608,7 +616,8 @@ def test_tpb(self):
         with self.con.transaction_manager(tpb_buffer) as tr:
             info = tr.info.get_info(TraInfoCode.ISOLATION)
             if self.version == FB40:
-                self.assertEqual(info, Isolation.READ_COMMITTED_READ_CONSISTENCY)
+                self.assertIn(info, [Isolation.READ_COMMITTED_READ_CONSISTENCY,
+                                     Isolation.READ_COMMITTED_RECORD_VERSION])
             else:
                 self.assertEqual(info, Isolation.READ_COMMITTED_RECORD_VERSION)
             self.assertEqual(tr.info.get_info(TraInfoCode.ACCESS), TraInfoAccess.READ_WRITE)
@@ -994,10 +1003,7 @@ def test_affected_rows(self):
         with self.con.cursor() as cur:
             self.assertEqual(cur.affected_rows, -1)
             cur.execute('select * from project')
-            if self.version == FB40:
-                self.assertEqual(cur.affected_rows, 1)
-            else:
-                self.assertEqual(cur.affected_rows, 0)
+            self.assertEqual(cur.affected_rows, 0)
             cur.fetchone()
             if sys.platform == 'win32':
                 rcount = 6