API fix: with_query_tag()/without_query_tag() (#555)

Author: fantix

gel/options.py

@@ -13,6 +13,7 @@
 
 
 _RetryRule = namedtuple("_RetryRule", ["attempts", "backoff"])
+TAG_NAME = "tag"
 
 
 def default_backoff(attempt):
@@ -414,17 +415,25 @@ def without_globals(self, *global_names):
         )
         return result
 
-    def with_annotation(self, name: str, value: str):
+    def with_query_tag(self, tag: str):
+        for prefix in ["edgedb/", "gel/"]:
+            if tag.startswith(prefix):
+                raise errors.InvalidArgumentError(f"reserved tag: {prefix}*")
+        if len(tag) > 128:
+            raise errors.InvalidArgumentError(
+                "tag too long (> 128 characters)"
+            )
+
         result = self._shallow_clone()
         result._options = self._options.with_annotations(
-            self._options.annotations | {name: value}
+            self._options.annotations | {TAG_NAME: tag}
         )
         return result
 
-    def without_annotation(self, name: str):
+    def without_query_tag(self):
         result = self._shallow_clone()
         annotations = self._options.annotations.copy()
-        annotations.pop(name, None)
+        annotations.pop(TAG_NAME, None)
         result._options = self._options.with_annotations(annotations)
         return result