mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-01 06:11:43 +00:00
349f93389e
## Summary This change resolves #15814 to ensure that `SIM401` is only triggered on known dictionary types. Before, the rule was getting triggered even on types that _resemble_ a dictionary but are not actually a dictionary. I did this using the `is_known_to_be_of_type_dict(...)` functionality. The logic for this function was duplicated in a few spots, so I moved the code to a central location, removed redundant definitions, and updated existing calls to use the single definition of the function! ## Test Plan Since this PR only modifies an existing rule, I made changes to the existing test instead of adding new ones. I made sure that `SIM401` is triggered on types that are clearly dictionaries and that it's not triggered on a simple custom dictionary-like type (using a modified version of [the code in the issue](#15814)) The additional changes to de-duplicate `is_known_to_be_of_type_dict` don't break any existing tests -- I think this should be fine since the logic remains the same (please let me know if you think otherwise, I'm excited to get feedback and work towards a good fix 🙂). --------- Co-authored-by: Junhson Jean-Baptiste <junhsonjb@naan.mynetworksettings.com> Co-authored-by: Micha Reiser <micha@reiser.io>
155 lines
2.7 KiB
Python
155 lines
2.7 KiB
Python
###
|
||
# Positive cases
|
||
###
|
||
|
||
a_dict = {}
|
||
|
||
# SIM401 (pattern-1)
|
||
if key in a_dict:
|
||
var = a_dict[key]
|
||
else:
|
||
var = "default1"
|
||
|
||
# SIM401 (pattern-2)
|
||
if key not in a_dict:
|
||
var = "default2"
|
||
else:
|
||
var = a_dict[key]
|
||
|
||
# OK (default contains effect)
|
||
if key in a_dict:
|
||
var = a_dict[key]
|
||
else:
|
||
var = val1 + val2
|
||
|
||
# SIM401 (complex expression in key)
|
||
if keys[idx] in a_dict:
|
||
var = a_dict[keys[idx]]
|
||
else:
|
||
var = "default"
|
||
|
||
dicts = {"key": a_dict}
|
||
|
||
# SIM401 (complex expression in dict)
|
||
if key in dicts[idx]:
|
||
var = dicts[idx][key]
|
||
else:
|
||
var = "default"
|
||
|
||
# SIM401 (complex expression in var)
|
||
if key in a_dict:
|
||
vars[idx] = a_dict[key]
|
||
else:
|
||
vars[idx] = "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789"
|
||
|
||
# SIM401
|
||
if foo():
|
||
pass
|
||
else:
|
||
if key in a_dict:
|
||
vars[idx] = a_dict[key]
|
||
else:
|
||
vars[idx] = "default"
|
||
|
||
###
|
||
# Negative cases
|
||
###
|
||
|
||
# OK (too long)
|
||
if key in a_dict:
|
||
vars[idx] = a_dict[key]
|
||
else:
|
||
vars[idx] = "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß"
|
||
|
||
# OK (false negative)
|
||
if not key in a_dict:
|
||
var = "default"
|
||
else:
|
||
var = a_dict[key]
|
||
|
||
# OK (different dict)
|
||
if key in a_dict:
|
||
var = other_dict[key]
|
||
else:
|
||
var = "default"
|
||
|
||
# OK (different key)
|
||
if key in a_dict:
|
||
var = a_dict[other_key]
|
||
else:
|
||
var = "default"
|
||
|
||
# OK (different var)
|
||
if key in a_dict:
|
||
var = a_dict[key]
|
||
else:
|
||
other_var = "default"
|
||
|
||
# OK (extra vars in body)
|
||
if key in a_dict:
|
||
var = a_dict[key]
|
||
var2 = value2
|
||
else:
|
||
var = "default"
|
||
|
||
# OK (extra vars in orelse)
|
||
if key in a_dict:
|
||
var = a_dict[key]
|
||
else:
|
||
var2 = value2
|
||
var = "default"
|
||
|
||
# OK (complex default value)
|
||
if key in a_dict:
|
||
var = a_dict[key]
|
||
else:
|
||
var = foo()
|
||
|
||
# OK (complex default value)
|
||
if key in a_dict:
|
||
var = a_dict[key]
|
||
else:
|
||
var = a_dict["fallback"]
|
||
|
||
# OK (false negative for elif)
|
||
if foo():
|
||
pass
|
||
elif key in a_dict:
|
||
vars[idx] = a_dict[key]
|
||
else:
|
||
vars[idx] = "default"
|
||
|
||
class NotADictionary:
|
||
def __init__(self):
|
||
self._dict = {}
|
||
|
||
def __getitem__(self, key):
|
||
return self._dict[key]
|
||
|
||
def __setitem__(self, key, value):
|
||
self._dict[key] = value
|
||
|
||
def __iter__(self):
|
||
return self._dict.__iter__()
|
||
|
||
not_dict = NotADictionary()
|
||
not_dict["key"] = "value"
|
||
|
||
# OK (type `NotADictionary` is not a known dictionary type)
|
||
if "key" in not_dict:
|
||
value = not_dict["key"]
|
||
else:
|
||
value = None
|
||
|
||
###
|
||
# Positive cases (preview)
|
||
###
|
||
|
||
# SIM401
|
||
var = a_dict[key] if key in a_dict else "default3"
|
||
|
||
# SIM401
|
||
var = "default-1" if key not in a_dict else a_dict[key]
|
||
|
||
# OK (default contains effect)
|
||
var = a_dict[key] if key in a_dict else val1 + val2
|