Release v1.3.1

Author: pcisar

docs/changelog.txt

@@ -2,6 +2,19 @@
 Changelog
 #########
 
+Version 1.3.1
+=============
+
+* `~firebird.base.buffer` module:
+
+  - Added `.MemoryBuffer.write_sized_string` for symetry with `.read_sized_string`.
+  - Now `.MemoryBuffer` string functions has also `errors` parameter in addition to `encoding`.
+
+* `~firebird.base.config` module:
+
+  - Direct assignment to `.Config` option raises a `ValueError` exception with message
+    "Cannot assign values to option itself, use `option.value` instead".
+
 Version 1.3.0
 =============
 

docs/conf.py

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

docs/config.txt

@@ -36,7 +36,8 @@ The framework is based around two classes:
 Additionally, the `.ApplicationDirectoryScheme` abstract base class defines set of mostly
 used application directories. The function `.get_directory_scheme()` could be then used
 to obtain instance that implements platform-specific standards for file-system location
-for these directories. Currently, only "Windows" and "Linux" directory schemes are supported.
+for these directories. Currently, only "Windows", "Linux" and "MacOS" directory schemes
+are supported.
 
 .. note::
     You may use `platform.system` call to determine the scheme name suitable for platform

firebird/base/buffer.py

@@ -220,17 +220,22 @@ def write_bigint(self, value: int) -> None:
         """Write tagged 8 byte number (c_ulonglong).
         """
         self.write_number(value, 8)
-    def write_string(self, value: str, *, encoding='ascii') -> None:
+    def write_string(self, value: str, *, encoding: str='ascii', errors: str='strict') -> None:
         """Write zero-terminated string.
         """
-        self.write(value.encode(encoding))
+        self.write(value.encode(encoding, errors))
         self.write_byte(0)
-    def write_pascal_string(self, value: str, *, encoding='ascii') -> None:
+    def write_pascal_string(self, value: str, *, encoding: str='ascii', errors: str='strict') -> None:
         """Write tagged Pascal string (2 byte length followed by data).
         """
