From fe442c22c93f532940b2da957c85e69e83983c8a Mon Sep 17 00:00:00 2001 From: lemon24 Date: Wed, 8 Nov 2023 00:51:27 +0200 Subject: [PATCH] More storage/search protocol "unstable" notes. #325 --- src/reader/_types.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/reader/_types.py b/src/reader/_types.py index dd38cdb2..4a64b7f5 100644 --- a/src/reader/_types.py +++ b/src/reader/_types.py @@ -937,6 +937,11 @@ def get_tags( A dedicated ``get_tag_keys()`` method will be added in the future. + .. admonition:: Unstable + + Both this method and ``get_tag_keys()`` will allow filtering by prefix (include/exclude), + both case sensitive and case insensitive; implementations should allow for this. + Args: resource_id key @@ -1104,6 +1109,12 @@ class SearchType(Protocol): # pragma: no cover read-only methods :meth:`search_entries` :meth:`search_entry_counts` + .. admonition:: Unstable + + In the future, search may receive object lifecycle methods (context manager + ``close()``), + to support implementations that do not share state with the storage. + If you need support for this, please open a issue. + """ def enable(self) -> None: