Correct 'similar' to 'symilar' when talking about the program

Author: Pierre-Sassoulas

doc/symilar.rst

@@ -3,8 +3,8 @@
 Symilar
 -------
 
-The console script ``symilar`` finds copy pasted blocks in a set of files. It provides a command line interface to the ``Similar`` class, which includes the logic for
-Pylint's ``duplicate-code`` message.
+The console script ``symilar`` finds copy pasted block of text in a set of files. It provides a command line interface to check only the ``duplicate-code`` message.
+
 It can be invoked with::
 
   symilar [-d|--duplicates min_duplicated_lines] [-i|--ignore-comments] [--ignore-docstrings] [--ignore-imports] [--ignore-signatures] file1...

doc/whatsnew/fragments/9734.internal

@@ -0,0 +1,5 @@
+All variables, classes, functions and file names containing the word 'similar', when it was,
+in fact, referring to 'symilar' (the standalone program for the duplicate-code check) were renamed
+to 'symilar'.
+
+Closes #9734

pylint/__init__.py

@@ -61,9 +61,9 @@ def run_symilar(argv: Sequence[str] | None = None) -> NoReturn:
 
     argv can be a sequence of strings normally supplied as arguments on the command line
     """
-    from pylint.checkers.similar import Run as SimilarRun
+    from pylint.checkers.symilar import Run as SymilarRun
 
-    SimilarRun(argv or sys.argv[1:])
+    SymilarRun(argv or sys.argv[1:])
 
 
 def modify_sys_path() -> None:

pylint/checkers/similar.py renamed to pylint/checkers/symilar.py

@@ -343,7 +343,7 @@ class Commonality(NamedTuple):
     snd_file_end: LineNumber
 
 
-class Similar:
+class Symilar:
     """Finds copy-pasted lines of code in a project."""
 
     def __init__(
@@ -751,18 +751,15 @@ def report_similarities(
 
 
 # wrapper to get a pylint checker from the similar class
-class SimilarChecker(BaseRawFileChecker, Similar):
+class SimilaritiesChecker(BaseRawFileChecker, Symilar):
     """Checks for similarities and duplicated code.
 
     This computation may be memory / CPU intensive, so you
     should disable it if you experience some problems.
     """
 
-    # configuration section name
     name = "similarities"
-    # messages
     msgs = MSGS
-    # configuration options
     # for available dict keys/values see the optik parser 'add_option' method
     options: Options = (
         (
@@ -811,12 +808,11 @@ class SimilarChecker(BaseRawFileChecker, Similar):
             },
         ),
     )
-    # reports
     reports = (("RP0801", "Duplication", report_similarities),)
 
     def __init__(self, linter: PyLinter) -> None:
         BaseRawFileChecker.__init__(self, linter)
-        Similar.__init__(
+        Symilar.__init__(
             self,
             min_lines=self.linter.config.min_similarity_lines,
             ignore_comments=self.linter.config.ignore_comments,
@@ -873,7 +869,7 @@ def close(self) -> None:
 
     def get_map_data(self) -> list[LineSet]:
         """Passthru override."""
-        return Similar.get_map_data(self)
+        return Symilar.get_map_data(self)
 
     def reduce_map_data(self, linter: PyLinter, data: list[list[LineSet]]) -> None:
         """Reduces and recombines data into a format that we can report on.