-        value = value.encode(encoding)
-        size = len(value)
-        self.write_byte(size)
+        value = value.encode(encoding, errors)
+        self.write_byte(len(value))
+        self.write(value)
+    def write_sized_string(self, value: str, *, encoding: str='ascii', errors: str='strict') -> None:
+        """Write string (2 byte length followed by data).
+        """
+        value = value.encode(encoding, errors)
+        self.write_short(len(value))
         self.write(value)
     def read(self, size: int=-1) -> bytes:
         """Reads specified number of bytes, or all remaining data.
@@ -248,43 +253,43 @@ def read_number(self, size: int, *, signed=False) -> int:
         result = (0).from_bytes(self.raw[self.pos: self.pos + size], self.byteorder.value, signed=signed)
         self.pos += size
         return result
-    def read_byte(self, *, signed=False) -> int:
+    def read_byte(self, *, signed: bool=False) -> int:
         """Read 1 byte number (c_ubyte).
         """
         return self.read_number(1, signed=signed)
-    def read_short(self, *, signed=False) -> int:
+    def read_short(self, *, signed: bool=False) -> int:
         """Read 2 byte number (c_ushort).
         """
         return self.read_number(2, signed=signed)
-    def read_int(self, *, signed=False) -> int:
+    def read_int(self, *, signed: bool=False) -> int:
         """Read 4 byte number (c_uint).
         """
         return self.read_number(4, signed=signed)
-    def read_bigint(self, *, signed=False) -> int:
+    def read_bigint(self, *, signed: bool=False) -> int:
         """Read 8 byte number (c_ulonglong).
         """
         return self.read_number(8, signed=signed)
-    def read_sized_int(self, *, signed=False) -> int:
+    def read_sized_int(self, *, signed: bool=False) -> int:
         """Read number cluster (2 byte length followed by data).
         """
         return self.read_number(self.read_short(), signed=signed)
-    def read_string(self, *, encoding='ascii') -> str:
+    def read_string(self, *, encoding: str='ascii', errors: str='strict') -> str:
         """Read null-terminated string.
         """
         i = self.pos
         while i < self.buffer_size and safe_ord(self.raw[i]) != 0:
             i += 1
-        result = self.read(i - self.pos).decode(encoding)
+        result = self.read(i - self.pos).decode(encoding, errors)
         self.pos += 1
         return result
-    def read_pascal_string(self, *, encoding='ascii') -> str:
+    def read_pascal_string(self, *, encoding: str='ascii', errors: str='strict') -> str:
         """Read Pascal string (1 byte length followed by string data).
         """
-        return self.read(self.read_byte()).decode(encoding)
-    def read_sized_string(self, *, encoding='ascii') -> str:
+        return self.read(self.read_byte()).decode(encoding, errors)
+    def read_sized_string(self, *, encoding: str='ascii', errors: str='strict') -> str:
         """Read string (2 byte length followed by data).
         """
-        return self.read(self.read_short()).decode(encoding)
+        return self.read(self.read_short()).decode(encoding, errors)
     def read_bytes(self) -> bytes:
         """Read content of binary cluster (2 bytes data length followed by data).
         """

firebird/base/config.py

@@ -59,7 +59,7 @@
 from pathlib import Path
 import os
 from .config_pb2 import ConfigProto
-from .types import Error, MIME, ZMQAddress, PyExpr, PyCode, PyCallable
+from .types import Error, UNDEFINED, MIME, ZMQAddress, PyExpr, PyCode, PyCallable
 from .strconv import get_convertor, convert_to_str, Convertor
 
 PROTO_CONFIG = 'firebird.base.ConfigProto'
@@ -552,6 +552,11 @@ def __init__(self, name: str, *, optional: bool=False, description: str=None):
         self._name: str = name
         self._optional: bool = optional
         self._description: str = description if description is not None else self.__doc__
+    def __setattr__(self, name, value):
+        for attr in vars(self).values():
+            if isinstance(attr, Option) and attr.name == name:
+                raise ValueError('Cannot assign values to option itself, use `option.value` instead')
+        super().__setattr__(name, value)
     def validate(self) -> None:
         """Checks whether:
             - all required options have value other than None.

setup.cfg

@@ -5,7 +5,7 @@ all-files=True
 
 [metadata]
 name = firebird-base
-version = 1.3.0
+version = 1.3.1
 description = Firebird base modules for Python
 long_description = file: README.rst
 long_description_content_type = text/x-rst; charset=UTF-8

test/test_buffer.py

@@ -178,6 +178,12 @@ def test_write_pascal_string(self):
         self.assertEqual(buf.pos, 7)
         self.assertBuffer(buf, b'\x06string')
         self.assertTrue(buf.is_eof())
+    def test_write_sized_string(self):
+        buf = MemoryBuffer(0, factory=self.factory)
+        buf.write_sized_string('string')
+        self.assertEqual(buf.pos, 8)
+        self.assertBuffer(buf, b'\x06\x00string')
+        self.assertTrue(buf.is_eof())
     def test_write_past_size(self):
         buf = MemoryBuffer(0, max_size=5, factory=self.factory)
         buf.write(b'ABCDE')

test/test_config.py

@@ -3029,6 +3029,11 @@ def test_1_basics(self):
         self.assertIsNone(cfg.backup_db.database.value)
         self.assertEqual(cfg.backup_db.user.value, 'SYSDBA')
         self.assertIsNone(cfg.backup_db.password.value)
+        #
+        with self.assertRaises(ValueError) as cm:
+            cfg.opt_str = 'value'
+        self.assertEqual(cm.exception.args,
+                         ('Cannot assign values to option itself, use `option.value` instead',))
     def test_2_load_config(self):
         cfg = SimpleConfig()
         #