rdbpython 0.2.6__tar.gz → 0.2.7__tar.gz

{rdbpython-0.2.6 → rdbpython-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rdbpython
-Version: 0.2.6
+Version: 0.2.7
 Summary: Python bindings for RocksDB with Cython
 Author-email: Gor Arakelyan <gorarkln@gmail.com>
 Maintainer-email: Gor Arakelyan <gorarkln@gmail.com>
@@ -10,7 +10,7 @@ Project-URL: Documentation, https://github.com/nustackdev/rdbpy#readme
 Project-URL: Repository, https://github.com/nustackdev/rdbpy
 Project-URL: Issues, https://github.com/nustackdev/rdbpy/issues
 Project-URL: PyPI, https://pypi.org/project/rdbpython/
-Keywords: rocksdb,database,key-value,storage,embedded,cython
+Keywords: nustack,python,rocksdb,key-value-store,embedded-database,transactions,bindings,storage
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
@@ -80,6 +80,16 @@ while it.valid():
     it.next()
 ```
 
+## Lifetimes and threads
+
+Iterators, snapshots and transactions point into native state owned by their parent:
+
+- `Transaction.commit()`, `rollback()`, `close()` and a successful `rollback_to_save_point()` invalidate every iterator created from that transaction. So does `TransactionDB.begin_transaction(reuse=txn)`.
+- `DB.close()` / `TransactionDB.close()` invalidate every iterator and snapshot of the DB and roll back any transaction that is still open.
+- Using an invalidated iterator, or a DB after `close()`, raises `RuntimeError`. Dropping an invalidated object is safe, in any order, including when gc frees it.
+
+Threads: a transaction and its iterators belong to one thread and must not be shared between threads. rdbpy does no locking of its own and releases the GIL inside RocksDB calls, so ending a transaction, or closing a DB, while another thread is still inside a call on it or on its iterators is undefined behaviour and can crash. Close a DB only after every thread is done with it. A finalizer (a generator's `finally`, `__del__`) that ends a transaction runs on whichever thread triggers gc, so it counts as using the transaction from that thread. gc merely freeing objects on another thread is safe.
+
 ## Development
 
 ```bash

rdbpython-0.2.7/README.md

@@ -0,0 +1,61 @@
+# rdbpy
+
+Python bindings for RocksDB with Cython - **batteries included!**
+
+**No RocksDB installation required** - everything is bundled in the wheel for Linux and macOS (Intel + Apple Silicon).
+
+## Installation
+
+```bash
+pip install rdbpython
+```
+
+That's it! No need to install RocksDB or any compression libraries manually.
+
+## Usage
+
+```python
+import rdbpy
+
+# Open database
+options = rdbpy.Options(create_if_missing=True)
+db = rdbpy.DB('/path/to/db', options)
+
+# Put/Get
+db.put(b'key', b'value')
+value = db.get(b'key')
+
+# Iterate
+it = db.iterkeys()
+it.seek_to_first()
+while it.valid():
+    print(it.key())
+    it.next()
+```
+
+## Lifetimes and threads
+
+Iterators, snapshots and transactions point into native state owned by their parent:
+
+- `Transaction.commit()`, `rollback()`, `close()` and a successful `rollback_to_save_point()` invalidate every iterator created from that transaction. So does `TransactionDB.begin_transaction(reuse=txn)`.
+- `DB.close()` / `TransactionDB.close()` invalidate every iterator and snapshot of the DB and roll back any transaction that is still open.
+- Using an invalidated iterator, or a DB after `close()`, raises `RuntimeError`. Dropping an invalidated object is safe, in any order, including when gc frees it.
+
+Threads: a transaction and its iterators belong to one thread and must not be shared between threads. rdbpy does no locking of its own and releases the GIL inside RocksDB calls, so ending a transaction, or closing a DB, while another thread is still inside a call on it or on its iterators is undefined behaviour and can crash. Close a DB only after every thread is done with it. A finalizer (a generator's `finally`, `__del__`) that ends a transaction runs on whichever thread triggers gc, so it counts as using the transaction from that thread. gc merely freeing objects on another thread is safe.
+
+## Development
+
+```bash
+# Setup
+make install
+
+# Build
+make build
+
+# Test
+make test
+```
+
+## License
+
+Apache-2.0

{rdbpython-0.2.6 → rdbpython-0.2.7}/pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta"
 # ============================================================================
 [project]
 name = "rdbpython"
-version = "0.2.6"
+version = "0.2.7"
 description = "Python bindings for RocksDB with Cython"
 readme = "README.md"
 license = "Apache-2.0"
@@ -21,12 +21,14 @@ maintainers = [
     {name = "Gor Arakelyan", email = "gorarkln@gmail.com"}
 ]
 keywords = [
+    "nustack",
+    "python",
     "rocksdb",
-    "database",
-    "key-value",
+    "key-value-store",
+    "embedded-database",
+    "transactions",
+    "bindings",
     "storage",
-    "embedded",
-    "cython"
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",
@@ -241,7 +243,7 @@ directory = "tests/reports/coverage"
 # ============================================================================
 [tool.ruff]
 line-length = 100
-target-version = "py312"
+target-version = "py39"
 src = ["src", "tests"]
 extend-exclude = [
     ".venv",
@@ -317,7 +319,7 @@ docstring-code-line-length = 80
 # Type Checking - mypy
 # ============================================================================
 [tool.mypy]
-python_version = "3.12"
+python_version = "3.9"
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = false

{rdbpython-0.2.6 → rdbpython-0.2.7}/scripts/build-rocksdb-linux.sh

@@ -142,6 +142,7 @@ tar xzf "rocksdb-${ROCKSDB_VERSION}.tar.gz"
 cd "rocksdb-${ROCKSDB_VERSION}"
 
 # Apply patch to fix missing <cstdint> include for newer GCC versions
+# (GCC 13+ needs it in more headers; the build also force-includes it below)
 echo "Applying cstdint patch..."
 SCRIPT_DIR="$(dirname "$(readlink -f "${BASH_SOURCE[0]}" 2>/dev/null || realpath "${BASH_SOURCE[0]}" 2>/dev/null || echo "${BASH_SOURCE[0]}")")"
 if [ -f "$SCRIPT_DIR/rocksdb-cstdint.patch" ]; then
@@ -160,7 +161,7 @@ make static_lib shared_lib -j$(nproc) \
     USE_RTTI=1 \
     DISABLE_WARNING_AS_ERROR=1 \
     DEBUG_LEVEL=0 \
-    EXTRA_CXXFLAGS="$CXXFLAGS" \
+    EXTRA_CXXFLAGS="$CXXFLAGS -include cstdint" \
     EXTRA_LDFLAGS="$LDFLAGS"
 
 # Install

{rdbpython-0.2.6 → rdbpython-0.2.7}/src/rdbpy/db.pxd

@@ -113,7 +113,7 @@ cdef extern from "rocksdb/db.h" namespace "rocksdb":
             const options.ReadOptions&,
             ColumnFamilyHandle*) nogil except+
 
-        void NewIterators(
+        Status NewIterators(
             const options.ReadOptions&,
             vector[ColumnFamilyHandle*]&,
             vector[Iterator*]*) nogil except+

{rdbpython-0.2.6 → rdbpython-0.2.7}/src/rdbpy/lib_rocksdb.pxd

@@ -622,6 +622,13 @@ cdef class DB(IDB):
     cdef db.DB* db
     cdef list cf_handles
     cdef list cf_options
+    cdef set _iterators
+    cdef set _snapshots
+    # Used by TransactionDB, declared here so it is still set when
+    # DB.__dealloc__ calls TransactionDB.close() after TransactionDB's own
+    # fields were cleared.
+    cdef set _transactions
+    cdef int _check_open(self) except -1
     # def __cinit__(self, db_name, Options opts, dict column_families = *, read_only=False)
     # def __dealloc__(self)
     cpdef void close(self)
@@ -668,10 +675,14 @@ cdef class TransactionDB(DB):
     cpdef void close(self)
 
 
+@cython.no_gc_clear
 cdef class Transaction(object):
     cdef transaction.Transaction* txn
     cdef TransactionDB db
     cdef bint closed
+    cdef set _iterators
+
+    cdef void _release(self)
 
     cdef void _ensure_open(self)
     cpdef void close(self)
@@ -717,12 +728,16 @@ cdef class Iterator:
     cpdef void skip_back(self)
 
 
+@cython.no_gc_clear
 cdef class BaseIterator(Iterator):
     cdef iterator.Iterator* ptr
     cdef DB db
     cdef ColumnFamilyHandle handle
     cdef object owner
 
+    cdef int _check_valid(self) except -1
+    cdef void _invalidate(self)
+
     # def __cinit__(self, DB db, ColumnFamilyHandle handle = None)
     # def __dealloc__(self)
     # def __iter__(self)