Enforce use of lineno variable name inside the library

Uses lineno like python core itself instead of linenumber and
line_number and prevents further use of it.

On python code there were >4700 occurrences of lineno, and the other
two variants had less than 100 each.

Note that this translate into API change, as it might affect users
of custom rules.

pyproject.toml

@@ -109,13 +109,7 @@ disallow_any_generics = true
 exclude = "(build|dist|test/local-content|site-packages|~/.pyenv|examples/playbooks/collections|plugins/modules)"
 
 [[tool.mypy.overrides]]
-module = [
-  "ansible.*",
-  "yamllint.*",
-  "ansiblelint._version",
-  "ruamel.yaml",
-  "spdx.*"
-]
+module = ["ansible.*", "yamllint.*", "ansiblelint._version", "ruamel.yaml", "spdx.*"]
 ignore_missing_imports = true
 ignore_errors = true
 
@@ -126,6 +120,10 @@ extension-pkg-allow-list = ["black.parsing"]
 preferred-modules = ["py:pathlib", "unittest:pytest"]
 
 [tool.pylint.MASTER]
+bad-names = [
+  "linenumber", # use lineno instead
+  "line_number", # use lineno instead
+]
 # pylint defaults + f,fh,v,id
 good-names = ["i", "j", "k", "ex", "Run", "_", "f", "fh", "v", "id", "T"]
 # Ignore as being generated:

src/ansiblelint/errors.py

@@ -45,7 +45,7 @@ def __init__(
         message: str | None = None,
         # most linters report use (1,1) base, including yamllint and flake8
         # we should never report line 0 or column 0 in output.
-        linenumber: int = 1,
+        lineno: int = 1,
         column: int | None = None,
         details: str = "",
         filename: Lintable | None = None,
@@ -65,7 +65,7 @@ def __init__(
         self.message = str(message or getattr(rule, "shortdesc", ""))
 
         # Safety measure to ensure we do not end-up with incorrect indexes
-        if linenumber == 0:  # pragma: no cover
+        if lineno == 0:  # pragma: no cover
             raise RuntimeError(
                 "MatchError called incorrectly as line numbers start with 1",
             )
@@ -74,7 +74,7 @@ def __init__(
                 "MatchError called incorrectly as column numbers start with 1",
             )
 
-        self.linenumber = linenumber
+        self.lineno = lineno
         self.column = column
         self.details = details
         self.filename = ""
@@ -120,23 +120,23 @@ def __repr__(self) -> str:
             _id,
             self.message,
             self.filename,
-            self.linenumber,
+            self.lineno,
             self.details,
         )
 
     @property
     def position(self) -> str:
         """Return error positioning, with column number if available."""
         if self.column:
-            return f"{self.linenumber}:{self.column}"
-        return str(self.linenumber)
+            return f"{self.lineno}:{self.column}"
+        return str(self.lineno)
 
     @property
     def _hash_key(self) -> Any:
         # line attr is knowingly excluded, as dict is not hashable
         return (
             self.filename,
-            self.linenumber,
+            self.lineno,
             str(getattr(self.rule, "id", 0)),
             self.message,
             self.details,

src/ansiblelint/formatters/__init__.py

@@ -116,7 +116,7 @@ class AnnotationsFormatter(BaseFormatter):  # type: ignore
     def format(self, match: MatchError) -> str:
         """Prepare a match instance for reporting as a GitHub Actions annotation."""
         file_path = self._format_path(match.filename or "")
-        line_num = match.linenumber
+        line_num = match.lineno
         severity = match.rule.severity
         violation_details = self.escape(match.message)
         col = f",col={match.column}" if match.column else ""
@@ -160,11 +160,11 @@ def format_result(self, matches: list[MatchError]) -> str:
             if match.column:
                 issue["location"]["positions"] = {}
                 issue["location"]["positions"]["begin"] = {}
-                issue["location"]["positions"]["begin"]["line"] = match.linenumber
+                issue["location"]["positions"]["begin"]["line"] = match.lineno
                 issue["location"]["positions"]["begin"]["column"] = match.column
             else:
                 issue["location"]["lines"] = {}
-                issue["location"]["lines"]["begin"] = match.linenumber
+                issue["location"]["lines"]["begin"] = match.lineno
             if match.details:
                 issue["content"] = {}
                 issue["content"]["body"] = match.details
@@ -287,7 +287,7 @@ def _to_sarif_result(self, match: MatchError) -> dict[str, Any]:
                             "uriBaseId": self.BASE_URI_ID,
                         },
                         "region": {
-                            "startLine": match.linenumber,
+                            "startLine": match.lineno,
                         },
                     },
                 },

