Skip to content

Commit

Permalink
Improved on help text logic and accompanying tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@yushao2
yushao2 committed May 12, 2021
1 parent 9dc3d82 commit 4c45cca
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 28 deletions.
26 changes: 21 additions & 5 deletions pylint/checkers/refactoring/recommendation_checker.py
View file
Expand Up @@ -259,16 +259,26 @@ def visit_subscript(self, node: astroid.Subscript) -> None:
if isinstance(value, (astroid.UnaryOp, astroid.Const)):
const = utils.safe_infer(value)
const = cast(astroid.Const, const)
p = re.compile(r"r*split")
p = re.compile(
r"tilpsr*\."
) # Match and replace in reverse to ensure last occurance replaced
if const.value == -1:
help_text = p.sub("rpartition", subscripted_object.as_string())
help_text = p.sub(
".rpartition"[::-1],
subscripted_object.as_string()[::-1],
count=1,
)[::-1]
self.add_message(
"consider-using-str-partition",
node=node,
args=(help_text, -1),
)
elif const.value == 0:
help_text = p.sub("partition", subscripted_object.as_string())
help_text = p.sub(
".partition"[::-1],
subscripted_object.as_string()[::-1],
count=1,
)[::-1]
self.add_message(
"consider-using-str-partition",
node=node,
Expand All @@ -294,8 +304,14 @@ def visit_subscript(self, node: astroid.Subscript) -> None:
# Further check for argument within len(), and compare that to object being split
arg_within_len = value.left.args[0].name
if arg_within_len == node.value.name:
p = re.compile(r"r*split")
help_text = p.sub("rpartition", subscripted_object.as_string())
p = re.compile(
r"tilpsr*\."
) # Match and replace in reverse to ensure last occurance replaced
help_text = p.sub(
".rpartition"[::-1],
subscripted_object.as_string()[::-1],
count=1,
)[::-1]
self.add_message(
"consider-using-str-partition",
node=node,
Expand Down
12 changes: 12 additions & 0 deletions tests/functional/c/consider/consider_using_str_partition.py
View file
Expand Up @@ -3,6 +3,9 @@
from collections.abc import Iterable
from typing import Any

get_first = '1,2,3'.split(',')[0] # [consider-using-str-partition]
get_last = '1,2,3'[::-1].split(',')[0] # [consider-using-str-partition]

SEQ = '1,2,3'
get_first = SEQ.split(',')[0] # [consider-using-str-partition]
get_last = SEQ.split(',')[-1] # [consider-using-str-partition]
Expand Down Expand Up @@ -68,6 +71,15 @@ def get_string(self) -> str:
print(s.split(" ")[-1]) # [consider-using-str-partition]
print(s.split(" ")[-2])

# Test warning messages (matching and replacing .split / .rsplit)
class Bar():
split = '1,2,3'

print(Bar.split.split(",")[0]) # [consider-using-str-partition] (Error message should show Bar.split.partition)
print(Bar.split.split(",")[-1]) # [consider-using-str-partition] (Error message should show Bar.split.rpartition)
print(Bar.split.rsplit(",")[0]) # [consider-using-str-partition] (Error message should show Bar.split.partition)
print(Bar.split.rsplit(",")[-1]) # [consider-using-str-partition] (Error message should show Bar.split.rpartition)

# Test with user-defined len function
def len(x: Iterable[Any]) -> str:
return f"Hello, world! {x[2]}"
Expand Down
52 changes: 29 additions & 23 deletions tests/functional/c/consider/consider_using_str_partition.txt
View file
@@ -1,23 +1,29 @@
consider-using-str-partition:7:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:8:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:9:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:10:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:17:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:18:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:19:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:22:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:23:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:24:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:26:6::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:26:17::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:43:12::Consider using Foo.class_str.partition(',')[0] instead
consider-using-str-partition:44:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:45:12::Consider using Foo.class_str.partition(',')[0] instead
consider-using-str-partition:46:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:52:12::Consider using Foo.class_str.partition(',')[0] instead
consider-using-str-partition:53:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:54:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:58:12::Consider using bar.get_string().partition(',')[0] instead
consider-using-str-partition:59:11::Consider using bar.get_string().rpartition(',')[-1] instead
consider-using-str-partition:67:10::Consider using s.partition(' ')[0] instead
consider-using-str-partition:68:10::Consider using s.rpartition(' ')[-1] instead
consider-using-str-partition:6:12::Consider using '1,2,3'.partition(',')[0] instead
consider-using-str-partition:7:11::"Consider using '1,2,3'[::-1].partition(',')[0] instead"
consider-using-str-partition:10:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:11:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:12:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:13:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:20:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:21:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:22:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:25:12::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:26:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:27:11::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:29:6::Consider using SEQ.partition(',')[0] instead
consider-using-str-partition:29:17::Consider using SEQ.rpartition(',')[-1] instead
consider-using-str-partition:46:12::Consider using Foo.class_str.partition(',')[0] instead
consider-using-str-partition:47:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:48:12::Consider using Foo.class_str.partition(',')[0] instead
consider-using-str-partition:49:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:55:12::Consider using Foo.class_str.partition(',')[0] instead
consider-using-str-partition:56:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:57:11::Consider using Foo.class_str.rpartition(',')[-1] instead
consider-using-str-partition:61:12::Consider using bar.get_string().partition(',')[0] instead
consider-using-str-partition:62:11::Consider using bar.get_string().rpartition(',')[-1] instead
consider-using-str-partition:70:10::Consider using s.partition(' ')[0] instead
consider-using-str-partition:71:10::Consider using s.rpartition(' ')[-1] instead
consider-using-str-partition:78:6::Consider using Bar.split.partition(',')[0] instead
consider-using-str-partition:79:6::Consider using Bar.split.rpartition(',')[-1] instead
consider-using-str-partition:80:6::Consider using Bar.split.partition(',')[0] instead
consider-using-str-partition:81:6::Consider using Bar.split.rpartition(',')[-1] instead

0 comments on commit 4c45cca

Please sign in to comment.