Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions Lib/dbm/sqlite3.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,22 @@ def __init__(self, path, /, *, flag, mode):
# We use the URI format when opening the database.
uri = _normalize_uri(path)
uri = f"{uri}?mode={flag}"
if flag == "ro":
# Add immutable=1 to allow read-only SQLite access even if wal/shm missing
uri += "&immutable=1"
Comment thread
furkanonder marked this conversation as resolved.

try:
self._cx = sqlite3.connect(uri, autocommit=True, uri=True)
except sqlite3.Error as exc:
raise error(str(exc))

# This is an optimization only; it's ok if it fails.
with suppress(sqlite3.OperationalError):
self._cx.execute("PRAGMA journal_mode = wal")
if flag != "ro":
with suppress(sqlite3.OperationalError):
self._cx.execute("PRAGMA journal_mode = OFF")

if flag == "rwc":
self._execute(BUILD_TABLE)
if flag == "rwc":
self._execute(BUILD_TABLE)

def _execute(self, *args, **kwargs):
if not self._cx:
Expand Down
84 changes: 84 additions & 0 deletions Lib/test/test_dbm_sqlite3.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import os
import stat
import sys
import unittest
from contextlib import closing
Expand Down Expand Up @@ -89,6 +91,88 @@ def test_readonly_keys(self):
def test_readonly_iter(self):
self.assertEqual([k for k in self.db], [b"key1", b"key2"])

class Immutable(unittest.TestCase):
def setUp(self):
self.filename = os_helper.TESTFN

db = dbm_sqlite3.open(self.filename, "c")
db[b"key"] = b"value"
db.close()

self.db = dbm_sqlite3.open(self.filename, "r")

def tearDown(self):
self.db.close()
for suffix in "", "-wal", "-shm":
os_helper.unlink(self.filename + suffix)

def test_readonly_open_without_wal_shm(self):
wal_path = self.filename + "-wal"
Comment thread
furkanonder marked this conversation as resolved.
Outdated
shm_path = self.filename + "-shm"
Comment thread
furkanonder marked this conversation as resolved.
Outdated

self.assertFalse(os.path.exists(wal_path))
self.assertFalse(os.path.exists(shm_path))

self.assertEqual(self.db[b"key"], b"value")


class ReadOnlyFilesystem(unittest.TestCase):

def setUp(self):
self.test_dir = os_helper.TESTFN
os.mkdir(self.test_dir)
self.db_path = os.path.join(self.test_dir, "test.db")

db = dbm_sqlite3.open(self.db_path, "c")
db[b"key"] = b"value"
db.close()

def tearDown(self):
os.chmod(self.db_path, stat.S_IWRITE)
os.chmod(self.test_dir, stat.S_IWRITE | stat.S_IEXEC | stat.S_IREAD)
os_helper.rmtree(self.test_dir)

def test_open_readonly_dir_success_ro(self):
Comment thread
GeneralK1ng marked this conversation as resolved.
Outdated
files = os.listdir(self.test_dir)
self.assertEqual(sorted(files), ["test.db"])

os.chmod(self.test_dir, stat.S_IREAD | stat.S_IEXEC)
with dbm_sqlite3.open(self.db_path, "r") as db:
self.assertEqual(db[b"key"], b"value")

def test_open_readonly_file_success(self):
Comment thread
GeneralK1ng marked this conversation as resolved.
Outdated
os.chmod(self.db_path, stat.S_IREAD)
with dbm_sqlite3.open(self.db_path, "r") as db:
self.assertEqual(db[b"key"], b"value")

def test_open_readonly_file_fail_rw(self):
Comment thread
GeneralK1ng marked this conversation as resolved.
Outdated
os.chmod(self.db_path, stat.S_IREAD)
with dbm_sqlite3.open(self.db_path, "w") as db:
with self.assertRaises(OSError):
db[b"newkey"] = b"newvalue"
Comment thread
furkanonder marked this conversation as resolved.
@unittest.skipUnless(sys.platform == "darwin", "SQLite fallback behavior differs on non-macOS")
def test_open_readonly_dir_fail_rw_missing_wal_shm(self):
for suffix in ("-wal", "-shm"):
os_helper.unlink(self.db_path + suffix)

os.chmod(self.test_dir, stat.S_IREAD | stat.S_IEXEC)

with self.assertRaises(OSError):
with dbm_sqlite3.open(self.db_path, "w") as db:
db[b"newkey"] = b"newvalue"

Comment thread
GeneralK1ng marked this conversation as resolved.
Outdated
@unittest.skipUnless(sys.platform == "darwin", "SQLite fallback behavior differs on non-macOS")
def test_open_readonly_dir_fail_rw_with_writable_db(self):
os.chmod(self.db_path, stat.S_IREAD | stat.S_IWRITE)
for suffix in ("-wal", "-shm"):
os_helper.unlink(self.db_path + suffix)

os.chmod(self.test_dir, stat.S_IREAD | stat.S_IEXEC)

with self.assertRaises(OSError):
with dbm_sqlite3.open(self.db_path, "w") as db:
db[b"newkey"] = b"newvalue"


class ReadWrite(_SQLiteDbmTests):

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix :exc:`sqlite3.OperationalError` error when using :func:`dbm.open` with a read-only file object.
Loading