@@ -882,12 +878,12 @@ def reduce_map_data(self, linter: PyLinter, data: list[list[LineSet]]) -> None:
 
         Calls self.close() to actually calculate and report duplicate code.
         """
-        Similar.combine_mapreduce_data(self, linesets_collection=data)
+        Symilar.combine_mapreduce_data(self, linesets_collection=data)
         self.close()
 
 
 def register(linter: PyLinter) -> None:
-    linter.register_checker(SimilarChecker(linter))
+    linter.register_checker(SimilaritiesChecker(linter))
 
 
 def usage(status: int = 0) -> NoReturn:
@@ -944,7 +940,7 @@ def Run(argv: Sequence[str] | None = None) -> NoReturn:
             ignore_signatures = True
     if not args:
         usage(1)
-    sim = Similar(
+    sim = Symilar(
         min_lines, ignore_comments, ignore_docstrings, ignore_imports, ignore_signatures
     )
     for filename in args:

tests/checkers/unittest_symilar.py

@@ -8,7 +8,7 @@
 
 import pytest
 
-from pylint.checkers import similar
+from pylint.checkers import symilar
 from pylint.constants import IS_PYPY, PY39_PLUS
 from pylint.lint import PyLinter
 from pylint.testutils import GenericTestReporter as Reporter
@@ -31,7 +31,7 @@
 def test_ignore_comments() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-comments", SIMILAR1, SIMILAR2])
+        symilar.Run(["--ignore-comments", SIMILAR1, SIMILAR2])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -60,7 +60,7 @@ def test_ignore_comments() -> None:
 def test_ignore_docstrings() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-docstrings", SIMILAR1, SIMILAR2])
+        symilar.Run(["--ignore-docstrings", SIMILAR1, SIMILAR2])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -95,7 +95,7 @@ def test_ignore_docstrings() -> None:
 def test_ignore_imports() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-imports", SIMILAR1, SIMILAR2])
+        symilar.Run(["--ignore-imports", SIMILAR1, SIMILAR2])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -108,7 +108,7 @@ def test_ignore_imports() -> None:
 def test_multiline_imports() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([MULTILINE, MULTILINE])
+        symilar.Run([MULTILINE, MULTILINE])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -138,7 +138,7 @@ def test_multiline_imports() -> None:
 def test_ignore_multiline_imports() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-imports", MULTILINE, MULTILINE])
+        symilar.Run(["--ignore-imports", MULTILINE, MULTILINE])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -151,7 +151,7 @@ def test_ignore_multiline_imports() -> None:
 def test_ignore_signatures_fail() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([SIMILAR5, SIMILAR6])
+        symilar.Run([SIMILAR5, SIMILAR6])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -189,7 +189,7 @@ def example():
 def test_ignore_signatures_pass() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-signatures", SIMILAR5, SIMILAR6])
+        symilar.Run(["--ignore-signatures", SIMILAR5, SIMILAR6])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -202,7 +202,7 @@ def test_ignore_signatures_pass() -> None:
 def test_ignore_signatures_class_methods_fail() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([SIMILAR_CLS_B, SIMILAR_CLS_A])
+        symilar.Run([SIMILAR_CLS_B, SIMILAR_CLS_A])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -248,7 +248,7 @@ def _internal_func(
 def test_ignore_signatures_class_methods_pass() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-signatures", SIMILAR_CLS_B, SIMILAR_CLS_A])
+        symilar.Run(["--ignore-signatures", SIMILAR_CLS_B, SIMILAR_CLS_A])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -261,7 +261,7 @@ def test_ignore_signatures_class_methods_pass() -> None:
 def test_ignore_signatures_empty_functions_fail() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([EMPTY_FUNCTION_1, EMPTY_FUNCTION_2])
+        symilar.Run([EMPTY_FUNCTION_1, EMPTY_FUNCTION_2])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -285,7 +285,7 @@ def test_ignore_signatures_empty_functions_fail() -> None:
 def test_ignore_signatures_empty_functions_pass() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-signatures", EMPTY_FUNCTION_1, EMPTY_FUNCTION_2])
+        symilar.Run(["--ignore-signatures", EMPTY_FUNCTION_1, EMPTY_FUNCTION_2])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -298,15 +298,15 @@ def test_ignore_signatures_empty_functions_pass() -> None:
 def test_no_hide_code_with_imports() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--ignore-imports"] + 2 * [HIDE_CODE_WITH_IMPORTS])
+        symilar.Run(["--ignore-imports"] + 2 * [HIDE_CODE_WITH_IMPORTS])
     assert ex.value.code == 0
     assert "TOTAL lines=32 duplicates=0 percent=0.00" in output.getvalue()
 
 
 def test_ignore_nothing() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([SIMILAR1, SIMILAR2])
+        symilar.Run([SIMILAR1, SIMILAR2])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -329,7 +329,7 @@ def test_ignore_nothing() -> None:
 def test_lines_without_meaningful_content_do_not_trigger_similarity() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([SIMILAR3, SIMILAR4])
+        symilar.Run([SIMILAR3, SIMILAR4])
     assert ex.value.code == 0
     assert (
         output.getvalue().strip()
@@ -362,7 +362,7 @@ def test_help() -> None:
     output = StringIO()
     with redirect_stdout(output):
         try:
-            similar.Run(["--help"])
+            symilar.Run(["--help"])
         except SystemExit as ex:
             assert ex.code == 0
         else:
@@ -373,18 +373,18 @@ def test_no_args() -> None:
     output = StringIO()
     with redirect_stdout(output):
         try:
-            similar.Run([])
+            symilar.Run([])
         except SystemExit as ex:
             assert ex.code == 1
         else:
             pytest.fail("not system exit")
 
 
 def test_get_map_data() -> None:
-    """Tests that a SimilarChecker can return and reduce mapped data."""
+    """Tests that a SymilarChecker can return and reduce mapped data."""
     linter = PyLinter(reporter=Reporter())
     # Add a parallel checker to ensure it can map and reduce
-    linter.register_checker(similar.SimilarChecker(linter))
+    linter.register_checker(symilar.SimilaritiesChecker(linter))
     source_streams = (
         str(INPUT / "similar_lines_a.py"),
         str(INPUT / "similar_lines_b.py"),
@@ -473,7 +473,7 @@ def test_get_map_data() -> None:
 
     # Manually perform a 'map' type function
     for source_fname in source_streams:
-        sim = similar.SimilarChecker(PyLinter())
+        sim = symilar.SimilaritiesChecker(PyLinter())
         sim.linter.set_option("ignore-imports", False)
         sim.linter.set_option("ignore-signatures", False)
         with open(source_fname, encoding="utf-8") as stream:
@@ -494,7 +494,7 @@ def test_get_map_data() -> None:
 def test_set_duplicate_lines_to_zero() -> None:
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["--duplicates=0", SIMILAR1, SIMILAR2])
+        symilar.Run(["--duplicates=0", SIMILAR1, SIMILAR2])
     assert ex.value.code == 0
     assert output.getvalue() == ""
 
@@ -504,7 +504,7 @@ def test_bad_equal_short_form_option(v: str) -> None:
     """Regression test for https://github.com/pylint-dev/pylint/issues/9343"""
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([f"-{v}=0", SIMILAR1, SIMILAR2])
+        symilar.Run([f"-{v}=0", SIMILAR1, SIMILAR2])
     assert ex.value.code == 2
     assert "invalid literal for int() with base 10: '=0'" in output.getvalue()
 