src/ansiblelint/rules/__init__.py

@@ -75,15 +75,15 @@ def unjinja(text: str) -> str:
     def create_matcherror(
         self,
         message: str | None = None,
-        linenumber: int = 1,
+        lineno: int = 1,
         details: str = "",
         filename: Lintable | None = None,
         tag: str = "",
     ) -> MatchError:
         """Instantiate a new MatchError."""
         match = MatchError(
             message=message,
-            linenumber=linenumber,
+            lineno=lineno,
             details=details,
             filename=filename,
             rule=copy.copy(self),
@@ -111,8 +111,8 @@ def _enrich_matcherror_with_task_details(
         match.task = task
         if not match.details:
             match.details = "Task/Handler: " + ansiblelint.utils.task_to_str(task)
-        if match.linenumber < task[LINE_NUMBER_KEY]:
-            match.linenumber = task[LINE_NUMBER_KEY]
+        if match.lineno < task[LINE_NUMBER_KEY]:
+            match.lineno = task[LINE_NUMBER_KEY]
 
     def matchlines(self, file: Lintable) -> list[MatchError]:
         matches: list[MatchError] = []
@@ -134,7 +134,7 @@ def matchlines(self, file: Lintable) -> list[MatchError]:
                 message = result
             matcherror = self.create_matcherror(
                 message=message,
-                linenumber=prev_line_no + 1,
+                lineno=prev_line_no + 1,
                 details=line,
                 filename=file,
             )
@@ -204,7 +204,7 @@ def matchtasks(self, file: Lintable) -> list[MatchError]:  # noqa: C901
                     message = result
                 match = self.create_matcherror(
                     message=message,
-                    linenumber=task.normalized_task[LINE_NUMBER_KEY],
+                    lineno=task.normalized_task[LINE_NUMBER_KEY],
                     filename=file,
                 )
 

src/ansiblelint/rules/args.py

@@ -251,7 +251,7 @@ def _parse_failed_msg(
         results.append(
             self.create_matcherror(
                 message=error_message,
-                linenumber=task[LINE_NUMBER_KEY],
+                lineno=task[LINE_NUMBER_KEY],
                 tag="args[module]",
                 filename=file,
             ),

src/ansiblelint/rules/fqcn.py

@@ -135,7 +135,7 @@ def matchtask(
                             message=f"Use FQCN for builtin module actions ({module}).",
                             details=f"Use `{module_alias}` or `{legacy_module}` instead.",
                             filename=file,
-                            linenumber=task["__line__"],
+                            lineno=task["__line__"],
                             tag="fqcn[action-core]",
                         ),
                     )
@@ -146,7 +146,7 @@ def matchtask(
                             message=f"Use FQCN for module actions, such `{self.module_aliases[module]}`.",
                             details=f"Action `{module}` is not FQCN.",
                             filename=file,
-                            linenumber=task["__line__"],
+                            lineno=task["__line__"],
                             tag="fqcn[action]",
                         ),
                     )
@@ -160,7 +160,7 @@ def matchtask(
                         self.create_matcherror(
                             message=f"You should use canonical module name `{self.module_aliases[module]}` instead of `{module}`.",
                             filename=file,
-                            linenumber=task["__line__"],
+                            lineno=task["__line__"],
                             tag="fqcn[canonical]",
                         ),
                     )
@@ -173,7 +173,7 @@ def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:
             return [
                 self.create_matcherror(
                     message="Avoid `collections` keyword by using FQCN for all plugins, modules, roles and playbooks.",
-                    linenumber=data[LINE_NUMBER_KEY],
+                    lineno=data[LINE_NUMBER_KEY],
                     tag="fqcn[keyword]",
                     filename=file,
                 ),

src/ansiblelint/rules/galaxy.py

@@ -88,7 +88,7 @@ def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:
             results.append(
                 self.create_matcherror(
                     message="galaxy.yaml should have version tag.",
-                    linenumber=data[LINE_NUMBER_KEY],
+                    lineno=data[LINE_NUMBER_KEY],
                     tag="galaxy[version-missing]",
                     filename=file,
                 ),
@@ -103,7 +103,7 @@ def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:
                 self.create_matcherror(
                     message="collection version should be greater than or equal to 1.0.0",
                     # pylint: disable=protected-access
-                    linenumber=version._line_number,
+                    lineno=version._line_number,
                     tag="galaxy[version-incorrect]",
                     filename=file,
                 ),

src/ansiblelint/rules/jinja.py

@@ -136,7 +136,7 @@ def matchtask(  # noqa: C901
                             result.append(
                                 self.create_matcherror(
                                     message=str(exc),
-                                    linenumber=_get_error_line(task, path),
+                                    lineno=_get_error_line(task, path),
                                     filename=file,
                                     tag=f"{self.id}[invalid]",
                                 ),
@@ -155,7 +155,7 @@ def matchtask(  # noqa: C901
                                     value=v,
                                     reformatted=reformatted,
                                 ),
-                                linenumber=_get_error_line(task, path),
+                                lineno=_get_error_line(task, path),
                                 details=details,
                                 filename=file,
                                 tag=f"{self.id}[{tag}]",
@@ -190,7 +190,7 @@ def matchyaml(self, file: Lintable) -> list[MatchError]:
                                     value=v,
                                     reformatted=reformatted,
                                 ),
-                                linenumber=v.ansible_pos[1],
+                                lineno=v.ansible_pos[1],
                                 details=details,
                                 filename=file,
                                 tag=f"{self.id}[{tag}]",
@@ -199,8 +199,8 @@ def matchyaml(self, file: Lintable) -> list[MatchError]:
             if raw_results:
                 lines = file.content.splitlines()
                 for match in raw_results:
-                    # linenumber starts with 1, not zero
-                    skip_list = get_rule_skips_from_line(lines[match.linenumber - 1])
+                    # lineno starts with 1, not zero
+                    skip_list = get_rule_skips_from_line(lines[match.lineno - 1])
                     if match.rule.id not in skip_list and match.tag not in skip_list:
                         results.append(match)
         else:
@@ -388,7 +388,7 @@ def fixture_lint_error_lines() -> list[int]:
         collection.register(JinjaRule())
         lintable = Lintable("examples/playbooks/jinja-spacing.yml")
         results = Runner(lintable, rules=collection).run()
-        return list(map(lambda item: item.linenumber, results))
+        return list(map(lambda item: item.lineno, results))
 
     def test_jinja_spacing_playbook(
         error_expected_lines: list[int],
@@ -411,7 +411,7 @@ def test_jinja_spacing_vars() -> None:
         error_expected_lineno = [14, 15, 16, 17, 18, 19, 32]
         assert len(results) == len(error_expected_lineno)
         for idx, err in enumerate(results):
-            assert err.linenumber == error_expected_lineno[idx]
+            assert err.lineno == error_expected_lineno[idx]
 
     @pytest.mark.parametrize(
         ("text", "expected", "tag"),
@@ -702,10 +702,10 @@ def test_jinja_invalid() -> None:
         assert len(errs) == 2
         assert errs[0].tag == "jinja[spacing]"
         assert errs[0].rule.id == "jinja"
-        assert errs[0].linenumber == 9
+        assert errs[0].lineno == 9
         assert errs[1].tag == "jinja[invalid]"
         assert errs[1].rule.id == "jinja"
-        assert errs[1].linenumber == 9
+        assert errs[1].lineno == 9
 
     def test_jinja_valid() -> None:
         """Tests our ability to parse jinja, even when variables may not be defined."""

src/ansiblelint/rules/meta_incorrect.py

@@ -47,7 +47,7 @@ def matchyaml(self, file: Lintable) -> list[MatchError]:
                 results.append(
                     self.create_matcherror(
                         filename=file,
-                        linenumber=file.data[LINE_NUMBER_KEY],
+                        lineno=file.data[LINE_NUMBER_KEY],
                         message=f"Should change default metadata: {field}",
                     ),
                 )

src/ansiblelint/rules/name.py

@@ -38,7 +38,7 @@ def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:
             return [
                 self.create_matcherror(
                     message="All plays should be named.",
-                    linenumber=data[LINE_NUMBER_KEY],
+                    lineno=data[LINE_NUMBER_KEY],
                     tag="name[play]",
                     filename=file,
                 ),
@@ -47,7 +47,7 @@ def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:
             self._check_name(
                 data["name"],
                 lintable=file,
-                linenumber=data[LINE_NUMBER_KEY],
+                lineno=data[LINE_NUMBER_KEY],
             ),
         )
         return results
@@ -63,7 +63,7 @@ def matchtask(
             results.append(
                 self.create_matcherror(
                     message="All tasks should be named.",
-                    linenumber=task[LINE_NUMBER_KEY],
+                    lineno=task[LINE_NUMBER_KEY],
                     tag="name[missing]",
                     filename=file,
                 ),
@@ -73,7 +73,7 @@ def matchtask(
                 self._prefix_check(
                     name,
                     lintable=file,
-                    linenumber=task[LINE_NUMBER_KEY],
+                    lineno=task[LINE_NUMBER_KEY],
                 ),
             )
         return results
@@ -82,7 +82,7 @@ def _prefix_check(
         self,
         name: str,
         lintable: Lintable | None,
-        linenumber: int,
+        lineno: int,
     ) -> list[MatchError]:
         results: list[MatchError] = []
         effective_name = name
@@ -94,7 +94,7 @@ def _prefix_check(
                 self._check_name(
                     effective_name,
                     lintable=lintable,
-                    linenumber=linenumber,
+                    lineno=lineno,
                 ),
             )
         return results
@@ -103,7 +103,7 @@ def _check_name(
         self,
         name: str,
         lintable: Lintable | None,
-        linenumber: int,
+        lineno: int,
     ) -> list[MatchError]:
         # This rules applies only to languages that do have uppercase and
         # lowercase letter, so we ignore anything else. On Unicode isupper()
@@ -124,7 +124,7 @@ def _check_name(
                         results.append(
                             self.create_matcherror(
                                 message=f"Task name should start with '{prefix}'.",
-                                linenumber=linenumber,
+                                lineno=lineno,
                                 tag="name[prefix]",
                                 filename=lintable,
                             ),
@@ -141,7 +141,7 @@ def _check_name(
             results.append(
                 self.create_matcherror(
                     message="All names should start with an uppercase letter.",
-                    linenumber=linenumber,
+                    lineno=lineno,
                     tag="name[casing]",
                     filename=lintable,
                 ),
@@ -150,7 +150,7 @@ def _check_name(
             results.append(
                 self.create_matcherror(
                     message="Jinja templates should only be at the end of 'name'",
-                    linenumber=linenumber,
+                    lineno=lineno,
                     tag="name[template]",
                     filename=lintable,
                 ),