Automatically determine whether to suggest options

dstansby · dstansby · commit 91520390942f · 2025-06-01T10:14:09.000+01:00
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -741,7 +741,7 @@ def __setitem__(self, key, val):
                 and "backend" in self):
             return
         valid_key = _api.check_getitem(
-            self.validate, rcParam=key, _suggest_close_matches=True, _error_cls=KeyError
+            self.validate, rcParam=key, _error_cls=KeyError
         )
         try:
             cval = valid_key(val)
diff --git a/lib/matplotlib/_api/__init__.py b/lib/matplotlib/_api/__init__.py
@@ -176,7 +176,7 @@ def check_shape(shape, /, **kwargs):
 
 
 def check_getitem(
-        mapping, /, _suggest_close_matches=False, _error_cls=ValueError, **kwargs
+        mapping, /, _error_cls=ValueError, **kwargs
     ):
     """
     *kwargs* must consist of a single *key, value* pair.  If *key* is in
@@ -185,8 +185,6 @@ def check_getitem(
 
     Parameters
     ----------
-    _suggest_close_matches :
-        If True, suggest only close matches instead of all valid values.
     _error_cls :
         Class of error to raise.
 
@@ -200,7 +198,7 @@ def check_getitem(
     try:
         return mapping[v]
     except KeyError:
-        if _suggest_close_matches:
+        if len(mapping) > 5:
             if len(best := difflib.get_close_matches(v, mapping.keys(), cutoff=0.5)):
                 suggestion = f"Did you mean one of {best}?"
             else:
diff --git a/lib/matplotlib/_api/__init__.pyi b/lib/matplotlib/_api/__init__.pyi
@@ -43,7 +43,7 @@ def check_in_list(
 ) -> None: ...
 def check_shape(shape: tuple[int | None, ...], /, **kwargs: NDArray) -> None: ...
 def check_getitem(
-        mapping: Mapping[Any, _T], /, _suggest_close_matches: bool, _error_cls: Type[Exception], **kwargs: Any
+        mapping: Mapping[Any, _T], /, _error_cls: Type[Exception], **kwargs: Any
 ) -> _T: ...
 def caching_module_getattr(cls: type) -> Callable[[str], Any]: ...
 @overload
diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py
@@ -93,7 +93,7 @@ def __init__(self, cmaps):
 
     def __getitem__(self, item):
         cmap = _api.check_getitem(
-            self._cmaps, colormap=item, _suggest_close_matches=True, _error_cls=KeyError
+            self._cmaps, colormap=item, _error_cls=KeyError
         )
         return cmap.copy()
 

Original file line number	Diff line number	Diff line change
`@@ -741,7 +741,7 @@ def __setitem__(self, key, val):`
`741`	`741`	`and "backend" in self):`
`742`	`742`	`return`
`743`	`743`	`valid_key = _api.check_getitem(`
`744`		`- self.validate, rcParam=key, _suggest_close_matches=True, _error_cls=KeyError`
	`744`	`+ self.validate, rcParam=key, _error_cls=KeyError`
`745`	`745`	`)`
`746`	`746`	`try:`
`747`	`747`	`cval = valid_key(val)`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ def __init__(self, cmaps):`
`93`	`93`
`94`	`94`	`def __getitem__(self, item):`
`95`	`95`	`cmap = _api.check_getitem(`
`96`		`- self._cmaps, colormap=item, _suggest_close_matches=True, _error_cls=KeyError`
	`96`	`+ self._cmaps, colormap=item, _error_cls=KeyError`
`97`	`97`	`)`
`98`	`98`	`return cmap.copy()`
`99`	`99`