From: Raymond Hettinger <python@rcn.com>
Date: Thu, 11 Jun 2009 22:04:00 +0000 (+0000)
Subject: Add example of how to do key lookups with bisect().
X-Git-Tag: v2.7a1~976
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=87be88c2e96c8e65eed703b2445c1fba169cdba2;p=python

Add example of how to do key lookups with bisect().
---

diff --git a/Doc/library/bisect.rst b/Doc/library/bisect.rst
index 93391c3b72..9364ed8287 100644
--- a/Doc/library/bisect.rst
+++ b/Doc/library/bisect.rst
@@ -85,4 +85,22 @@ is a 'B', etc.
    >>> map(grade, [33, 99, 77, 44, 12, 88])
    ['E', 'A', 'B', 'D', 'F', 'A']
 
-
+Unlike the :func:`sorted` function, it does not make sense for the :func:`bisect`
+functions to have *key* or *reversed* arguments because that would lead to an
+inefficent design (successive calls to bisect functions would not "remember"
+all of the previous key lookups).
+
+Instead, it is better to search a list of precomputed keys to find the index
+of the record in question::
+
+    >>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
+    >>> data.sort(key=lambda r: r[1])       # precomputed list of keys
+    >>> keys = [r[1] for r in data]
+    >>> data[bisect_left(keys, 0)]
+    ('black', 0)
+    >>> data[bisect_left(keys, 1)]
+    ('blue', 1)
+    >>> data[bisect_left(keys, 5)]
+    ('red', 5)
+    >>> data[bisect_left(keys, 8)]
+    ('yellow', 8)