Skip to content

Commit

Permalink
More storage/search protocol "unstable" notes. #325
Browse files Browse the repository at this point in the history
  • Loading branch information
lemon24 authored Nov 7, 2023
1 parent d511f61 commit fe442c2
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/reader/_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit fe442c2

Please sign in to comment.