@@ -514,7 +514,7 @@ def test_space_short_form_option(v: str) -> None:
     """Regression test for https://github.com/pylint-dev/pylint/issues/9343"""
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run([f"-{v} 2", SIMILAR1, SIMILAR2])
+        symilar.Run([f"-{v} 2", SIMILAR1, SIMILAR2])
     assert ex.value.code == 0
     assert "similar lines in" in output.getvalue()
 
@@ -523,6 +523,6 @@ def test_bad_short_form_option() -> None:
     """Regression test for https://github.com/pylint-dev/pylint/issues/9343"""
     output = StringIO()
     with redirect_stdout(output), pytest.raises(SystemExit) as ex:
-        similar.Run(["-j=0", SIMILAR1, SIMILAR2])
+        symilar.Run(["-j=0", SIMILAR1, SIMILAR2])
     assert ex.value.code == 2
     assert "option -j not recognized" in output.getvalue()

tests/test_similar.py

@@ -22,7 +22,7 @@
 CLEAN_PATH = re.escape(dirname(dirname(__file__)) + os.path.sep)
 
 
-class TestSimilarCodeChecker:
+class TestSymilarCodeChecker:
     def _runtest(self, args: list[str], code: int) -> None:
         """Runs the tests and sees if output code is as expected."""
         out = StringIO()