Skip to content

Commit

Permalink
test(pylint): enable pylint "unused-argument" check
Browse files Browse the repository at this point in the history
Enable the pylint "unused-argument" check and resolve issues it found.

  * Quite a few functions were accepting `**kwargs` but not then
    passing them on through to the next level. Now pass `**kwargs` to
    next level.
  * Other functions had no reason to accept `**kwargs`, so remove it
  * And a few other fixes.
  • Loading branch information
JohnVillalovos committed Jun 27, 2022
1 parent b644721 commit 23feae9
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 20 deletions.
1 change: 1 addition & 0 deletions gitlab/client.py
Expand Up @@ -967,6 +967,7 @@ def http_post(
query_data=query_data,
post_data=post_data,
files=files,
raw=raw,
**kwargs,
)
try:
Expand Down
10 changes: 5 additions & 5 deletions gitlab/v4/cli.py
Expand Up @@ -381,7 +381,7 @@ def get_dict(

class JSONPrinter:
@staticmethod
def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
def display(d: Union[str, Dict[str, Any]], **_kwargs: Any) -> None:
import json # noqa

print(json.dumps(d))
Expand All @@ -390,7 +390,7 @@ def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
def display_list(
data: List[Union[str, gitlab.base.RESTObject]],
fields: List[str],
**kwargs: Any,
**_kwargs: Any,
) -> None:
import json # noqa

Expand All @@ -399,7 +399,7 @@ def display_list(

class YAMLPrinter:
@staticmethod
def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
def display(d: Union[str, Dict[str, Any]], **_kwargs: Any) -> None:
try:
import yaml # noqa

Expand All @@ -415,7 +415,7 @@ def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
def display_list(
data: List[Union[str, gitlab.base.RESTObject]],
fields: List[str],
**kwargs: Any,
**_kwargs: Any,
) -> None:
try:
import yaml # noqa
Expand All @@ -434,7 +434,7 @@ def display_list(


class LegacyPrinter:
def display(self, d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
def display(self, _d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
verbose = kwargs.get("verbose", False)
padding = kwargs.get("padding", 0)
obj: Optional[Union[Dict[str, Any], gitlab.base.RESTObject]] = kwargs.get("obj")
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/groups.py
Expand Up @@ -183,7 +183,7 @@ def delete_ldap_group_link(
if provider is not None:
path += f"/{provider}"
path += f"/{cn}"
self.manager.gitlab.http_delete(path)
self.manager.gitlab.http_delete(path, **kwargs)

@cli.register_custom_action("Group")
@exc.on_http_error(exc.GitlabCreateError)
Expand Down
12 changes: 6 additions & 6 deletions gitlab/v4/objects/jobs.py
Expand Up @@ -28,7 +28,7 @@ def cancel(self, **kwargs: Any) -> Dict[str, Any]:
GitlabJobCancelError: If the job could not be canceled
"""
path = f"{self.manager.path}/{self.encoded_id}/cancel"
result = self.manager.gitlab.http_post(path)
result = self.manager.gitlab.http_post(path, **kwargs)
if TYPE_CHECKING:
assert isinstance(result, dict)
return result
Expand All @@ -46,7 +46,7 @@ def retry(self, **kwargs: Any) -> Dict[str, Any]:
GitlabJobRetryError: If the job could not be retried
"""
path = f"{self.manager.path}/{self.encoded_id}/retry"
result = self.manager.gitlab.http_post(path)
result = self.manager.gitlab.http_post(path, **kwargs)
if TYPE_CHECKING:
assert isinstance(result, dict)
return result
Expand All @@ -64,7 +64,7 @@ def play(self, **kwargs: Any) -> None:
GitlabJobPlayError: If the job could not be triggered
"""
path = f"{self.manager.path}/{self.encoded_id}/play"
self.manager.gitlab.http_post(path)
self.manager.gitlab.http_post(path, **kwargs)

@cli.register_custom_action("ProjectJob")
@exc.on_http_error(exc.GitlabJobEraseError)
Expand All @@ -79,7 +79,7 @@ def erase(self, **kwargs: Any) -> None:
GitlabJobEraseError: If the job could not be erased
"""
path = f"{self.manager.path}/{self.encoded_id}/erase"
self.manager.gitlab.http_post(path)
self.manager.gitlab.http_post(path, **kwargs)

@cli.register_custom_action("ProjectJob")
@exc.on_http_error(exc.GitlabCreateError)
Expand All @@ -94,7 +94,7 @@ def keep_artifacts(self, **kwargs: Any) -> None:
GitlabCreateError: If the request could not be performed
"""
path = f"{self.manager.path}/{self.encoded_id}/artifacts/keep"
self.manager.gitlab.http_post(path)
self.manager.gitlab.http_post(path, **kwargs)

@cli.register_custom_action("ProjectJob")
@exc.on_http_error(exc.GitlabCreateError)
Expand All @@ -109,7 +109,7 @@ def delete_artifacts(self, **kwargs: Any) -> None:
GitlabDeleteError: If the request could not be performed
"""
path = f"{self.manager.path}/{self.encoded_id}/artifacts"
self.manager.gitlab.http_delete(path)
self.manager.gitlab.http_delete(path, **kwargs)

@cli.register_custom_action("ProjectJob")
@exc.on_http_error(exc.GitlabGetError)
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/merge_request_approvals.py
Expand Up @@ -157,7 +157,7 @@ def set_approvers(
ar.save()
return ar
# if there was no rule matching the rule name, create a new one
return approval_rules.create(data=data)
return approval_rules.create(data=data, **kwargs)


class ProjectMergeRequestApprovalRule(SaveMixin, ObjectDeleteMixin, RESTObject):
Expand Down
4 changes: 2 additions & 2 deletions gitlab/v4/objects/pipelines.py
Expand Up @@ -71,7 +71,7 @@ def cancel(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
GitlabPipelineCancelError: If the request failed
"""
path = f"{self.manager.path}/{self.encoded_id}/cancel"
return self.manager.gitlab.http_post(path)
return self.manager.gitlab.http_post(path, **kwargs)

@cli.register_custom_action("ProjectPipeline")
@exc.on_http_error(exc.GitlabPipelineRetryError)
Expand All @@ -86,7 +86,7 @@ def retry(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
GitlabPipelineRetryError: If the request failed
"""
path = f"{self.manager.path}/{self.encoded_id}/retry"
return self.manager.gitlab.http_post(path)
return self.manager.gitlab.http_post(path, **kwargs)


class ProjectPipelineManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager):
Expand Down
4 changes: 2 additions & 2 deletions gitlab/v4/objects/projects.py
Expand Up @@ -464,7 +464,7 @@ def upload(

url = f"/projects/{self.encoded_id}/uploads"
file_info = {"file": (filename, filedata)}
data = self.manager.gitlab.http_post(url, files=file_info)
data = self.manager.gitlab.http_post(url, files=file_info, **kwargs)

if TYPE_CHECKING:
assert isinstance(data, dict)
Expand Down Expand Up @@ -504,7 +504,7 @@ def snapshot(
"""
path = f"/projects/{self.encoded_id}/snapshot"
result = self.manager.gitlab.http_get(
path, streamed=streamed, raw=True, **kwargs
path, streamed=streamed, raw=True, wiki=wiki, **kwargs
)
if TYPE_CHECKING:
assert isinstance(result, requests.Response)
Expand Down
2 changes: 1 addition & 1 deletion gitlab/v4/objects/services.py
Expand Up @@ -267,7 +267,7 @@ def get(
return cast(ProjectService, super().get(id=id, lazy=lazy, **kwargs))

@cli.register_custom_action("ProjectServiceManager")
def available(self, **kwargs: Any) -> List[str]:
def available(self) -> List[str]:
"""List the services known by python-gitlab.
Returns:
Expand Down
2 changes: 0 additions & 2 deletions pyproject.toml
Expand Up @@ -70,8 +70,6 @@ disable = [
"too-many-locals",
"too-many-statements",
"unsubscriptable-object",
"unused-argument",

]

[tool.pytest.ini_options]
Expand Down

0 comments on commit 23feae9

Please sign in to comment.