solentware-base 5.2.3__tar.gz → 5.4__tar.gz

{solentware_base-5.2.3/solentware_base.egg-info → solentware_base-5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: solentware-base
-Version: 5.2.3
+Version: 5.4
 Summary: Bitmapped record number databases.
 Author-email: Roger Marsh <roger.marsh@solentware.co.uk>
 License-Expression: BSD-3-Clause

{solentware_base-5.2.3 → solentware_base-5.4}/pyproject.toml

@@ -10,7 +10,7 @@ line-length = 79
 
 [project]
 name = "solentware-base"
-version = "5.2.3"
+version = "5.4"
 authors = [
   { name="Roger Marsh", email="roger.marsh@solentware.co.uk" },
 ]

{solentware_base-5.2.3 → solentware_base-5.4}/solentware_base/core/_database.py

@@ -62,7 +62,7 @@ class Database:
         """
         return self._file_per_database
 
-    def _generate_database_file_name(self, name):
+    def generate_database_file_name(self, name):
         """Return path to database file.
 
         By default this is a file where os.path.basename(path) is same as
@@ -332,7 +332,7 @@ class Database:
         # record number only.
         return self.is_primary(file, field)
 
-    def repair_cursor(self, oldcursor, *a):
+    def repair_cursor(self, oldcursor, file, field):
         """Return oldcursor for compatibility with DPT database engine.
 
         When using the DPT database engine an application may need to replace
@@ -344,10 +344,10 @@ class Database:
         cursor in DPT.  The existing cursor will notice the new record in the
         Berkeley DB and SQLite3 database engines.
 
-        *a absorbs the arguments needed by the DPT version of this method.
+        The 'file' and 'field' parameters are ignored.
 
         """
-        del a
+        del file, field
         return oldcursor
 
     def allocate_and_open_contexts(self, files=None):

{solentware_base-5.2.3 → solentware_base-5.4}/solentware_base/core/_databasedu.py

@@ -265,8 +265,14 @@ class Database(_database.Database):
             self.deferred_update_housekeeping()
             self.start_transaction()
 
-    def next_sorted_item(self, index_directory):
-        """Yield sorted items from files in index_directory."""
-        merger = merge.Merge(index_directory)
-        for item in merger.sorter():
-            yield item
+    def get_merge_import_sort_area(self):
+        """Return database directory.
+
+        The directory containing database is used for sorting by default,
+        subclasses should override as required.
+
+        There is little point in doing so unless the sort area is then on
+        a different drive or mount point.
+
+        """
+        return self.home_directory

{solentware_base-5.2.3 → solentware_base-5.4}/solentware_base/core/_db.py

@@ -34,6 +34,7 @@ from .constants import (
     CONTROL_FILE,
     DEFAULT_SEGMENT_SIZE_BYTES,
     SPECIFICATION_KEY,
+    APPLICATION_CONTROL_KEY,
     SEGMENT_SIZE_BYTES_KEY,
     SEGMENT_HEADER_LENGTH,
     FIELDS,
@@ -496,6 +497,9 @@ class Database(_database.Database):
                 repr(self.segment_size_bytes).encode(),
                 txn=self.dbtxn,
             )
+            self.table[CONTROL_FILE].put(
+                APPLICATION_CONTROL_KEY, repr({}).encode(), txn=self.dbtxn
+            )
         self.commit()
         self._dbe = dbe
 
@@ -1252,6 +1256,111 @@ class Database(_database.Database):
         finally:
             cursor.close()
 
+    # Defined for compatibility with _sqlite module.
+    find_values_ascending = find_values
+
+    def find_values_descending(self, valuespec, file):
+        """Yield index file values in valuespec range in descending order."""
+        cursor = self.table[
+            SUBFILE_DELIMITER.join((file, valuespec.field))
+        ].cursor(txn=self.dbtxn)
+        try:
+            if valuespec.above_value and valuespec.below_value:
+                record = cursor.set_range(valuespec.below_value.encode())
+                if record:
+                    if record[0] >= valuespec.below_value.encode():
+                        record = cursor.prev_nodup()
+                while record:
+                    key = record[0].decode()
+                    if key <= valuespec.above_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            elif valuespec.above_value and valuespec.to_value:
+                record = cursor.set_range(valuespec.to_value.encode())
+                if record:
+                    if record[0] > valuespec.to_value.encode():
+                        record = cursor.prev_nodup()
+                while record:
+                    key = record[0].decode()
+                    if key <= valuespec.above_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            elif valuespec.from_value and valuespec.to_value:
+                record = cursor.set_range(valuespec.to_value.encode())
+                if record:
+                    if record[0] > valuespec.to_value.encode():
+                        record = cursor.prev_nodup()
+                while record:
+                    key = record[0].decode()
+                    if key < valuespec.from_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            elif valuespec.from_value and valuespec.below_value:
+                record = cursor.set_range(valuespec.below_value.encode())
+                if record:
+                    if record[0] >= valuespec.below_value.encode():
+                        record = cursor.prev_nodup()
+                while record:
+                    key = record[0].decode()
+                    if key < valuespec.from_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            elif valuespec.above_value:
+                record = cursor.last()
+                while record:
+                    key = record[0].decode()
+                    if key <= valuespec.above_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            elif valuespec.from_value:
+                record = cursor.last()
+                while record:
+                    key = record[0].decode()
+                    if key < valuespec.from_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            elif valuespec.to_value:
+                record = cursor.set_range(valuespec.to_value.encode())
+                if record:
+                    if record[0] > valuespec.to_value.encode():
+                        record = cursor.prev_nodup()
+                while record:
+                    key = record[0].decode()
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            elif valuespec.below_value:
+                record = cursor.set_range(valuespec.below_value.encode())
+                if record:
+                    if record[0] >= valuespec.below_value.encode():
+                        record = cursor.prev_nodup()
+                while record:
+                    key = record[0].decode()
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+            else:
+                record = cursor.last()
+                while record:
+                    key = record[0].decode()
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = cursor.prev_nodup()
+        finally:
+            cursor.close()
+
     # The bit setting in existence bit map decides if a record is put on the
     # recordset created by the make_recordset_*() methods.
 
@@ -1751,7 +1860,7 @@ class Database(_database.Database):
         finally:
             db.close_database()
 
-    def _generate_database_file_name(self, name):
+    def generate_database_file_name(self, name):
         """Extend, return path to Berkeley DB file for name.
 
         Delegate to superclass if all databases are in one file.
@@ -1760,9 +1869,28 @@ class Database(_database.Database):
 
         """
         if not self._file_per_database:
-            return super()._generate_database_file_name(name)
+            return super().generate_database_file_name(name)
         return os.path.join(self.home_directory, name)
 
+    def get_application_control(self):
+        """Return dict of application control items."""
+        value = self.table[CONTROL_FILE].get(
+            APPLICATION_CONTROL_KEY,
+            txn=self.dbtxn,
+        )
+        if value is not None:
+            return literal_eval(value.decode())
+        return {}
+
+    def set_application_control(self, appcontrol):
+        """Set dict of application control items."""
+        self.table[CONTROL_FILE].delete(
+            APPLICATION_CONTROL_KEY, txn=self.dbtxn
+        )
+        self.table[CONTROL_FILE].put(
+            APPLICATION_CONTROL_KEY, repr(appcontrol).encode(), txn=self.dbtxn
+        )
+
 
 class Cursor(_cursor.Cursor):
     """Define a cursor on the underlying database engine dbset.

{solentware_base-5.2.3 → solentware_base-5.4}/solentware_base/core/_db_tkinter.py

@@ -33,6 +33,7 @@ from .constants import (
     CONTROL_FILE,
     DEFAULT_SEGMENT_SIZE_BYTES,
     SPECIFICATION_KEY,
+    APPLICATION_CONTROL_KEY,
     SEGMENT_SIZE_BYTES_KEY,
     SEGMENT_HEADER_LENGTH,
     FIELDS,
@@ -638,6 +639,11 @@ class Database(_database.Database):
                 ]
             )
             tcl_tk_call(tuple(command))
+            command = [self.table[CONTROL_FILE], "put"]
+            if self.dbtxn:
+                command.extend(["-txn", self.dbtxn])
+            command.extend([APPLICATION_CONTROL_KEY, repr({}).encode()])
+            tcl_tk_call(tuple(command))
         self.commit()
 
     def _run_db_archive(self):
@@ -1610,6 +1616,157 @@ class Database(_database.Database):
         finally:
             tcl_tk_call((cursor, "close"))
 
+    # Defined for compatibility with _sqlite module.
+    find_values_ascending = find_values
+
+    def find_values_descending(self, valuespec, file):
+        """Yield index file values in valuespec range in descending order."""
+        command = [
+            self.table[SUBFILE_DELIMITER.join((file, valuespec.field))],
+            "cursor",
+        ]
+        if self.dbtxn:
+            command.extend(["-txn", self.dbtxn])
+        cursor = tcl_tk_call(tuple(command))
+        try:
+            if valuespec.above_value and valuespec.below_value:
+                record = tcl_tk_call(
+                    (
+                        cursor,
+                        "get",
+                        "-set_range",
+                        valuespec.below_value.encode(),
+                    )
+                )
+                if record:
+                    if record[0][0] >= valuespec.below_value.encode():
+                        record = tcl_tk_call((cursor, "get", "-prevnodup"))
+                while record:
+                    key = record[0][0].decode()
+                    if key <= valuespec.above_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            elif valuespec.above_value and valuespec.to_value:
+                record = tcl_tk_call(
+                    (
+                        cursor,
+                        "get",
+                        "-set_range",
+                        valuespec.to_value.encode(),
+                    )
+                )
+                if record:
+                    if record[0][0] > valuespec.to_value.encode():
+                        record = tcl_tk_call((cursor, "get", "-prevnodup"))
+                while record:
+                    key = record[0][0].decode()
+                    if key <= valuespec.above_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            elif valuespec.from_value and valuespec.to_value:
+                record = tcl_tk_call(
+                    (
+                        cursor,
+                        "get",
+                        "-set_range",
+                        valuespec.to_value.encode(),
+                    )
+                )
+                if record:
+                    if record[0][0] > valuespec.to_value.encode():
+                        record = tcl_tk_call((cursor, "get", "-prevnodup"))
+                while record:
+                    key = record[0][0].decode()
+                    if key < valuespec.from_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            elif valuespec.from_value and valuespec.below_value:
+                record = tcl_tk_call(
+                    (
+                        cursor,
+                        "get",
+                        "-set_range",
+                        valuespec.below_value.encode(),
+                    )
+                )
+                if record:
+                    if record[0][0] >= valuespec.below_value.encode():
+                        record = tcl_tk_call((cursor, "get", "-prevnodup"))
+                while record:
+                    key = record[0][0].decode()
+                    if key < valuespec.from_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            elif valuespec.above_value:
+                record = tcl_tk_call((cursor, "get", "-last"))
+                while record:
+                    key = record[0][0].decode()
+                    if key <= valuespec.above_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            elif valuespec.from_value:
+                record = tcl_tk_call((cursor, "get", "-last"))
+                while record:
+                    key = record[0][0].decode()
+                    if key < valuespec.from_value:
+                        break
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            elif valuespec.to_value:
+                record = tcl_tk_call(
+                    (
+                        cursor,
+                        "get",
+                        "-set_range",
+                        valuespec.to_value.encode(),
+                    )
+                )
+                if record:
+                    if record[0][0] > valuespec.to_value.encode():
+                        record = tcl_tk_call((cursor, "get", "-prevnodup"))
+                while record:
+                    key = record[0][0].decode()
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            elif valuespec.below_value:
+                record = tcl_tk_call(
+                    (
+                        cursor,
+                        "get",
+                        "-set_range",
+                        valuespec.below_value.encode(),
+                    )
+                )
+                if record:
+                    if record[0][0] >= valuespec.below_value.encode():
+                        record = tcl_tk_call((cursor, "get", "-prevnodup"))
+                while record:
+                    key = record[0][0].decode()
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+            else:
+                record = tcl_tk_call((cursor, "get", "-last"))
+                while record:
+                    key = record[0][0].decode()
+                    if valuespec.apply_pattern_and_set_filters_to_value(key):
+                        yield key
+                    record = tcl_tk_call((cursor, "get", "-prevnodup"))
+        finally:
+            tcl_tk_call((cursor, "close"))
+
     # The bit setting in existence bit map decides if a record is put on the
     # recordset created by the make_recordset_*() methods.
 
@@ -2185,7 +2342,7 @@ class Database(_database.Database):
         finally:
             db.close_database()
 
-    def _generate_database_file_name(self, name):
+    def generate_database_file_name(self, name):
         """Extend, return path to Berkeley DB file for name.
 
         Delegate to superclass if all databases are in one file.
@@ -2194,9 +2351,37 @@ class Database(_database.Database):
 
         """
         if not self._file_per_database:
-            return super()._generate_database_file_name(name)
+            return super().generate_database_file_name(name)
         return os.path.join(self.home_directory, name)
 
+    def get_application_control(self):
+        """Return dict of application control items."""
+        command = [self.table[CONTROL_FILE], "get"]
+        if self.dbtxn:
+            command.extend(["-txn", self.dbtxn])
+        command.extend(
+            [
+                APPLICATION_CONTROL_KEY,
+            ]
+        )
+        value = tcl_tk_call(tuple(command))
+        if value is not None:
+            return literal_eval(value.decode())
+        return {}
+
+    def set_application_control(self, appcontrol):
+        """Set dict of application control items."""
+        command = [self.table[CONTROL_FILE], "delete"]
+        if self.dbtxn:
+            command.extend(["-txn", self.dbtxn])
+        command.extend([APPLICATION_CONTROL_KEY])
+        tcl_tk_call(tuple(command))
+        command = [self.table[CONTROL_FILE], "put"]
+        if self.dbtxn:
+            command.extend(["-txn", self.dbtxn])
+        command.extend([APPLICATION_CONTROL_KEY, repr(appcontrol).encode()])
+        tcl_tk_call(tuple(command))
+
 
 class Cursor(_cursor.Cursor):
     """Define a cursor on the underlying database engine dbset.

{solentware_base-5.2.3 → solentware_base-5.4}/solentware_base/core/_dbdu.py

@@ -430,9 +430,8 @@ class Database(_databasedu.Database):
     def merge_writer(self, file, field):
         """Return a Writer instance for the field index on table file.
 
-        Call the write() method with object returned by next_sorted_item
-        method.
-
+        Call the Writer.write() method with an object yielded by the
+        merge.next_sorted_item() function.
         """
 
         def make_segment_from_high(high, transaction):

{solentware_base-5.2.3 → solentware_base-5.4}/solentware_base/core/_dbdu_tkinter.py

@@ -522,9 +522,8 @@ class Database(_databasedu.Database):
     def merge_writer(self, file, field):
         """Return a Writer instance for the field index on table file.
 
-        Call the write() method with object returned by next_sorted_item
-        method.
-
+        Call the Writer.write() method with an object yielded by the
+        merge.next_sorted_item() function.
         """
 
         def make_segment_from_high(high, get_segment_value):