Skip to content

chore(objects): remove deprecated pipelines() method #1592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2021
Merged

chore(objects): remove deprecated pipelines() method #1592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* **release:** Allow to update release ([`b4c4787`](https://github.com/python-gitlab/python-gitlab/commit/b4c4787af54d9db6c1f9e61154be5db9d46de3dd))
* **api:** Add group hooks ([`4a7e9b8`](https://github.com/python-gitlab/python-gitlab/commit/4a7e9b86aa348b72925bce3af1e5d988b8ce3439))
* **api:** Remove responsibility for API inconsistencies for MR reviewers ([`3d985ee`](https://github.com/python-gitlab/python-gitlab/commit/3d985ee8cdd5d27585678f8fbb3eb549818a78eb))
* **api:** Add MR pipeline manager in favor of pipelines() method ([`954357c`](https://github.com/python-gitlab/python-gitlab/commit/954357c49963ef51945c81c41fd4345002f9fb98))
* **api:** Add MR pipeline manager and deprecate pipelines() method ([`954357c`](https://github.com/python-gitlab/python-gitlab/commit/954357c49963ef51945c81c41fd4345002f9fb98))
* **api:** Add support for creating/editing reviewers in project merge requests ([`676d1f6`](https://github.com/python-gitlab/python-gitlab/commit/676d1f6565617a28ee84eae20e945f23aaf3d86f))

### Documentation
Expand Down
29 changes: 0 additions & 29 deletions gitlab/v4/objects/pipelines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import warnings

from gitlab import cli
from gitlab import exceptions as exc
from gitlab.base import RequiredOptional, RESTManager, RESTObject
Expand Down Expand Up @@ -45,33 +43,6 @@ class ProjectMergeRequestPipelineManager(CreateMixin, ListMixin, RESTManager):
_obj_cls = ProjectMergeRequestPipeline
_from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"}

# If the manager was called directly as a callable via
# mr.pipelines(), execute the deprecated method for now.
# TODO: in python-gitlab 3.0.0, remove this method entirely.

@cli.register_custom_action("ProjectMergeRequest", custom_action="pipelines")
@exc.on_http_error(exc.GitlabListError)
def __call__(self, **kwargs):
"""List the merge request pipelines.

Args:
**kwargs: Extra options to send to the server (e.g. sudo)

Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabListError: If the list could not be retrieved

Returns:
RESTObjectList: List of changes
"""
warnings.warn(
"Calling the ProjectMergeRequest.pipelines() method on "
"merge request objects directly is deprecated and will be replaced "
"by ProjectMergeRequest.pipelines.list() in python-gitlab 3.0.0.\n",
DeprecationWarning,
)
return self.list(**kwargs)


class ProjectPipeline(RefreshMixin, ObjectDeleteMixin, RESTObject):
bridges: "ProjectPipelineBridgeManager"
Expand Down
11 changes: 0 additions & 11 deletions tests/unit/objects/test_merge_request_pipelines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,6 @@ def resp_create_merge_request_pipeline():
yield rsps


def test_merge_requests_pipelines_deprecated_raises_warning(
project, resp_list_merge_request_pipelines
):
with pytest.deprecated_call():
pipelines = project.mergerequests.get(1, lazy=True).pipelines()

assert len(pipelines) == 1
assert isinstance(pipelines[0], ProjectMergeRequestPipeline)
assert pipelines[0].sha == pipeline_content["sha"]


def test_list_merge_requests_pipelines(project, resp_list_merge_request_pipelines):
pipelines = project.mergerequests.get(1, lazy=True).pipelines.list()
assert len(pipelines) == 1
Expand Down