From c66ad4e136f84f50b6b9e80aed6f2af4f2104367 Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Tue, 2 Mar 2021 10:50:13 +0000
Subject: [PATCH] ENH: etag property for the query
---
CHANGELOG.md | 3 +++
src/caosdb/common/models.py | 3 +++
unittests/test_query.py | 7 +++++--
3 files changed, 11 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7e190313..6defee79 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added ###
+* `etag` property for the `caosdb.Query` class. The etag allows to debug the
+ caching and to decide whether the server has changed between queries.
+
### Changed ###
### Deprecated ###
diff --git a/src/caosdb/common/models.py b/src/caosdb/common/models.py
index 9592e484..d8f42a3f 100644
--- a/src/caosdb/common/models.py
+++ b/src/caosdb/common/models.py
@@ -3661,6 +3661,7 @@ class Query():
self.flags = dict()
self.messages = _Messages()
self.cached = None
+ self.etag = None
if isinstance(q, etree._Element):
self.q = q.get("string")
@@ -3670,6 +3671,7 @@ class Query():
self.cached = False
else:
self.cached = q.get("cached").lower() == "true"
+ self.etag = q.get("etag")
for m in q:
if m.tag.lower() == 'warning' or m.tag.lower() == 'error':
@@ -3714,6 +3716,7 @@ class Query():
cresp = Container._response_to_entities(http_response)
self.results = cresp.query.results
self.cached = cresp.query.cached
+ self.etag = cresp.query.etag
if self.q.lower().startswith('count') and len(cresp) == 0:
# this was a count query
diff --git a/unittests/test_query.py b/unittests/test_query.py
index f4b3ee97..12622ea4 100644
--- a/unittests/test_query.py
+++ b/unittests/test_query.py
@@ -26,20 +26,23 @@ import caosdb as db
def test_query_parsing():
- s = '<Query string="FIND bla" results="0" cached="true"/>'
+ s = '<Query string="FIND bla" results="0" cached="true" etag="asdf"/>'
q = db.Query(etree.fromstring(s))
assert q.q == "FIND bla"
assert q.results == 0
assert q.cached is True
+ assert q.etag == "asdf"
- s = '<Query string="COUNT bla" results="1" cached="false"/>'
+ s = '<Query string="COUNT bla" results="1" cached="false" etag="asdf"/>'
q = db.Query(etree.fromstring(s))
assert q.q == "COUNT bla"
assert q.results == 1
assert q.cached is False
+ assert q.etag == "asdf"
s = '<Query string="COUNT blub" results="4"/>'
q = db.Query(etree.fromstring(s))
assert q.q == "COUNT blub"
assert q.results == 4
assert q.cached is False
+ assert q.etag is None
--
GitLab