Feature add query command (#970)

* Added query_command and example

* Refactored QUERY_OPTIONS, added query_command, refactored verbose, #930, #931

* Added query options to debug-dump, #966

* Refactored query, #602

* Added precedence test for --load-config

* Refactored handling of query options

* Refactored export_photo

* Removed extraneous print

* Updated API_README

* Updated examples
This commit is contained in:
Rhet Turnbull
2023-02-05 14:48:42 -08:00
committed by GitHub
parent 0f1866e39d
commit 007f0e0960
42 changed files with 2322 additions and 1334 deletions

View File

@@ -8,7 +8,7 @@ from typing import Any
import pytest
import osxphotos.sqlitekvstore
from osxphotos.sqlitekvstore import SQLiteKVStore
def pickle_and_zip(data: Any) -> bytes:
@@ -41,7 +41,7 @@ def unzip_and_unpickle(data: bytes) -> Any:
def test_basic_get_set(tmpdir):
"""Test basic functionality"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath)
kvstore = SQLiteKVStore(dbpath)
kvstore.set("foo", "bar")
assert kvstore.get("foo") == "bar"
assert kvstore.get("FOOBAR") is None
@@ -61,7 +61,7 @@ def test_basic_get_set(tmpdir):
def test_basic_get_set_wal(tmpdir):
"""Test basic functionality with WAL mode"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath, wal=True)
kvstore = SQLiteKVStore(dbpath, wal=True)
kvstore.set("foo", "bar")
assert kvstore.get("foo") == "bar"
assert kvstore.get("FOOBAR") is None
@@ -84,14 +84,14 @@ def test_set_many(tmpdir):
"""Test set_many()"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath)
kvstore = SQLiteKVStore(dbpath)
kvstore.set_many([("foo", "bar"), ("baz", "qux")])
assert kvstore.get("foo") == "bar"
assert kvstore.get("baz") == "qux"
kvstore.close()
# make sure values got committed
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath)
kvstore = SQLiteKVStore(dbpath)
assert kvstore.get("foo") == "bar"
assert kvstore.get("baz") == "qux"
kvstore.close()
@@ -101,14 +101,14 @@ def test_set_many_dict(tmpdir):
"""Test set_many() with dict of values"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath)
kvstore = SQLiteKVStore(dbpath)
kvstore.set_many({"foo": "bar", "baz": "qux"})
assert kvstore.get("foo") == "bar"
assert kvstore.get("baz") == "qux"
kvstore.close()
# make sure values got committed
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath)
kvstore = SQLiteKVStore(dbpath)
assert kvstore.get("foo") == "bar"
assert kvstore.get("baz") == "qux"
kvstore.close()
@@ -118,7 +118,7 @@ def test_basic_context_handler(tmpdir):
"""Test basic functionality with context handler"""
dbpath = tmpdir / "kvtest.db"
with osxphotos.sqlitekvstore.SQLiteKVStore(dbpath) as kvstore:
with SQLiteKVStore(dbpath) as kvstore:
kvstore.set("foo", "bar")
assert kvstore.get("foo") == "bar"
assert kvstore.get("FOOBAR") is None
@@ -134,7 +134,7 @@ def test_basic_context_handler(tmpdir):
def test_about(tmpdir):
"""Test about property"""
dbpath = tmpdir / "kvtest.db"
with osxphotos.sqlitekvstore.SQLiteKVStore(dbpath) as kvstore:
with SQLiteKVStore(dbpath) as kvstore:
kvstore.about = "My description"
assert kvstore.about == "My description"
kvstore.about = "My new description"
@@ -144,17 +144,17 @@ def test_about(tmpdir):
def test_existing_db(tmpdir):
"""Test that opening an existing database works as expected"""
dbpath = tmpdir / "kvtest.db"
with osxphotos.sqlitekvstore.SQLiteKVStore(dbpath) as kvstore:
with SQLiteKVStore(dbpath) as kvstore:
kvstore.set("foo", "bar")
with osxphotos.sqlitekvstore.SQLiteKVStore(dbpath) as kvstore:
with SQLiteKVStore(dbpath) as kvstore:
assert kvstore.get("foo") == "bar"
def test_dict_interface(tmpdir):
""" "Test dict interface"""
dbpath = tmpdir / "kvtest.db"
with osxphotos.sqlitekvstore.SQLiteKVStore(dbpath) as kvstore:
with SQLiteKVStore(dbpath) as kvstore:
kvstore["foo"] = "bar"
assert kvstore["foo"] == "bar"
assert len(kvstore) == 1
@@ -186,9 +186,7 @@ def test_dict_interface(tmpdir):
def test_serialize_deserialize(tmpdir):
"""Test serialize/deserialize"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(
dbpath, serialize=json.dumps, deserialize=json.loads
)
kvstore = SQLiteKVStore(dbpath, serialize=json.dumps, deserialize=json.loads)
kvstore.set("foo", {"bar": "baz"})
assert kvstore.get("foo") == {"bar": "baz"}
assert kvstore.get("FOOBAR") is None
@@ -197,7 +195,7 @@ def test_serialize_deserialize(tmpdir):
def test_serialize_deserialize_binary_data(tmpdir):
"""Test serialize/deserialize with binary data"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(
kvstore = SQLiteKVStore(
dbpath, serialize=pickle_and_zip, deserialize=unzip_and_unpickle
)
kvstore.set("foo", {"bar": "baz"})
@@ -209,16 +207,16 @@ def test_serialize_deserialize_bad_callable(tmpdir):
"""Test serialize/deserialize with bad values"""
dbpath = tmpdir / "kvtest.db"
with pytest.raises(TypeError):
osxphotos.sqlitekvstore.SQLiteKVStore(dbpath, serialize=1, deserialize=None)
SQLiteKVStore(dbpath, serialize=1, deserialize=None)
with pytest.raises(TypeError):
osxphotos.sqlitekvstore.SQLiteKVStore(dbpath, serialize=None, deserialize=1)
SQLiteKVStore(dbpath, serialize=None, deserialize=1)
def test_iter(tmpdir):
"""Test generator behavior"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath)
kvstore = SQLiteKVStore(dbpath)
kvstore.set("foo", "bar")
kvstore.set("baz", "qux")
kvstore.set("quux", "corge")
@@ -230,7 +228,7 @@ def test_iter(tmpdir):
def test_keys_values_items(tmpdir):
"""Test keys, values, items"""
dbpath = tmpdir / "kvtest.db"
kvstore = osxphotos.sqlitekvstore.SQLiteKVStore(dbpath)
kvstore = SQLiteKVStore(dbpath)
kvstore.set("foo", "bar")
kvstore.set("baz", "qux")
kvstore.set("quux", "corge")
@@ -243,3 +241,26 @@ def test_keys_values_items(tmpdir):
("grault", "garply"),
("quux", "corge"),
]
def test_path(tmpdir):
"""Test path property"""
dbpath = tmpdir / "kvtest.db"
kvstore = SQLiteKVStore(dbpath)
assert kvstore.path == dbpath
def test_wipe(tmpdir):
"""Test wipe"""
dbpath = tmpdir / "kvtest.db"
kvstore = SQLiteKVStore(dbpath)
kvstore.set("foo", "bar")
kvstore.set("baz", "qux")
kvstore.set("quux", "corge")
kvstore.set("grault", "garply")
assert len(kvstore) == 4
kvstore.wipe()
assert len(kvstore) == 0
assert "foo"
kvstore.set("foo", "bar")
assert kvstore.get("foo") == "bar"