msiemens / tinydb / 31250452926

98%

push

github

docs: document that search() results share structure with the query cache (#617)

* docs: document that search() results share structure with the query cache

Table.search() results are read from and written to the internal
cache as a shallow list copy, so a returned document is the same
object the cache holds. Mutating one (a key or a nested value)
corrupts what a later identical search returns.

#516 asked for a fix rather than a doc note; per the discussion
there, a deep copy costs 150-4000x on the read hot path, so this
documents the caveat instead.

Fixes #516

* docs: note in usage.rst that cached search results share document objects

161 of 174 branches covered (92.53%)

Branch coverage included in aggregate %.

637 of 641 relevant lines covered (99.38%)

11.52 hits per line