python-gitlab 4.11.1__tar.gz → 4.12.0__tar.gz

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/CHANGELOG.md

@@ -1,5 +1,48 @@
 # CHANGELOG
 
+## v4.12.0 (2024-09-28)
+
+### Chore
+
+* chore(deps): update all non-major dependencies ([`ae132e7`](https://github.com/python-gitlab/python-gitlab/commit/ae132e7a1efef6b0ae2f2a7d335668784648e3c7))
+
+* chore: update pylint to 3.3.1 and resolve issues (#2997)
+
+pylint 3.3.1 appears to have added "too-many-positional-arguments"
+check with a value of 5.
+
+I don't disagree with this, but we have many functions which exceed
+this value. We might think about converting some of positional
+arguments over to keyword arguments in the future. But that is for
+another time.
+
+For now disable the check across the project. ([`a0729b8`](https://github.com/python-gitlab/python-gitlab/commit/a0729b83e63bcd74f522bf57a87a5800b1cf19d1))
+
+* chore(deps): update dependency types-setuptools to v75 ([`a2ab54c`](https://github.com/python-gitlab/python-gitlab/commit/a2ab54ceb40eca1e6e71f7779a418591426b2b2c))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v17.4.0-ee.0 ([`8601808`](https://github.com/python-gitlab/python-gitlab/commit/860180862d952ed25cf95df1a4f825664f7e1c4b))
+
+* chore(deps): update all non-major dependencies ([`10ee58a`](https://github.com/python-gitlab/python-gitlab/commit/10ee58a01fdc8071f29ae0095d9ea8a4424fa728))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v17.3.2-ee.0 ([`5cd1ab2`](https://github.com/python-gitlab/python-gitlab/commit/5cd1ab202e3e7b64d626d2c4e62b1662a4285015))
+
+### Feature
+
+* feat(build): build multi-arch images (#2987) ([`29f617d`](https://github.com/python-gitlab/python-gitlab/commit/29f617d7d368636791baf703ecdbd22583356674))
+
+* feat: introduce related_issues to merge requests (#2996) ([`174d992`](https://github.com/python-gitlab/python-gitlab/commit/174d992e49f1e5171fee8893a1713f30324bbf97))
+
+### Fix
+
+* fix(api): head requests for projectfilemanager (#2977)
+
+* fix(api): head requests for projectfilemanager
+
+---------
+
+Co-authored-by: Patrick Evans <patrick.evans@gehealthcare.com>
+Co-authored-by: Nejc Habjan <hab.nejc@gmail.com> ([`96a18b0`](https://github.com/python-gitlab/python-gitlab/commit/96a18b065dac4ce612a128f03e2fc6d1b4ccd69e))
+
 ## v4.11.1 (2024-09-13)
 
 ### Fix

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.11.1
+Version: 4.12.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/docs/gl_objects/merge_requests.rst

@@ -144,6 +144,10 @@ List the changes of a MR::
 
     changes = mr.changes()
 
+List issues related to this merge request::
+
+    related_issues = mr.related_issues()
+
 List issues that will close on merge::
 
     mr.closes_issues()

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/gitlab/_version.py

@@ -3,4 +3,4 @@ __copyright__ = "Copyright 2013-2019 Gauvain Pocentek, 2019-2023 python-gitlab t
 __email__ = "gauvainpocentek@gmail.com"
 __license__ = "LGPL3"
 __title__ = "python-gitlab"
-__version__ = "4.11.1"
+__version__ = "4.12.0"

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/gitlab/v4/objects/files.py

@@ -2,11 +2,11 @@ import base64
 from typing import (
     Any,
     Callable,
-    cast,
     Dict,
     Iterator,
     List,
     Optional,
+    Tuple,
     TYPE_CHECKING,
     Union,
 )
@@ -20,7 +20,6 @@ from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import (
     CreateMixin,
     DeleteMixin,
-    GetMixin,
     ObjectDeleteMixin,
     SaveMixin,
     UpdateMixin,
@@ -96,10 +95,11 @@ class ProjectFile(SaveMixin, ObjectDeleteMixin, RESTObject):
         self.manager.delete(file_path, branch, commit_message, **kwargs)
 
 
-class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager):
+class ProjectFileManager(CreateMixin, UpdateMixin, DeleteMixin, RESTManager):
     _path = "/projects/{project_id}/repository/files"
     _obj_cls = ProjectFile
     _from_parent_attrs = {"project_id": "id"}
+    _optional_get_attrs: Tuple[str, ...] = ()
     _create_attrs = RequiredOptional(
         required=("file_path", "branch", "content", "commit_message"),
         optional=("encoding", "author_email", "author_name"),
@@ -112,11 +112,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTMa
     @cli.register_custom_action(
         cls_names="ProjectFileManager", required=("file_path", "ref")
     )
-    # NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore
-    # type error
-    def get(  # type: ignore
-        self, file_path: str, ref: str, **kwargs: Any
-    ) -> ProjectFile:
+    def get(self, file_path: str, ref: str, **kwargs: Any) -> ProjectFile:
         """Retrieve a single file.
 
         Args:
@@ -131,7 +127,37 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTMa
         Returns:
             The generated RESTObject
         """
-        return cast(ProjectFile, GetMixin.get(self, file_path, ref=ref, **kwargs))
+        if TYPE_CHECKING:
+            assert file_path is not None
+        file_path = utils.EncodedId(file_path)
+        path = f"{self.path}/{file_path}"
+        server_data = self.gitlab.http_get(path, ref=ref, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
+        return self._obj_cls(self, server_data)
+
+    def head(
+        self, file_path: str, ref: str, **kwargs: Any
+    ) -> "requests.structures.CaseInsensitiveDict[Any]":
+        """Retrieve just metadata for a single file.
+
+        Args:
+            file_path: Path of the file to retrieve
+            ref: Name of the branch, tag or commit
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabGetError: If the file could not be retrieved
+
+        Returns:
+            The response headers as a dictionary
+        """
+        if TYPE_CHECKING:
+            assert file_path is not None
+        file_path = utils.EncodedId(file_path)
+        path = f"{self.path}/{file_path}"
+        return self.gitlab.http_head(path, ref=ref, **kwargs)
 
     @cli.register_custom_action(
         cls_names="ProjectFileManager",

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/gitlab/v4/objects/merge_requests.py

@@ -197,6 +197,35 @@ class ProjectMergeRequest(
             assert isinstance(server_data, dict)
         return server_data
 
+    @cli.register_custom_action(cls_names="ProjectMergeRequest")
+    @exc.on_http_error(exc.GitlabListError)
+    def related_issues(self, **kwargs: Any) -> RESTObjectList:
+        """List issues related to this merge request."
+
+        Args:
+            all: If True, return all the items, without pagination
+            per_page: Number of items to retrieve per request
+            page: ID of the page to return (starts with page 1)
+            **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:
+            List of issues
+        """
+
+        path = f"{self.manager.path}/{self.encoded_id}/related_issues"
+        data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs)
+
+        if TYPE_CHECKING:
+            assert isinstance(data_list, gitlab.GitlabList)
+
+        manager = ProjectIssueManager(self.manager.gitlab, parent=self.manager._parent)
+
+        return RESTObjectList(manager, ProjectIssue, data_list)
+
     @cli.register_custom_action(cls_names="ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabListError)
     def closes_issues(self, **kwargs: Any) -> RESTObjectList:

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/pyproject.toml

@@ -124,6 +124,7 @@ disable = [
     "too-many-instance-attributes",
     "too-many-lines",
     "too-many-locals",
+    "too-many-positional-arguments",
     "too-many-public-methods",
     "too-many-statements",
     "unsubscriptable-object",

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/python_gitlab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.11.1
+Version: 4.12.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/requirements-lint.txt

@@ -5,10 +5,10 @@ commitizen==3.29.0
 flake8==7.1.1
 isort==5.13.2
 mypy==1.11.2
-pylint==3.2.7
-pytest==8.3.2
+pylint==3.3.1
+pytest==8.3.3
 responses==0.25.3
 respx==0.21.1
-types-PyYAML==6.0.12.20240808
-types-requests==2.32.0.20240907
-types-setuptools==74.1.0.20240907
+types-PyYAML==6.0.12.20240917
+types-requests==2.32.0.20240914
+types-setuptools==75.1.0.20240917

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/requirements-test.txt

@@ -4,7 +4,7 @@ coverage==7.6.1
 pytest-console-scripts==1.4.1
 pytest-cov==5.0.0
 pytest-github-actions-annotate-failures==0.2.0
-pytest==8.3.2
+pytest==8.3.3
 PyYaml==6.0.2
 responses==0.25.3
 respx==0.21.1

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/tests/functional/fixtures/.env

@@ -1,2 +1,2 @@
 GITLAB_IMAGE=gitlab/gitlab-ee
-GITLAB_TAG=17.3.1-ee.0
+GITLAB_TAG=17.4.0-ee.0

{python_gitlab-4.11.1 → python_gitlab-4.12.0}/tests/unit/objects/test_merge_requests.py

@@ -9,8 +9,10 @@ import re
 import pytest
 import responses
 
+from gitlab.base import RESTObjectList
 from gitlab.v4.objects import (
     ProjectDeploymentMergeRequest,
+    ProjectIssue,
     ProjectMergeRequest,
     ProjectMergeRequestReviewerDetail,
 )
@@ -57,6 +59,78 @@ reviewers_content = [
     }
 ]
 
+related_issues = [
+    {
+        "id": 1,
+        "iid": 1,
+        "project_id": 1,
+        "title": "Fake Title for Merge Requests via API",
+        "description": "Something here",
+        "state": "closed",
+        "created_at": "2024-05-14T04:01:40.042Z",
+        "updated_at": "2024-06-13T05:29:13.661Z",
+        "closed_at": "2024-06-13T05:29:13.602Z",
+        "closed_by": {
+            "id": 2,
+            "name": "Sam Bauch",
+            "username": "kenyatta_oconnell",
+            "state": "active",
+            "avatar_url": "https://www.gravatar.com/avatar/956c92487c6f6f7616b536927e22c9a0?s=80&d=identicon",
+            "web_url": "http://gitlab.example.com/kenyatta_oconnell",
+        },
+        "labels": [
+            "FakeCategory",
+            "fake:ml",
+        ],
+        "assignees": [
+            {
+                "id": 2,
+                "name": "Sam Bauch",
+                "username": "kenyatta_oconnell",
+                "state": "active",
+                "avatar_url": "https://www.gravatar.com/avatar/956c92487c6f6f7616b536927e22c9a0?s=80&d=identicon",
+                "web_url": "http://gitlab.example.com/kenyatta_oconnell",
+            }
+        ],
+        "author": {
+            "id": 2,
+            "name": "Sam Bauch",
+            "username": "kenyatta_oconnell",
+            "state": "active",
+            "avatar_url": "https://www.gravatar.com/avatar/956c92487c6f6f7616b536927e22c9a0?s=80&d=identicon",
+            "web_url": "http://gitlab.example.com//kenyatta_oconnell",
+        },
+        "type": "ISSUE",
+        "assignee": {
+            "id": 4459593,
+            "username": "fakeuser",
+            "name": "Fake User",
+            "state": "active",
+            "locked": False,
+            "avatar_url": "https://example.com/uploads/-/system/user/avatar/4459593/avatar.png",
+            "web_url": "https://example.com/fakeuser",
+        },
+        "user_notes_count": 9,
+        "merge_requests_count": 0,
+        "upvotes": 1,
+        "downvotes": 0,
+        "due_date": None,
+        "confidential": False,
+        "discussion_locked": None,
+        "issue_type": "issue",
+        "web_url": "https://example.com/fakeorg/fakeproject/-/issues/461536",
+        "time_stats": {
+            "time_estimate": 0,
+            "total_time_spent": 0,
+            "human_time_estimate": None,
+            "human_total_time_spent": None,
+        },
+        "task_completion_status": {"count": 0, "completed_count": 0},
+        "weight": None,
+        "blocking_issues_count": 0,
+    }
+]
+
 
 @pytest.fixture
 def resp_list_merge_requests():
@@ -93,6 +167,26 @@ def resp_get_merge_request_reviewers():
         yield rsps
 
 
+@pytest.fixture
+def resp_list_merge_requests_related_issues():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url="http://localhost/api/v4/projects/1/merge_requests/1",
+            json=mr_content,
+            content_type="application/json",
+            status=200,
+        )
+        rsps.add(
+            method=responses.GET,
+            url="http://localhost/api/v4/projects/1/merge_requests/1/related_issues",
+            json=related_issues,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 def test_list_project_merge_requests(project, resp_list_merge_requests):
     mrs = project.mergerequests.list()
     assert isinstance(mrs[0], ProjectMergeRequest)
@@ -115,3 +209,13 @@ def test_get_merge_request_reviewers(project, resp_get_merge_request_reviewers):
     assert mr.reviewers[0]["name"] == reviewers_details[0].user["name"]
     assert reviewers_details[0].state == "unreviewed"
     assert reviewers_details[0].created_at == "2022-07-27T17:03:27.684Z"
+
+
+def test_list_related_issues(project, resp_list_merge_requests_related_issues):
+    mr = project.mergerequests.get(1)
+    this_mr_related_issues = mr.related_issues()
+    the_issue = next(iter(this_mr_related_issues))
+    assert isinstance(mr, ProjectMergeRequest)
+    assert isinstance(this_mr_related_issues, RESTObjectList)
+    assert isinstance(the_issue, ProjectIssue)
+    assert the_issue.title == related_issues[0]["title"]

python_gitlab-4.12.0/tests/unit/objects/test_repositories.py

@@ -0,0 +1,96 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/repositories.html
+https://docs.gitlab.com/ee/api/repository_files.html
+"""
+
+from urllib.parse import quote
+
+import pytest
+import responses
+from requests.structures import CaseInsensitiveDict
+
+from gitlab.v4.objects import ProjectFile
+
+file_path = "app/models/key.rb"
+ref = "main"
+
+
+@pytest.fixture
+def resp_head_repository_file():
+    header_response = {
+        "Cache-Control": "no-cache",
+        "Content-Length": "0",
+        "Content-Type": "application/json",
+        "Date": "Thu, 12 Sep 2024 14:27:49 GMT",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Server": "nginx",
+        "Strict-Transport-Security": "max-age=63072000",
+        "Vary": "Origin",
+        "X-Content-Type-Options": "nosniff",
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-Gitlab-Blob-Id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
+        "X-Gitlab-Commit-Id": "d5a3ff139356ce33e37e73add446f16869741b50",
+        "X-Gitlab-Content-Sha256": "4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481",
+        "X-Gitlab-Encoding": "base64",
+        "X-Gitlab-Execute-Filemode": "false",
+        "X-Gitlab-File-Name": "key.rb",
+        "X-Gitlab-File-Path": file_path,
+        "X-Gitlab-Last-Commit-Id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d",
+        "X-Gitlab-Meta": '{"correlation_id":"01J7KFRPXBX65Y04HEH7MFX4GD","version":"1"}',
+        "X-Gitlab-Ref": ref,
+        "X-Gitlab-Size": "1476",
+        "X-Request-Id": "01J7KFRPXBX65Y04HEH7MFX4GD",
+        "X-Runtime": "0.083199",
+        "Connection": "keep-alive",
+    }
+    encoded_path = quote(file_path, safe="")
+
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.HEAD,
+            url=f"http://localhost/api/v4/projects/1/repository/files/{encoded_path}",
+            headers=header_response,
+            status=200,
+        )
+        yield rsps
+
+
+def test_head_repository_file(project, resp_head_repository_file):
+    headers = project.files.head(file_path, ref=ref)
+    assert isinstance(headers, CaseInsensitiveDict)
+    assert headers["X-Gitlab-File-Path"] == file_path
+
+
+@pytest.fixture
+def resp_get_repository_file():
+    file_response = {
+        "file_name": "key.rb",
+        "file_path": file_path,
+        "size": 1476,
+        "encoding": "base64",
+        "content": "IyA9PSBTY2hlbWEgSW5mb3...",
+        "content_sha256": "4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481",
+        "ref": ref,
+        "blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
+        "commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
+        "last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d",
+    }
+
+    encoded_path = quote(file_path, safe="")
+
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url=f"http://localhost/api/v4/projects/1/repository/files/{encoded_path}",
+            json=file_response,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+def test_get_repository_file(project, resp_get_repository_file):
+    file = project.files.get(file_path, ref=ref)
+    assert isinstance(file, ProjectFile)
+    assert file.file_path == file_path

python_gitlab-4.11.1/tests/unit/objects/test_repositories.py

@@ -1,49 +0,0 @@
-"""
-GitLab API:
-https://docs.gitlab.com/ee/api/repositories.html
-https://docs.gitlab.com/ee/api/repository_files.html
-"""
-
-from urllib.parse import quote
-
-import pytest
-import responses
-
-from gitlab.v4.objects import ProjectFile
-
-file_path = "app/models/key.rb"
-ref = "main"
-
-
-@pytest.fixture
-def resp_get_repository_file():
-    file_response = {
-        "file_name": "key.rb",
-        "file_path": file_path,
-        "size": 1476,
-        "encoding": "base64",
-        "content": "IyA9PSBTY2hlbWEgSW5mb3...",
-        "content_sha256": "4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481",
-        "ref": ref,
-        "blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
-        "commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
-        "last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d",
-    }
-
-    encoded_path = quote(file_path, safe="")
-
-    with responses.RequestsMock() as rsps:
-        rsps.add(
-            method=responses.GET,
-            url=f"http://localhost/api/v4/projects/1/repository/files/{encoded_path}",
-            json=file_response,
-            content_type="application/json",
-            status=200,
-        )
-        yield rsps
-
-
-def test_get_repository_file(project, resp_get_repository_file):
-    file = project.files.get(file_path, ref=ref)
-    assert isinstance(file, ProjectFile)
-    assert file.file_path == file_path