python-gitlab 8.2.0__tar.gz → 8.3.0__tar.gz

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All versions below are listed in reverse chronological order.
 
+## v8.3.0 (2026-04-28)
+
+### Bug Fixes
+
+- **api**: Update CI/CD variable create and update attributes
+  ([`849301b`](https://github.com/python-gitlab/python-gitlab/commit/849301b830b0d4f76ab85ffa3f39b22a6e628df9))
+
+- **mixins**: Register service account token classes in RotateMixin CLI actions
+  ([`2cf430b`](https://github.com/python-gitlab/python-gitlab/commit/2cf430b9c55c88f1d43fd31122a022dda0a88700))
+
+### Features
+
+- **api**: Add full service account support at instance, group, and project level
+  ([`feb6ced`](https://github.com/python-gitlab/python-gitlab/commit/feb6cedeffa75ef386ef13a3226bc07bcb396f61))
+
+
 ## v8.2.0 (2026-03-28)
 
 ### Documentation

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gitlab
-Version: 8.2.0
+Version: 8.3.0
 Summary: The python wrapper for the GitLab REST and GraphQL APIs.
 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-8.2.0 → python_gitlab-8.3.0}/docs/api-objects.rst

@@ -64,6 +64,7 @@ API examples
    gl_objects/resource_groups
    gl_objects/search
    gl_objects/secure_files
+   gl_objects/service_accounts
    gl_objects/settings
    gl_objects/snippets
    gl_objects/statistics

python_gitlab-8.3.0/docs/gl_objects/service_accounts.rst

@@ -0,0 +1,153 @@
+################
+Service Accounts
+################
+
+References
+----------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ServiceAccount`
+  + :class:`gitlab.v4.objects.ServiceAccountManager`
+  + :class:`gitlab.v4.objects.GroupServiceAccount`
+  + :class:`gitlab.v4.objects.GroupServiceAccountManager`
+  + :class:`gitlab.v4.objects.GroupServiceAccountAccessToken`
+  + :class:`gitlab.v4.objects.GroupServiceAccountAccessTokenManager`
+  + :class:`gitlab.v4.objects.ProjectServiceAccount`
+  + :class:`gitlab.v4.objects.ProjectServiceAccountManager`
+  + :class:`gitlab.v4.objects.ProjectServiceAccountAccessToken`
+  + :class:`gitlab.v4.objects.ProjectServiceAccountAccessTokenManager`
+
+* GitLab API: https://docs.gitlab.com/api/service_accounts/
+
+Instance service accounts
+-------------------------
+
+List instance service accounts::
+
+    accounts = gl.service_accounts.list()
+
+Create an instance service account::
+
+    sa = gl.service_accounts.create({})
+    # with optional attributes
+    sa = gl.service_accounts.create({"name": "my-bot", "username": "my-bot", "email": "my-bot@example.com"})
+
+Update an instance service account::
+
+    gl.service_accounts.update(sa.id, {"name": "renamed-bot"})
+    # or via the object
+    sa.name = "renamed-bot"
+    sa.save()
+
+Group service accounts
+----------------------
+
+List group service accounts::
+
+    accounts = group.service_accounts.list()
+
+Create a group service account::
+
+    sa = group.service_accounts.create({})
+    # with optional attributes
+    sa = group.service_accounts.create({"name": "ci-bot", "username": "ci-bot"})
+
+Update a group service account::
+
+    group.service_accounts.update(sa.id, {"name": "renamed-bot"})
+    # or via the object
+    sa.name = "renamed-bot"
+    sa.save()
+
+Delete a group service account::
+
+    group.service_accounts.delete(sa.id)
+    # or via the object
+    sa.delete()
+
+Group service account personal access tokens
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+List tokens for a group service account::
+
+    tokens = sa.access_tokens.list()
+
+Create a token for a group service account::
+
+    token = sa.access_tokens.create({
+        "name": "ci-token",
+        "scopes": ["api"],
+        "expires_at": "2026-01-01",
+    })
+    print(token.token)
+
+Rotate a token::
+
+    token.rotate()
+    print(token.token)
+    # or directly using a token ID
+    new_token = sa.access_tokens.rotate(token.id)
+    print(new_token["token"])
+
+Revoke a token::
+
+    sa.access_tokens.delete(token.id)
+    # or via the object
+    token.delete()
+
+Project service accounts
+------------------------
+
+List project service accounts::
+
+    accounts = project.service_accounts.list()
+
+Create a project service account::
+
+    sa = project.service_accounts.create({})
+    # with optional attributes
+    sa = project.service_accounts.create({"name": "ci-bot", "username": "ci-bot"})
+
+Update a project service account::
+
+    project.service_accounts.update(sa.id, {"name": "renamed-bot"})
+    # or via the object
+    sa.name = "renamed-bot"
+    sa.save()
+
+Delete a project service account::
+
+    project.service_accounts.delete(sa.id)
+    # or via the object
+    sa.delete()
+
+Project service account personal access tokens
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+List tokens for a project service account::
+
+    tokens = sa.access_tokens.list()
+
+Create a token for a project service account::
+
+    token = sa.access_tokens.create({
+        "name": "ci-token",
+        "scopes": ["read_repository"],
+        "expires_at": "2026-01-01",
+    })
+    print(token.token)
+
+Rotate a token::
+
+    token.rotate()
+    print(token.token)
+    # or directly using a token ID
+    new_token = sa.access_tokens.rotate(token.id)
+    print(new_token["token"])
+
+Revoke a token::
+
+    sa.access_tokens.delete(token.id)
+    # or via the object
+    token.delete()

{python_gitlab-8.2.0 → python_gitlab-8.3.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__ = "8.2.0"
+__version__ = "8.3.0"

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/gitlab/client.py

@@ -211,6 +211,8 @@ class Gitlab:
         """See :class:`~gitlab.v4.objects.PersonalAccessTokenManager`"""
         self.topics = objects.TopicManager(self)
         """See :class:`~gitlab.v4.objects.TopicManager`"""
+        self.service_accounts = objects.ServiceAccountManager(self)
+        """See :class:`~gitlab.v4.objects.ServiceAccountManager`"""
         self.statistics = objects.ApplicationStatisticsManager(self)
         """See :class:`~gitlab.v4.objects.ApplicationStatisticsManager`"""
 

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/gitlab/mixins.py

@@ -619,6 +619,8 @@ class RotateMixin(base.RESTManager[base.TObjCls]):
             "PersonalAccessTokenManager",
             "GroupAccessTokenManager",
             "ProjectAccessTokenManager",
+            "GroupServiceAccountAccessTokenManager",
+            "ProjectServiceAccountAccessTokenManager",
         ),
         optional=("expires_at",),
     )
@@ -656,7 +658,13 @@ class ObjectRotateMixin(_RestObjectBase):
     manager: base.RESTManager[Any]
 
     @cli.register_custom_action(
-        cls_names=("PersonalAccessToken", "GroupAccessToken", "ProjectAccessToken"),
+        cls_names=(
+            "PersonalAccessToken",
+            "GroupAccessToken",
+            "ProjectAccessToken",
+            "GroupServiceAccountAccessToken",
+            "ProjectServiceAccountAccessToken",
+        ),
         optional=("expires_at",),
     )
     @exc.on_http_error(exc.GitlabRotateError)

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/gitlab/v4/objects/projects.py

@@ -91,6 +91,7 @@ from .repositories import RepositoryMixin
 from .resource_groups import ProjectResourceGroupManager
 from .runners import ProjectRunnerManager  # noqa: F401
 from .secure_files import ProjectSecureFileManager  # noqa: F401
+from .service_accounts import ProjectServiceAccountManager  # noqa: F401
 from .snippets import ProjectSnippetManager  # noqa: F401
 from .statistics import (  # noqa: F401
     ProjectAdditionalStatisticsManager,
@@ -251,6 +252,7 @@ class Project(
     repositories: ProjectRegistryRepositoryManager
     runners: ProjectRunnerManager
     secure_files: ProjectSecureFileManager
+    service_accounts: ProjectServiceAccountManager
     services: ProjectServiceManager
     snippets: ProjectSnippetManager
     external_status_checks: ProjectExternalStatusCheckManager

python_gitlab-8.3.0/gitlab/v4/objects/service_accounts.py

@@ -0,0 +1,155 @@
+"""
+GitLab API: https://docs.gitlab.com/api/service_accounts/
+"""
+
+from gitlab.base import RESTObject
+from gitlab.mixins import (
+    CreateMixin,
+    DeleteMixin,
+    ListMixin,
+    ObjectDeleteMixin,
+    ObjectRotateMixin,
+    RotateMixin,
+    SaveMixin,
+    UpdateMethod,
+    UpdateMixin,
+)
+from gitlab.types import ArrayAttribute, RequiredOptional
+
+__all__ = [
+    "ServiceAccount",
+    "ServiceAccountManager",
+    "GroupServiceAccount",
+    "GroupServiceAccountManager",
+    "GroupServiceAccountAccessToken",
+    "GroupServiceAccountAccessTokenManager",
+    "ProjectServiceAccount",
+    "ProjectServiceAccountManager",
+    "ProjectServiceAccountAccessToken",
+    "ProjectServiceAccountAccessTokenManager",
+]
+
+_SA_ACCOUNT_ATTRS = RequiredOptional(optional=("name", "username", "email"))
+
+_SA_TOKEN_CREATE_ATTRS = RequiredOptional(
+    required=("name", "scopes"), optional=("description", "expires_at")
+)
+
+_SA_TOKEN_LIST_FILTERS = (
+    "created_after",
+    "created_before",
+    "expires_after",
+    "expires_before",
+    "last_used_after",
+    "last_used_before",
+    "revoked",
+    "search",
+    "sort",
+    "state",
+)
+
+
+# ---------------------------------------------------------------------------
+# Instance-level service accounts
+# ---------------------------------------------------------------------------
+
+
+class ServiceAccount(SaveMixin, RESTObject):
+    pass
+
+
+class ServiceAccountManager(
+    CreateMixin[ServiceAccount], ListMixin[ServiceAccount], UpdateMixin[ServiceAccount]
+):
+    _path = "/service_accounts"
+    _obj_cls = ServiceAccount
+    _create_attrs = _SA_ACCOUNT_ATTRS
+    _update_attrs = _SA_ACCOUNT_ATTRS
+    _update_method = UpdateMethod.PATCH
+    _list_filters = ("order_by", "sort")
+
+
+# ---------------------------------------------------------------------------
+# Group-level service accounts
+# ---------------------------------------------------------------------------
+
+
+class GroupServiceAccountAccessToken(ObjectDeleteMixin, ObjectRotateMixin, RESTObject):
+    pass
+
+
+class GroupServiceAccountAccessTokenManager(
+    CreateMixin[GroupServiceAccountAccessToken],
+    DeleteMixin[GroupServiceAccountAccessToken],
+    ListMixin[GroupServiceAccountAccessToken],
+    RotateMixin[GroupServiceAccountAccessToken],
+):
+    _path = "/groups/{group_id}/service_accounts/{user_id}/personal_access_tokens"
+    _obj_cls = GroupServiceAccountAccessToken
+    _from_parent_attrs = {"group_id": "group_id", "user_id": "id"}
+    _create_attrs = _SA_TOKEN_CREATE_ATTRS
+    _types = {"scopes": ArrayAttribute}
+    _list_filters = _SA_TOKEN_LIST_FILTERS
+
+
+class GroupServiceAccount(SaveMixin, ObjectDeleteMixin, RESTObject):
+    access_tokens: GroupServiceAccountAccessTokenManager
+
+
+class GroupServiceAccountManager(
+    CreateMixin[GroupServiceAccount],
+    DeleteMixin[GroupServiceAccount],
+    ListMixin[GroupServiceAccount],
+    UpdateMixin[GroupServiceAccount],
+):
+    _path = "/groups/{group_id}/service_accounts"
+    _obj_cls = GroupServiceAccount
+    _from_parent_attrs = {"group_id": "id"}
+    _create_attrs = _SA_ACCOUNT_ATTRS
+    _update_attrs = _SA_ACCOUNT_ATTRS
+    _update_method = UpdateMethod.PATCH
+    _list_filters = ("order_by", "sort")
+
+
+# ---------------------------------------------------------------------------
+# Project-level service accounts
+# ---------------------------------------------------------------------------
+
+
+class ProjectServiceAccountAccessToken(
+    ObjectDeleteMixin, ObjectRotateMixin, RESTObject
+):
+    pass
+
+
+class ProjectServiceAccountAccessTokenManager(
+    CreateMixin[ProjectServiceAccountAccessToken],
+    DeleteMixin[ProjectServiceAccountAccessToken],
+    ListMixin[ProjectServiceAccountAccessToken],
+    RotateMixin[ProjectServiceAccountAccessToken],
+):
+    _path = "/projects/{project_id}/service_accounts/{user_id}/personal_access_tokens"
+    _obj_cls = ProjectServiceAccountAccessToken
+    _from_parent_attrs = {"project_id": "project_id", "user_id": "id"}
+    _create_attrs = _SA_TOKEN_CREATE_ATTRS
+    _types = {"scopes": ArrayAttribute}
+    _list_filters = _SA_TOKEN_LIST_FILTERS
+
+
+class ProjectServiceAccount(SaveMixin, ObjectDeleteMixin, RESTObject):
+    access_tokens: ProjectServiceAccountAccessTokenManager
+
+
+class ProjectServiceAccountManager(
+    CreateMixin[ProjectServiceAccount],
+    DeleteMixin[ProjectServiceAccount],
+    ListMixin[ProjectServiceAccount],
+    UpdateMixin[ProjectServiceAccount],
+):
+    _path = "/projects/{project_id}/service_accounts"
+    _obj_cls = ProjectServiceAccount
+    _from_parent_attrs = {"project_id": "id"}
+    _create_attrs = _SA_ACCOUNT_ATTRS
+    _update_attrs = _SA_ACCOUNT_ATTRS
+    _update_method = UpdateMethod.PATCH
+    _list_filters = ("order_by", "sort")

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/gitlab/v4/objects/variables.py

@@ -27,10 +27,19 @@ class VariableManager(CRUDMixin[Variable]):
     _path = "/admin/ci/variables"
     _obj_cls = Variable
     _create_attrs = RequiredOptional(
-        required=("key", "value"), optional=("protected", "variable_type", "masked")
+        required=("key", "value"),
+        optional=("description", "masked", "protected", "raw", "variable_type"),
     )
     _update_attrs = RequiredOptional(
-        required=("key", "value"), optional=("protected", "variable_type", "masked")
+        required=("key",),
+        optional=(
+            "description",
+            "masked",
+            "protected",
+            "raw",
+            "value",
+            "variable_type",
+        ),
     )
 
 
@@ -43,10 +52,28 @@ class GroupVariableManager(CRUDMixin[GroupVariable]):
     _obj_cls = GroupVariable
     _from_parent_attrs = {"group_id": "id"}
     _create_attrs = RequiredOptional(
-        required=("key", "value"), optional=("protected", "variable_type", "masked")
+        required=("key", "value"),
+        optional=(
+            "description",
+            "environment_scope",
+            "masked",
+            "masked_and_hidden",
+            "protected",
+            "raw",
+            "variable_type",
+        ),
     )
     _update_attrs = RequiredOptional(
-        required=("key", "value"), optional=("protected", "variable_type", "masked")
+        required=("key",),
+        optional=(
+            "description",
+            "environment_scope",
+            "masked",
+            "protected",
+            "raw",
+            "value",
+            "variable_type",
+        ),
     )
 
 
@@ -60,9 +87,25 @@ class ProjectVariableManager(CRUDMixin[ProjectVariable]):
     _from_parent_attrs = {"project_id": "id"}
     _create_attrs = RequiredOptional(
         required=("key", "value"),
-        optional=("protected", "variable_type", "masked", "environment_scope"),
+        optional=(
+            "description",
+            "environment_scope",
+            "masked",
+            "masked_and_hidden",
+            "protected",
+            "raw",
+            "variable_type",
+        ),
     )
     _update_attrs = RequiredOptional(
-        required=("key", "value"),
-        optional=("protected", "variable_type", "masked", "environment_scope"),
+        required=("key",),
+        optional=(
+            "description",
+            "environment_scope",
+            "masked",
+            "protected",
+            "raw",
+            "value",
+            "variable_type",
+        ),
     )

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/python_gitlab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gitlab
-Version: 8.2.0
+Version: 8.3.0
 Summary: The python wrapper for the GitLab REST and GraphQL APIs.
 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-8.2.0 → python_gitlab-8.3.0}/python_gitlab.egg-info/SOURCES.txt

@@ -93,6 +93,7 @@ docs/gl_objects/resource_groups.rst
 docs/gl_objects/runners.rst
 docs/gl_objects/search.rst
 docs/gl_objects/secure_files.rst
+docs/gl_objects/service_accounts.rst
 docs/gl_objects/settings.rst
 docs/gl_objects/sidekiq.rst
 docs/gl_objects/snippets.rst
@@ -359,6 +360,7 @@ tests/unit/objects/test_resource_milestone_events.py
 tests/unit/objects/test_resource_state_events.py
 tests/unit/objects/test_runners.py
 tests/unit/objects/test_secure_files.py
+tests/unit/objects/test_service_accounts.py
 tests/unit/objects/test_services.py
 tests/unit/objects/test_snippets.py
 tests/unit/objects/test_statistics.py

python_gitlab-8.3.0/requirements-lint.txt

@@ -0,0 +1,14 @@
+-r requirements.txt
+argcomplete==2.0.0
+black==26.3.1
+commitizen==4.13.10
+flake8==7.3.0
+isort==8.0.1
+mypy==1.20.2
+pylint==4.0.5
+pytest==9.0.3
+responses==0.26.0
+respx==0.23.1
+types-PyYAML==6.0.12.20260408
+types-requests==2.33.0.20260408
+types-setuptools==82.0.0.20260408

python_gitlab-8.3.0/requirements-precommit.txt

@@ -0,0 +1 @@
+pre-commit==4.6.0

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/requirements-test.txt

@@ -1,13 +1,13 @@
 -r requirements.txt
-anyio==4.12.1
-build==1.4.0
+anyio==4.13.0
+build==1.4.4
 coverage==7.13.5
 pytest-console-scripts==1.4.1
 pytest-cov==7.1.0
 pytest-github-actions-annotate-failures==0.4.0
-pytest==9.0.2
+pytest==9.0.3
 PyYaml==6.0.3
 responses==0.26.0
-respx==0.22.0
+respx==0.23.1
 trio==0.33.0
-wheel==0.46.3
+wheel==0.47.0

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/requirements.txt

@@ -1,4 +1,4 @@
 gql==4.0.0
 httpx==0.28.1
-requests==2.33.0
+requests==2.33.1
 requests-toolbelt==1.0.0

{python_gitlab-8.2.0 → python_gitlab-8.3.0}/tests/functional/api/test_variables.py

@@ -43,3 +43,39 @@ def test_project_variables(project):
     assert variable.value == "new_value1"
 
     variable.delete()
+
+
+def test_hidden_group_variables(group):
+    variable = group.variables.create(
+        {"key": "key1", "value": "secret_value", "masked_and_hidden": True}
+    )
+
+    variable = group.variables.get(variable.key)
+    assert variable.value is None
+    assert variable.description is None
+    assert variable in group.variables.list()
+
+    variable.description = "new_description"
+    variable.save()
+    variable = group.variables.get(variable.key)
+    assert variable.description == "new_description"
+
+    variable.delete()
+
+
+def test_hidden_project_variables(project):
+    variable = project.variables.create(
+        {"key": "key1", "value": "secret_value", "masked_and_hidden": True}
+    )
+
+    variable = project.variables.get(variable.key)
+    assert variable.value is None
+    assert variable.description is None
+    assert variable in project.variables.list()
+
+    variable.description = "new_description"
+    variable.save()
+    variable = project.variables.get(variable.key)
+    assert variable.description == "new_description"
+
+    variable.delete()