Implement SQL interface.
When qutebrowser starts, it creates an in-memory sqlite database. One can instantiate a SqlTable to create a new table in the database. The object provides an interface to query and modify the table. This intended to serve as the base class for the quickmark, bookmark, and history manager objects in objreg. Instead of reading their data into an in-memory dict, they will read into an in-memory sql table. Eventually the completion models for history, bookmarks, and quickmarks can be replaced with SqlQuery models for faster creation and filtering. See #1765.
This commit is contained in:
Ryan Roden-Corrent
parent
3b30b42211
commit
f43f78c40f
@ -53,7 +53,7 @@ from qutebrowser.browser.webkit.network import networkmanager
|
||||
from qutebrowser.keyinput import macros
|
||||
from qutebrowser.mainwindow import mainwindow, prompt
|
||||
from qutebrowser.misc import (readline, ipc, savemanager, sessions,
|
||||
crashsignal, earlyinit, objects)
|
||||
crashsignal, earlyinit, objects, sql)
|
||||
from qutebrowser.misc import utilcmds # pylint: disable=unused-import
|
||||
from qutebrowser.utils import (log, version, message, utils, qtutils, urlutils,
|
||||
objreg, usertypes, standarddir, error, debug)
|
||||
@ -423,6 +423,9 @@ def _init_modules(args, crash_handler):
|
||||
config.init(qApp)
|
||||
save_manager.init_autosave()
|
||||
|
||||
log.init.debug("Initializing sql...")
|
||||
sql.init()
|
||||
|
||||
log.init.debug("Initializing web history...")
|
||||
history.init(qApp)
|
||||
|
||||
|
||||
166
qutebrowser/misc/sql.py
Normal file
166
qutebrowser/misc/sql.py
Normal file
@ -0,0 +1,166 @@
|
||||
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
|
||||
|
||||
# Copyright 2016 Ryan Roden-Corrent (rcorre) <ryan@rcorre.net>
|
||||
#
|
||||
# This file is part of qutebrowser.
|
||||
#
|
||||
# qutebrowser is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# qutebrowser is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with qutebrowser. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
"""Provides access to an in-memory sqlite database."""
|
||||
|
||||
from PyQt5.QtCore import QObject, pyqtSignal
|
||||
from PyQt5.QtSql import QSqlDatabase, QSqlQuery
|
||||
|
||||
from qutebrowser.utils import log
|
||||
|
||||
|
||||
def init():
|
||||
"""Initialize the SQL database connection."""
|
||||
database = QSqlDatabase.addDatabase('QSQLITE')
|
||||
# In-memory database, see https://sqlite.org/inmemorydb.html
|
||||
database.setDatabaseName(':memory:')
|
||||
if not database.open():
|
||||
raise SqlException("Failed to open in-memory sqlite database")
|
||||
|
||||
|
||||
def close():
|
||||
"""Close the SQL connection."""
|
||||
QSqlDatabase.removeDatabase(QSqlDatabase.database().connectionName())
|
||||
|
||||
|
||||
def _run_query(querystr, *values):
|
||||
"""Run the given SQL query string on the database.
|
||||
|
||||
Args:
|
||||
values: positional parameter bindings.
|
||||
"""
|
||||
log.completion.debug('Running SQL query: "{}"'.format(querystr))
|
||||
database = QSqlDatabase.database()
|
||||
query = QSqlQuery(database)
|
||||
query.prepare(querystr)
|
||||
for val in values:
|
||||
query.addBindValue(val)
|
||||
log.completion.debug('Query bindings: {}'.format(query.boundValues()))
|
||||
if not query.exec_():
|
||||
raise SqlException('Failed to exec query "{}": "{}"'.format(
|
||||
querystr, query.lastError().text()))
|
||||
return query
|
||||
|
||||
|
||||
class SqlTable(QObject):
|
||||
|
||||
"""Interface to a sql table.
|
||||
|
||||
Attributes:
|
||||
_name: Name of the SQL table this wraps.
|
||||
_primary_key: The primary key of the table.
|
||||
|
||||
Signals:
|
||||
changed: Emitted when the table is modified.
|
||||
"""
|
||||
|
||||
changed = pyqtSignal()
|
||||
|
||||
def __init__(self, name, fields, primary_key, parent=None):
|
||||
"""Create a new table in the sql database.
|
||||
|
||||
Raises SqlException if the table already exists.
|
||||
|
||||
Args:
|
||||
name: Name of the table.
|
||||
fields: A list of field names.
|
||||
primary_key: Name of the field to serve as the primary key.
|
||||
"""
|
||||
super().__init__(parent)
|
||||
self._name = name
|
||||
self._primary_key = primary_key
|
||||
_run_query("CREATE TABLE {} ({}, PRIMARY KEY ({}))"
|
||||
.format(name, ','.join(fields), primary_key))
|
||||
|
||||
def __iter__(self):
|
||||
"""Iterate rows in the table."""
|
||||
result = _run_query("SELECT * FROM {}".format(self._name))
|
||||
while result.next():
|
||||
rec = result.record()
|
||||
yield tuple(rec.value(i) for i in range(rec.count()))
|
||||
|
||||
def __contains__(self, key):
|
||||
"""Return whether the table contains the matching item.
|
||||
|
||||
Args:
|
||||
key: Primary key value to search for.
|
||||
"""
|
||||
query = _run_query("SELECT * FROM {} where {} = ?"
|
||||
.format(self._name, self._primary_key), key)
|
||||
return query.next()
|
||||
|
||||
def __len__(self):
|
||||
"""Return the count of rows in the table."""
|
||||
result = _run_query("SELECT count(*) FROM {}".format(self._name))
|
||||
result.next()
|
||||
return result.value(0)
|
||||
|
||||
def __getitem__(self, key):
|
||||
"""Retrieve the row matching the given key.
|
||||
|
||||
Args:
|
||||
key: Primary key value to fetch.
|
||||
"""
|
||||
result = _run_query("SELECT * FROM {} where {} = ?"
|
||||
.format(self._name, self._primary_key), key)
|
||||
result.next()
|
||||
rec = result.record()
|
||||
return tuple(rec.value(i) for i in range(rec.count()))
|
||||
|
||||
def delete(self, value, field=None):
|
||||
"""Remove all rows for which `field` equals `value`.
|
||||
|
||||
Args:
|
||||
value: Key value to delete.
|
||||
field: Field to use as the key, defaults to the primary key.
|
||||
|
||||
Return:
|
||||
The number of rows deleted.
|
||||
"""
|
||||
field = field or self._primary_key
|
||||
query = _run_query("DELETE FROM {} where {} = ?"
|
||||
.format(self._name, field), value)
|
||||
if not query.numRowsAffected():
|
||||
raise KeyError('No row with {} = "{}"'.format(field, value))
|
||||
self.changed.emit()
|
||||
|
||||
def insert(self, *values, replace=False):
|
||||
"""Append a row to the table.
|
||||
|
||||
Args:
|
||||
values: Values in the order fields were given on table creation.
|
||||
replace: If true, allow inserting over an existing primary key.
|
||||
"""
|
||||
cmd = "REPLACE" if replace else "INSERT"
|
||||
paramstr = ','.join(['?'] * len(values))
|
||||
_run_query("{} INTO {} values({})"
|
||||
.format(cmd, self._name, paramstr), *values)
|
||||
self.changed.emit()
|
||||
|
||||
def delete_all(self):
|
||||
"""Remove all row from the table."""
|
||||
_run_query("DELETE FROM {}".format(self._name))
|
||||
self.changed.emit()
|
||||
|
||||
|
||||
class SqlException(Exception):
|
||||
|
||||
"""Raised on an error interacting with the SQL database."""
|
||||
|
||||
pass
|
||||
126
tests/unit/misc/test_sql.py
Normal file
126
tests/unit/misc/test_sql.py
Normal file
@ -0,0 +1,126 @@
|
||||
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
|
||||
|
||||
# Copyright 2016 Ryan Roden-Corrent (rcorre) <ryan@rcorre.net>
|
||||
#
|
||||
# This file is part of qutebrowser.
|
||||
#
|
||||
# qutebrowser is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# qutebrowser is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with qutebrowser. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
"""Test the SQL API."""
|
||||
|
||||
import pytest
|
||||
from qutebrowser.misc import sql
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def init():
|
||||
sql.init()
|
||||
yield
|
||||
sql.close()
|
||||
|
||||
|
||||
def test_init():
|
||||
sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
with pytest.raises(sql.SqlException):
|
||||
# table name collision on 'Foo'
|
||||
sql.SqlTable('Foo', ['foo', 'bar'], primary_key='foo')
|
||||
|
||||
|
||||
def test_insert(qtbot):
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
with qtbot.waitSignal(table.changed):
|
||||
table.insert('one', 1, False)
|
||||
with qtbot.waitSignal(table.changed):
|
||||
table.insert('wan', 1, False)
|
||||
with pytest.raises(sql.SqlException):
|
||||
# duplicate primary key
|
||||
table.insert('one', 1, False)
|
||||
|
||||
|
||||
def test_iter():
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
table.insert('one', 1, False)
|
||||
table.insert('nine', 9, False)
|
||||
table.insert('thirteen', 13, True)
|
||||
assert list(table) == [('one', 1, False),
|
||||
('nine', 9, False),
|
||||
('thirteen', 13, True)]
|
||||
|
||||
|
||||
def test_replace(qtbot):
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
table.insert('one', 1, False)
|
||||
with qtbot.waitSignal(table.changed):
|
||||
table.insert('one', 1, True, replace=True)
|
||||
assert list(table) == [('one', 1, True)]
|
||||
|
||||
|
||||
def test_delete(qtbot):
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
table.insert('one', 1, False)
|
||||
table.insert('nine', 9, False)
|
||||
table.insert('thirteen', 13, True)
|
||||
with pytest.raises(KeyError):
|
||||
table.delete('nope')
|
||||
with qtbot.waitSignal(table.changed):
|
||||
table.delete('thirteen')
|
||||
assert list(table) == [('one', 1, False), ('nine', 9, False)]
|
||||
with qtbot.waitSignal(table.changed):
|
||||
table.delete(False, field='lucky')
|
||||
assert not list(table) == [('thirteen', 13, True)]
|
||||
|
||||
|
||||
def test_len():
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
assert len(table) == 0
|
||||
table.insert('one', 1, False)
|
||||
assert len(table) == 1
|
||||
table.insert('nine', 9, False)
|
||||
assert len(table) == 2
|
||||
table.insert('thirteen', 13, True)
|
||||
assert len(table) == 3
|
||||
|
||||
|
||||
def test_contains():
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
table.insert('one', 1, False)
|
||||
table.insert('nine', 9, False)
|
||||
table.insert('thirteen', 13, True)
|
||||
assert 'oone' not in table
|
||||
assert 'ninee' not in table
|
||||
assert 1 not in table
|
||||
assert '*' not in table
|
||||
assert 'one' in table
|
||||
assert 'nine' in table
|
||||
assert 'thirteen' in table
|
||||
|
||||
|
||||
def test_index():
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
table.insert('one', 1, False)
|
||||
table.insert('nine', 9, False)
|
||||
table.insert('thirteen', 13, True)
|
||||
assert table['one'] == ('one', 1, False)
|
||||
assert table['nine'] == ('nine', 9, False)
|
||||
assert table['thirteen'] == ('thirteen', 13, True)
|
||||
|
||||
|
||||
def test_delete_all(qtbot):
|
||||
table = sql.SqlTable('Foo', ['name', 'val', 'lucky'], primary_key='name')
|
||||
table.insert('one', 1, False)
|
||||
table.insert('nine', 9, False)
|
||||
table.insert('thirteen', 13, True)
|
||||
with qtbot.waitSignal(table.changed):
|
||||
table.delete_all()
|
||||
assert list(table) == []
|
||||
Loading…
Reference in New Issue
Block a user