Jan 26, 2024 · Jan 29, 2024 · Jan 29, 2024 · Jan 29, 2024 · Feb 5, 2024 · Feb 5, 2024
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
          TOXENV: docs
        run: tox
      - name: Archive generated docs
        uses: actions/upload-artifact@v4.1.0
        uses: actions/upload-artifact@v4.3.1
        with:
          name: html-docs
          path: build/sphinx/html/
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml

    - name: Python Semantic Release
      id: release
      uses: python-semantic-release/python-semantic-release@v8.7.2
      uses: python-semantic-release/python-semantic-release@v9.0.3
      with:
        github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
          TOXENV: ${{ matrix.toxenv }}
        run: tox -- --override-ini='log_cli=True'
      - name: Upload codecov coverage
        uses: codecov/codecov-action@v3.1.4
        uses: codecov/codecov-action@v4.0.1
        with:
          files: ./coverage.xml
          flags: ${{ matrix.toxenv }}
          TOXENV: cover
        run: tox
      - name: Upload codecov coverage
        uses: codecov/codecov-action@v3.1.4
        uses: codecov/codecov-action@v4.0.1
        with:
          files: ./coverage.xml
          flags: unit
        pip install -r requirements-test.txt
    - name: Build package
      run: python -m build -o dist/
    - uses: actions/upload-artifact@v4.1.0
    - uses: actions/upload-artifact@v4.3.1
      with:
        name: dist
        path: dist
      uses: actions/setup-python@v5.0.0
      with:
        python-version: '3.12'
    - uses: actions/download-artifact@v4.1.1
    - uses: actions/download-artifact@v4.1.2
      with:
        name: dist
        path: dist
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml

 repos:
  - repo: https://github.com/psf/black
    rev:23.12.1
    rev:24.1.1
    hooks:
      - id: black
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v3.13.0
    rev: v3.14.1
    hooks:
      - id: commitizen
        stages: [commit-msg]
      - id: rst-directive-colons
      - id: rst-inline-touching-normal
  - repo: https://github.com/maxbrunet/pre-commit-renovate
    rev: 37.131.0
    rev: 37.183.0
    hooks:
      - id: renovate-config-validator
diff --git a/docs/gl_objects/protected_branches.rst b/docs/gl_objects/protected_branches.rst

    p_branch = project.protectedbranches.get('main')

 Update a protected branch:

    p_branch.allow_force_push = True
    p_branch.save()

 Create a protected branch::

    p_branch = project.protectedbranches.create({
diff --git a/gitlab/_backends/protocol.py b/gitlab/_backends/protocol.py

 class BackendResponse(Protocol):
    @abc.abstractmethod
    def __init__(self, response: requests.Response) -> None:
        ...
    def __init__(self, response: requests.Response) -> None: ...


 class Backend(Protocol):
        verify: Optional[Union[bool, str]],
        stream: Optional[bool],
        **kwargs: Any,
    ) -> BackendResponse:
        ...
    ) -> BackendResponse: ...
diff --git a/gitlab/client.py b/gitlab/client.py


 class Gitlab:

    """Represents a GitLab server connection.

    Args:
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py
                sub_parser_action.add_argument(
                    f"--{x.replace('_', '-')}", required=False
                )
            if mgr_cls._create_attrs.exclusive:
                group = sub_parser_action.add_mutually_exclusive_group()
                for x in mgr_cls._create_attrs.exclusive:
                    group.add_argument(f"--{x.replace('_', '-')}")

        if action_name == "update":
            if cls._id_attr is not None:
                        f"--{x.replace('_', '-')}", required=False
                    )

            if mgr_cls._update_attrs.exclusive:
                group = sub_parser_action.add_mutually_exclusive_group()
                for x in mgr_cls._update_attrs.exclusive:
                    group.add_argument(f"--{x.replace('_', '-')}")

    if cls.__name__ in cli.custom_actions:
        name = cls.__name__
        for action_name in cli.custom_actions[name]:
diff --git a/gitlab/v4/objects/artifacts.py b/gitlab/v4/objects/artifacts.py
 GitLab API:
 https://docs.gitlab.com/ee/api/job_artifacts.html
 """

 from typing import Any, Callable, Iterator, Optional, TYPE_CHECKING, Union

 import requests

        Args:
            ref_name: Branch or tag name in repository. HEAD or SHA references
            are not supported.
 are not supported.
            job: The name of the job.
            job_token: Job token for multi-project pipeline triggers.
            streamed: If True the data will be processed by chunks of
