chore: add initial pylint check

JohnVillalovos · JohnVillalovos · commit 9a9c10a28788 · 2021-12-05T13:31:54.000-08:00
Initial pylint check is added. A LONG list of disabled checks is also
added. In the future we should work through the list and resolve the
errors or disable them on a more granular level.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -35,3 +35,5 @@ jobs:
         run: tox -e mypy
       - name: Run isort import order checker (https://pycqa.github.io/isort/)
         run: tox -e isort -- --check
+      - name: Run pylint Python code static checker (https://www.pylint.org/)
+        run: tox -e pylint
diff --git a/gitlab/v4/objects/merge_request_approvals.py b/gitlab/v4/objects/merge_request_approvals.py
@@ -140,7 +140,7 @@ def set_approvers(
         approval_rules: ProjectMergeRequestApprovalRuleManager = (
             self._parent.approval_rules
         )
-        """ update any existing approval rule matching the name"""
+        # update any existing approval rule matching the name
         existing_approval_rules = approval_rules.list()
         for ar in existing_approval_rules:
             if ar.name == approval_rule_name:
@@ -149,7 +149,7 @@ def set_approvers(
                 ar.group_ids = data["group_ids"]
                 ar.save()
                 return ar
-        """ if there was no rule matching the rule name, create a new one"""
+        # if there was no rule matching the rule name, create a new one
         return approval_rules.create(data=data)
 
 
@@ -171,13 +171,13 @@ def save(self, **kwargs: Any) -> None:
             GitlabAuthenticationError: If authentication is not correct
             GitlabUpdateError: If the server cannot perform the request
         """
-        # There is a mismatch between the name of our id attribute and the put REST API name for the
-        # project_id, so we override it here.
+        # There is a mismatch between the name of our id attribute and the put
+        # REST API name for the project_id, so we override it here.
         self.approval_rule_id = self.id
         self.merge_request_iid = self._parent_attrs["mr_iid"]
         self.id = self._parent_attrs["project_id"]
-        # save will update self.id with the result from the server, so no need to overwrite with
-        # what it was before we overwrote it."""
+        # save will update self.id with the result from the server, so no need
+        # to overwrite with what it was before we overwrote it.
         SaveMixin.save(self, **kwargs)
 
 
@@ -198,8 +198,9 @@ class ProjectMergeRequestApprovalRuleManager(
         ),
         optional=("user_ids", "group_ids"),
     )
-    # Important: When approval_project_rule_id is set, the name, users and groups of
-    # project-level rule will be copied. The approvals_required specified will be used.  """
+    # Important: When approval_project_rule_id is set, the name, users and
+    # groups of project-level rule will be copied. The approvals_required
+    # specified will be used.
     _create_attrs = RequiredOptional(
         required=("id", "merge_request_iid", "name", "approvals_required"),
         optional=("approval_project_rule_id", "user_ids", "group_ids"),
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -597,10 +597,12 @@ def artifact(
         chunk_size: int = 1024,
         **kwargs: Any,
     ) -> Optional[bytes]:
-        """Download a single artifact file from a specific tag or branch from within the job’s artifacts archive.
+        """Download a single artifact file from a specific tag or branch from
+        within the job’s artifacts archive.
 
         Args:
-            ref_name: Branch or tag name in repository. HEAD or SHA references are not supported.
+            ref_name: Branch or tag name in repository. HEAD or SHA references
+                are not supported.
             artifact_path: Path to a file inside the artifacts archive.
             job: The name of the job.
             streamed: If True the data will be processed by chunks of
@@ -619,7 +621,8 @@ def artifact(
             The artifacts if `streamed` is False, None otherwise.
         """
 
-        path = f"/projects/{self.get_id()}/jobs/artifacts/{ref_name}/raw/{artifact_path}?job={job}"
+        path = (f"/projects/{self.get_id()}/jobs/artifacts/{ref_name}/raw/"
+                f"{artifact_path}?job={job}")
         result = self.manager.gitlab.http_get(
             path, streamed=streamed, raw=True, **kwargs
         )
@@ -857,7 +860,8 @@ def import_bitbucket_server(
 
         .. note::
             This request may take longer than most other API requests.
-            So this method will specify a 60 second default timeout if none is specified.
+            So this method will specify a 60 second default timeout if none is
+            specified.
             A timeout can be specified via kwargs to override this functionality.
 
         Args:
@@ -945,7 +949,8 @@ def import_github(
 
         .. note::
             This request may take longer than most other API requests.
-            So this method will specify a 60 second default timeout if none is specified.
+            So this method will specify a 60 second default timeout if none is
+            specified.
             A timeout can be specified via kwargs to override this functionality.
 
         Args:
diff --git a/pyproject.toml b/pyproject.toml
@@ -25,3 +25,50 @@ branch = "main"
 version_variable = "gitlab/__version__.py:__version__"
 commit_subject = "chore: release v{version}"
 commit_message = ""
+
+[tool.pylint.messages_control]
+max-line-length = 88
+# TODO(jlvilla): Work on removing these disables over time.
+disable = [
+    "arguments-differ",
+    "arguments-renamed",
+    "attribute-defined-outside-init",
+    "broad-except",
+    "consider-using-f-string",
+    "consider-using-generator",
+    "consider-using-sys-exit",
+    "cyclic-import",
+    "duplicate-code",
+    "expression-not-assigned",
+    "fixme",
+    "implicit-str-concat",
+    "import-outside-toplevel",
+    "invalid-name",
+    "missing-class-docstring",
+    "missing-function-docstring",
+    "missing-module-docstring",
+    "no-else-return",
+    "no-self-use",
+    "protected-access",
+    "raise-missing-from",
+    "redefined-builtin",
+    "redefined-outer-name",
+    "signature-differs",
+    "super-with-arguments",
+    "too-few-public-methods",
+    "too-many-ancestors",
+    "too-many-arguments",
+    "too-many-branches",
+    "too-many-instance-attributes",
+    "too-many-lines",
+    "too-many-locals",
+    "too-many-statements",
+    "unexpected-keyword-arg",
+    "unnecessary-pass",
+    "unspecified-encoding",
+    "unsubscriptable-object",
+    "unused-argument",
+    "useless-import-alias",
+    "useless-object-inheritance",
+
+]
diff --git a/requirements-lint.txt b/requirements-lint.txt
@@ -1,8 +1,10 @@
+argcomplete==1.12.3
 black==21.11b1
 flake8==4.0.1
 isort==5.10.1
 mypy==0.910
-pytest
+pylint==2.12.2
+pytest==6.2.5
 types-PyYAML==6.0.1
 types-requests==2.26.1
 types-setuptools==57.4.4
diff --git a/tox.ini b/tox.ini
@@ -9,19 +9,13 @@ setenv = VIRTUAL_ENV={envdir}
 whitelist_externals = true
 usedevelop = True
 install_command = pip install {opts} {packages}
+isolated_build = True
 
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/requirements-test.txt
 commands =
   pytest tests/unit tests/meta {posargs}
 
-[testenv:pep8]
-basepython = python3
-envdir={toxworkdir}/lint
-deps = -r{toxinidir}/requirements-lint.txt
-commands =
-  flake8 {posargs} .
-
 [testenv:black]
 basepython = python3
 envdir={toxworkdir}/lint
@@ -43,6 +37,20 @@ deps = -r{toxinidir}/requirements-lint.txt
 commands =
   mypy {posargs}
 
+[testenv:pep8]
+basepython = python3
+envdir={toxworkdir}/lint
+deps = -r{toxinidir}/requirements-lint.txt
+commands =
+  flake8 {posargs} .
+
+[testenv:pylint]
+basepython = python3
+envdir={toxworkdir}/lint
+deps = -r{toxinidir}/requirements-lint.txt
+commands =
+  pylint {posargs} gitlab/
+
 [testenv:twine-check]
 basepython = python3
 deps = -r{toxinidir}/requirements.txt