diff --git a/gitlab/v4/objects/audit_events.py b/gitlab/v4/objects/audit_events.py
 GitLab API:
 https://docs.gitlab.com/ee/api/audit_events.html
 """

 from typing import Any, cast, Union

 from gitlab.base import RESTManager, RESTObject
diff --git a/gitlab/v4/objects/branches.py b/gitlab/v4/objects/branches.py
 from typing import Any, cast, Union

 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin
 from gitlab.mixins import (
    CRUDMixin,
    NoUpdateMixin,
    ObjectDeleteMixin,
    SaveMixin,
    UpdateMethod,
 )
 from gitlab.types import RequiredOptional

 __all__ = [
        return cast(ProjectBranch, super().get(id=id, lazy=lazy, **kwargs))


 class ProjectProtectedBranch(ObjectDeleteMixin, RESTObject):
 class ProjectProtectedBranch(SaveMixin,ObjectDeleteMixin, RESTObject):
    _id_attr = "name"


 class ProjectProtectedBranchManager(NoUpdateMixin, RESTManager):
 class ProjectProtectedBranchManager(CRUDMixin, RESTManager):
    _path = "/projects/{project_id}/protected_branches"
    _obj_cls = ProjectProtectedBranch
    _from_parent_attrs = {"project_id": "id"}
            "code_owner_approval_required",
        ),
    )
    _update_method = UpdateMethod.PATCH

    def get(
        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
diff --git a/gitlab/v4/objects/deployments.py b/gitlab/v4/objects/deployments.py
 GitLab API:
 https://docs.gitlab.com/ee/api/deployments.html
 """

 from typing import Any, cast, Dict, Optional, TYPE_CHECKING, Union

 from gitlab import cli
diff --git a/gitlab/v4/objects/features.py b/gitlab/v4/objects/features.py
 GitLab API:
 https://docs.gitlab.com/ee/api/features.html
 """

 from typing import Any, Optional, TYPE_CHECKING, Union

 from gitlab import exceptions as exc
diff --git a/gitlab/v4/objects/job_token_scope.py b/gitlab/v4/objects/job_token_scope.py
 )
 from gitlab.types import RequiredOptional


 __all__ = [
    "ProjectJobTokenScope",
    "ProjectJobTokenScopeManager",
diff --git a/gitlab/v4/objects/jobs.py b/gitlab/v4/objects/jobs.py
            GitlabJobPlayError: If the job could not be triggered
        """
        path = f"{self.manager.path}/{self.encoded_id}/play"
        self.manager.gitlab.http_post(path, **kwargs)
        result = self.manager.gitlab.http_post(path, **kwargs)
        if TYPE_CHECKING:
            assert isinstance(result, dict)
        self._update_attrs(result)

    @cli.register_custom_action("ProjectJob")
    @exc.on_http_error(exc.GitlabJobEraseError)
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
 https://docs.gitlab.com/ee/api/merge_requests.html
 https://docs.gitlab.com/ee/api/merge_request_approvals.html
 """

 from typing import Any, cast, Dict, Optional, TYPE_CHECKING, Union

 import requests
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
 GitLab API:
 https://docs.gitlab.com/ee/api/projects.html
 """

 from typing import (
    Any,
    Callable,
diff --git a/gitlab/v4/objects/repositories.py b/gitlab/v4/objects/repositories.py

 Currently this module only contains repository-related methods for projects.
 """

 from typing import Any, Callable, Dict, Iterator, List, Optional, TYPE_CHECKING, Union

 import requests
diff --git a/gitlab/v4/objects/secure_files.py b/gitlab/v4/objects/secure_files.py
 GitLab API:
 https://docs.gitlab.com/ee/api/secure_files.html
 """

 from typing import Any, Callable, cast, Iterator, Optional, TYPE_CHECKING, Union

 import requests
diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py
 https://docs.gitlab.com/ee/api/users.html
 https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user
 """

 from typing import Any, cast, Dict, List, Optional, Union

 import requests
diff --git a/gitlab/v4/objects/variables.py b/gitlab/v4/objects/variables.py
 https://docs.gitlab.com/ee/api/project_level_variables.html
 https://docs.gitlab.com/ee/api/group_level_variables.html
 """

 from typing import Any, cast, Union

 from gitlab.base import RESTManager, RESTObject
diff --git a/requirements-docker.txt b/requirements-docker.txt
 -r requirements.txt
 -r requirements-test.txt
 pytest-docker==2.0.1
 pytest-docker==3.1.1
diff --git a/requirements-docs.txt b/requirements-docs.txt
 -r requirements.txt
 furo==2023.9.10
 furo==2024.1.29
 jinja2==3.1.3
 myst-parser==2.0.0
 sphinx==7.2.6
diff --git a/requirements-lint.txt b/requirements-lint.txt
 -r requirements.txt
 argcomplete==2.0.0
 black==23.12.1
 commitizen==3.13.0
 black==24.1.1
 commitizen==3.14.1
 flake8==7.0.0
 isort==5.13.2
 mypy==1.8.0
 pylint==3.0.3
 pytest==7.4.4
 pytest==8.0.0
 responses==0.24.1
 types-PyYAML==6.0.12.12
 types-requests==2.31.0.20240106
 types-setuptools==69.0.0.20240106
 types-requests==2.31.0.20240125
 types-setuptools==69.0.0.20240125
diff --git a/requirements-precommit.txt b/requirements-precommit.txt
 pre-commit==3.6.0
 pre-commit==3.6.1
diff --git a/requirements-test.txt b/requirements-test.txt
 -r requirements.txt
 build==1.0.3
 coverage==7.4.0
 coverage==7.4.1
 pytest-console-scripts==1.4.1
 pytest-cov==4.1.0
 pytest-github-actions-annotate-failures==0.2.0
 pytest==7.4.4
 pytest==8.0.0
 PyYaml==6.0.1
 responses==0.24.1
 wheel==0.42.0
diff --git a/tests/functional/api/test_keys.py b/tests/functional/api/test_keys.py
 GitLab API:
 https://docs.gitlab.com/ce/api/keys.html
 """

 import base64
 import hashlib

diff --git a/tests/functional/api/test_packages.py b/tests/functional/api/test_packages.py
 https://docs.gitlab.com/ce/api/packages.html
 https://docs.gitlab.com/ee/user/packages/generic_packages
 """

 from collections.abc import Iterator

 from gitlab.v4.objects import GenericPackage
diff --git a/tests/functional/api/test_project_job_token_scope.py b/tests/functional/api/test_project_job_token_scope.py
 import pytest


 # TODO: can be enabled when https://github.com/python-gitlab/python-gitlab/pull/2790 merged
 @pytest.mark.xfail(reason="project job_token_scope api only in 16.*")
 def test_add_project_to_job_token_scope_allowlist(gl, project):
    project_to_add = gl.projects.create({"name": "Ci_Cd_token_add_proj"})

    scope = project.job_token_scope.get()
    resp = scope.allowlist.create({"target_project_id": project_to_add.id})

    assert resp.source_project_id == project.id
    assert resp.target_project_id == project_to_add.id

    project_to_add.delete()


 @pytest.mark.xfail(reason="project job_token_scope api only in 16.*")
 def test_projects_job_token_scope_allowlist_contains_added_project_name(gl, project):
    scope = project.job_token_scope.get()
    assert len(scope.allowlist.list()) == 0

    project_name = "Ci_Cd_token_named_proj"
    project_to_add = gl.projects.create({"name": project_name})
    scope.allowlist.create({"target_project_id": project_to_add.id})

    scope.refresh()
    assert any(allowed.name == project_name for allowed in scope.allowlist.list())

    project_to_add.delete()


 @pytest.mark.xfail(reason="project job_token_scope api only in 16.*")
 def test_remove_project_by_id_from_projects_job_token_scope_allowlist(gl, project):
    scope = project.job_token_scope.get()
    assert len(scope.allowlist.list()) == 0

    project_to_add = gl.projects.create({"name": "Ci_Cd_token_remove_proj"})

    scope.allowlist.create({"target_project_id": project_to_add.id})

    scope.refresh()
    assert len(scope.allowlist.list()) != 0

    scope.allowlist.remove(project_to_add.id)

    scope.refresh()
    assert len(scope.allowlist.list()) == 0

    project_to_add.delete()
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,7 +34,7 @@ jobs:
		TOXENV: docs
		run: tox
		- name: Archive generated docs
		uses: actions/upload-artifact@v4.1.0
		uses: actions/upload-artifact@v4.3.1
		with:
		name: html-docs
		path: build/sphinx/html/
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,7 +21,7 @@ jobs:

		- name: Python Semantic Release
		id: release
		uses: python-semantic-release/python-semantic-release@v8.7.2
		uses: python-semantic-release/python-semantic-release@v9.0.3
		with:
		github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -78,7 +78,7 @@ jobs:
		TOXENV: ${{ matrix.toxenv }}
		run: tox -- --override-ini='log_cli=True'
		- name: Upload codecov coverage
		uses: codecov/codecov-action@v3.1.4
		uses: codecov/codecov-action@v4.0.1
		with:
		files: ./coverage.xml
		flags: ${{ matrix.toxenv }}
Expand All		@@ -100,7 +100,7 @@ jobs:
		TOXENV: cover
		run: tox
		- name: Upload codecov coverage
		uses: codecov/codecov-action@v3.1.4
		uses: codecov/codecov-action@v4.0.1
		with:
		files: ./coverage.xml
		flags: unit
Expand All		@@ -119,7 +119,7 @@ jobs:
		pip install -r requirements-test.txt
		- name: Build package
		run: python -m build -o dist/
		- uses: actions/upload-artifact@v4.1.0
		- uses: actions/upload-artifact@v4.3.1
		with:
		name: dist
		path: dist
Expand All		@@ -133,7 +133,7 @@ jobs:
		uses: actions/setup-python@v5.0.0
		with:
		python-version: '3.12'
		- uses: actions/download-artifact@v4.1.1
		- uses: actions/download-artifact@v4.1.2
		with:
		name: dist
		path: dist
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,11 +3,11 @@ default_language_version:

		repos:
		- repo: https://github.com/psf/black
		rev:23.12.1
		rev:24.1.1
		hooks:
		- id: black
		- repo: https://github.com/commitizen-tools/commitizen
		rev: v3.13.0
		rev: v3.14.1
		hooks:
		- id: commitizen
		stages: [commit-msg]
Expand DownExpand Up		@@ -47,6 +47,6 @@ repos:
		- id: rst-directive-colons
		- id: rst-inline-touching-normal
		- repo: https://github.com/maxbrunet/pre-commit-renovate
		rev: 37.131.0
		rev: 37.183.0
		hooks:
		- id: renovate-config-validator
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,6 +27,11 @@ Get a single protected branch::

		p_branch = project.protectedbranches.get('main')

		Update a protected branch:

		p_branch.allow_force_push = True
		p_branch.save()

		Create a protected branch::

		p_branch = project.protectedbranches.create({
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,8 +13,7 @@

		class BackendResponse(Protocol):
		@abc.abstractmethod
		def __init__(self, response: requests.Response) -> None:
		...
		def __init__(self, response: requests.Response) -> None: ...


		class Backend(Protocol):
Expand All		@@ -30,5 +29,4 @@ def http_request(
		verify: Optional[Union[bool, str]],
		stream: Optional[bool],
		**kwargs: Any,
		) -> BackendResponse:
		...
		) -> BackendResponse: ...
Original file line number	Diff line number	Diff line change
Expand Up		@@ -40,7 +40,6 @@


		class Gitlab:

		"""Represents a GitLab server connection.

		Args:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -262,6 +262,10 @@ def _populate_sub_parser_by_class(
		sub_parser_action.add_argument(
		f"--{x.replace('_', '-')}", required=False
		)
		if mgr_cls._create_attrs.exclusive:
		group = sub_parser_action.add_mutually_exclusive_group()
		for x in mgr_cls._create_attrs.exclusive:
		group.add_argument(f"--{x.replace('_', '-')}")

		if action_name == "update":
		if cls._id_attr is not None:
Expand All		@@ -280,6 +284,11 @@ def _populate_sub_parser_by_class(
		f"--{x.replace('_', '-')}", required=False
		)

		if mgr_cls._update_attrs.exclusive:
		group = sub_parser_action.add_mutually_exclusive_group()
		for x in mgr_cls._update_attrs.exclusive:
		group.add_argument(f"--{x.replace('_', '-')}")

		if cls.__name__ in cli.custom_actions:
		name = cls.__name__
		for action_name in cli.custom_actions[name]:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,6 +2,7 @@
		GitLab API:
		https://docs.gitlab.com/ee/api/job_artifacts.html
		"""

		from typing import Any, Callable, Iterator, Optional, TYPE_CHECKING, Union

		import requests
Expand DownExpand Up		@@ -61,7 +62,7 @@ def download(

		Args:
		ref_name: Branch or tag name in repository. HEAD or SHA references
		are not supported.
		are not supported.
		job: The name of the job.
		job_token: Job token for multi-project pipeline triggers.
		streamed: If True the data will be processed by chunks of
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,7 +1,13 @@
		from typing import Any, cast, Union

		from gitlab.base import RESTManager, RESTObject
		from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin
		from gitlab.mixins import (
		CRUDMixin,
		NoUpdateMixin,
		ObjectDeleteMixin,
		SaveMixin,
		UpdateMethod,
		)
		from gitlab.types import RequiredOptional

		__all__ = [
Expand All		@@ -28,11 +34,11 @@ def get(
		return cast(ProjectBranch, super().get(id=id, lazy=lazy, **kwargs))


		class ProjectProtectedBranch(ObjectDeleteMixin, RESTObject):
		class ProjectProtectedBranch(SaveMixin,ObjectDeleteMixin, RESTObject):
		_id_attr = "name"


		class ProjectProtectedBranchManager(NoUpdateMixin, RESTManager):
		class ProjectProtectedBranchManager(CRUDMixin, RESTManager):
		_path = "/projects/{project_id}/protected_branches"
		_obj_cls = ProjectProtectedBranch
		_from_parent_attrs = {"project_id": "id"}
Expand All		@@ -49,6 +55,7 @@ class ProjectProtectedBranchManager(NoUpdateMixin, RESTManager):
		"code_owner_approval_required",
		),
		)
		_update_method = UpdateMethod.PATCH

		def get(
		self, id: Union[str, int], lazy: bool = False, **kwargs: Any
Expand Down