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

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

@@ -2,6 +2,38 @@
 
 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
+
+- **testing**: Document passing pytest options during local development
+  ([`e6669f9`](https://github.com/python-gitlab/python-gitlab/commit/e6669f96d662d310109afa4a61fe8dabbd780a4e))
+
+### Features
+
+- **api**: Add support for project feature flags and feature flag user lists
+  ([`be68285`](https://github.com/python-gitlab/python-gitlab/commit/be68285793f35afc10a72b59da3fb24429631f54))
+
+- **projects**: Add optional parameter to set approval rule on all protected branches.
+  ([`8d76028`](https://github.com/python-gitlab/python-gitlab/commit/8d76028a1ae3554527291dc98e6be041ff089ec5))
+
+
 ## v8.1.0 (2026-02-28)
 
 ### Bug Fixes

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gitlab
-Version: 8.1.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.1.0 → python_gitlab-8.3.0}/docs/api-objects.rst

@@ -24,7 +24,7 @@ API examples
    gl_objects/environments
    gl_objects/events
    gl_objects/epics
-   gl_objects/features
+   gl_objects/gitlab_features
    gl_objects/geo_nodes
    gl_objects/groups
    gl_objects/group_access_tokens
@@ -49,6 +49,8 @@ API examples
    gl_objects/pipelines_and_jobs
    gl_objects/projects
    gl_objects/project_access_tokens
+   gl_objects/project_feature_flags
+   gl_objects/project_feature_flag_user_lists
    gl_objects/protected_branches
    gl_objects/protected_container_repositories
    gl_objects/protected_environments
@@ -62,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.1.0/docs/gl_objects/features.rst → python_gitlab-8.3.0/docs/gl_objects/gitlab_features.rst

@@ -1,6 +1,11 @@
-##############
-Features flags
-##############
+################################
+GitLab Development Feature Flags
+################################
+
+.. note::
+
+   This API is for managing GitLab's internal development feature flags and requires administrator access.
+   For project-level feature flags, see :doc:`project_feature_flags`.
 
 Reference
 ---------
@@ -29,4 +34,4 @@ Create or set a feature::
 
 Delete a feature::
 
-    feature.delete()
+    feature.delete()

python_gitlab-8.3.0/docs/gl_objects/project_feature_flag_user_lists.rst

@@ -0,0 +1,51 @@
+###############################
+Project Feature Flag User Lists
+###############################
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserList`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserListManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags_user_lists`
+
+* GitLab API: https://docs.gitlab.com/api/feature_flag_user_lists
+
+Examples
+--------
+
+List user lists::
+
+    user_lists = project.feature_flags_user_lists.list()
+
+Get a user list::
+
+    user_list = project.feature_flags_user_lists.get(list_iid)
+
+Create a user list::
+
+    user_list = project.feature_flags_user_lists.create({
+        'name': 'my_user_list',
+        'user_xids': 'user1,user2,user3'
+    })
+
+Update a user list::
+
+    user_list.name = 'updated_list_name'
+    user_list.user_xids = 'user1,user2'
+    user_list.save()
+
+Delete a user list::
+
+    user_list.delete()
+
+Search for a user list::
+
+    user_lists = project.feature_flags_user_lists.list(search='my_list')
+
+See also
+--------
+
+* :doc:`project_feature_flags`

python_gitlab-8.3.0/docs/gl_objects/project_feature_flags.rst

@@ -0,0 +1,63 @@
+#####################
+Project Feature Flags
+#####################
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlag`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags`
+
+* GitLab API: https://docs.gitlab.com/api/feature_flags
+
+Examples
+--------
+
+List feature flags::
+
+    flags = project.feature_flags.list()
+
+Get a feature flag::
+
+    flag = project.feature_flags.get('my_feature_flag')
+
+Create a feature flag::
+
+    flag = project.feature_flags.create({'name': 'my_feature_flag', 'version': 'new_version_flag'})
+
+Create a feature flag with strategies::
+
+    flag = project.feature_flags.create({
+        'name': 'my_complex_flag',
+        'version': 'new_version_flag',
+        'strategies': [{
+            'name': 'userWithId',
+            'parameters': {'userIds': 'user1,user2'}
+        }]
+    })
+
+Update a feature flag::
+
+    flag.description = 'Updated description'
+    flag.save()
+
+Rename a feature flag::
+
+    # You can rename a flag by changing its name attribute and calling save()
+    flag.name = 'new_flag_name'
+    flag.save()
+
+    # Alternatively, you can use the manager's update method
+    project.feature_flags.update('old_flag_name', {'name': 'new_flag_name'})
+
+Delete a feature flag::
+
+    flag.delete()
+
+See also
+--------
+
+* :doc:`project_feature_flag_user_lists`

{python_gitlab-8.1.0 → python_gitlab-8.3.0}/docs/gl_objects/projects.rst

@@ -409,6 +409,44 @@ Search projects by custom attribute::
     project.customattributes.set('type', 'internal')
     gl.projects.list(custom_attributes={'type': 'internal'}, get_all=True)
 
+Project feature flags
+=====================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlag`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags`
+
+* GitLab API: https://docs.gitlab.com/api/feature_flags
+
+Examples
+--------
+
+See :doc:`project_feature_flags`.
+
+Project feature flag user lists
+===============================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserList`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserListManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags_user_lists`
+
+* GitLab API: https://docs.gitlab.com/api/feature_flag_user_lists
+
+Examples
+--------
+
+See :doc:`project_feature_flag_user_lists`.
+
 Project files
 =============
 

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.1.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.1.0"
+__version__ = "8.3.0"

{python_gitlab-8.1.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.1.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.1.0 → python_gitlab-8.3.0}/gitlab/types.py

@@ -1,8 +1,11 @@
 from __future__ import annotations
 
 import dataclasses
+import json
 from typing import Any, TYPE_CHECKING
 
+from gitlab import exceptions
+
 
 @dataclasses.dataclass(frozen=True)
 class RequiredOptional:
@@ -36,6 +39,13 @@ class RequiredOptional:
 
 
 class GitlabAttribute:
+    # Used in utils._transform_types() to decide if we should call get_for_api()
+    # on the attribute when transform_data is False (e.g. for POST/PUT/PATCH).
+    #
+    # This allows us to force transformation of data even when sending JSON bodies,
+    # which is useful for types like CommaSeparatedStringAttribute.
+    transform_in_body = False
+
     def __init__(self, value: Any = None) -> None:
         self._value = value
 
@@ -49,6 +59,16 @@ class GitlabAttribute:
         return (key, self._value)
 
 
+class JsonAttribute(GitlabAttribute):
+    def set_from_cli(self, cli_value: str) -> None:
+        try:
+            self._value = json.loads(cli_value)
+        except (ValueError, TypeError) as e:
+            raise exceptions.GitlabParsingError(
+                f"Could not parse JSON data: {e}"
+            ) from e
+
+
 class _ListArrayAttribute(GitlabAttribute):
     """Helper class to support `list` / `array` types."""
 
@@ -82,9 +102,23 @@ class ArrayAttribute(_ListArrayAttribute):
 
 
 class CommaSeparatedListAttribute(_ListArrayAttribute):
-    """For values which are sent to the server as a Comma Separated Values
-    (CSV) string.  We allow them to be specified as a list and we convert it
-    into a CSV"""
+    """
+    For values which are sent to the server as a Comma Separated Values (CSV) string
+    in query parameters (GET), but as a list/array in JSON bodies (POST/PUT).
+    """
+
+
+class CommaSeparatedStringAttribute(_ListArrayAttribute):
+    """
+    For values which are sent to the server as a Comma Separated Values (CSV) string.
+    Unlike CommaSeparatedListAttribute, this type ensures the value is converted
+    to a string even in JSON bodies (POST/PUT requests).
+    """
+
+    # Used in utils._transform_types() to ensure the value is converted to a string
+    # via get_for_api() even when transform_data is False (e.g. for POST/PUT/PATCH).
+    # This is needed because some APIs require a CSV string instead of a JSON array.
+    transform_in_body = True
 
 
 class LowercaseStringAttribute(GitlabAttribute):

{python_gitlab-8.1.0 → python_gitlab-8.3.0}/gitlab/utils.py

@@ -198,7 +198,15 @@ def _transform_types(
             files[attr_name] = (key, data.pop(attr_name))
             continue
 
-        if not transform_data:
+        # If transform_data is False, it means we are preparing data for a JSON body
+        # (POST/PUT/PATCH). In this case, we normally skip transformation because
+        # most types (like ArrayAttribute) only need transformation for query
+        # parameters (GET).
+        #
+        # However, some types (like CommaSeparatedStringAttribute) need to be
+        # transformed even in JSON bodies (e.g. converting a list to a CSV string).
+        # The 'transform_in_body' flag on the attribute class controls this behavior.
+        if not transform_data and not gitlab_attribute.transform_in_body:
             continue
 
         if isinstance(gitlab_attribute, types.GitlabAttribute):

{python_gitlab-8.1.0 → python_gitlab-8.3.0}/gitlab/v4/objects/__init__.py

@@ -24,6 +24,8 @@ from .environments import *
 from .epics import *
 from .events import *
 from .export_import import *
+from .feature_flag_user_lists import *
+from .feature_flags import *
 from .features import *
 from .files import *
 from .geo_nodes import *

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

@@ -0,0 +1,27 @@
+"""
+GitLab API:
+https://docs.gitlab.com/api/feature_flag_user_lists
+"""
+
+from __future__ import annotations
+
+from gitlab import types
+from gitlab.base import RESTObject
+from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
+from gitlab.types import RequiredOptional
+
+__all__ = ["ProjectFeatureFlagUserList", "ProjectFeatureFlagUserListManager"]
+
+
+class ProjectFeatureFlagUserList(SaveMixin, ObjectDeleteMixin, RESTObject):
+    _id_attr = "iid"
+
+
+class ProjectFeatureFlagUserListManager(CRUDMixin[ProjectFeatureFlagUserList]):
+    _path = "/projects/{project_id}/feature_flags_user_lists"
+    _obj_cls = ProjectFeatureFlagUserList
+    _from_parent_attrs = {"project_id": "id"}
+    _create_attrs = RequiredOptional(required=("name", "user_xids"))
+    _update_attrs = RequiredOptional(optional=("name", "user_xids"))
+    _list_filters = ("search",)
+    _types = {"user_xids": types.CommaSeparatedStringAttribute}

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

@@ -0,0 +1,106 @@
+"""
+GitLab API:
+https://docs.gitlab.com/api/feature_flags
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from gitlab import types, utils
+from gitlab.base import RESTObject
+from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
+from gitlab.types import RequiredOptional
+
+__all__ = ["ProjectFeatureFlag", "ProjectFeatureFlagManager"]
+
+
+class ProjectFeatureFlag(SaveMixin, ObjectDeleteMixin, RESTObject):
+    _id_attr = "name"
+    manager: ProjectFeatureFlagManager
+
+    def _get_save_url_id(self) -> str | int | None:
+        """Get the ID used to construct the API URL for the save operation.
+
+        For renames, this must be the *original* name of the flag. For other
+        updates, it is the current name.
+        """
+        if self._id_attr in self._updated_attrs:
+            # If the name is being changed, use the original name for the URL.
+            obj_id = self._attrs.get(self._id_attr)
+            if isinstance(obj_id, str):
+                return utils.EncodedId(obj_id)
+            return obj_id
+        return self.encoded_id
+
+    def save(self, **kwargs: Any) -> dict[str, Any] | None:
+        """Save the changes made to the object to the server.
+
+        This is the standard method to use when updating a feature flag object
+        that you have already retrieved.
+
+        It is overridden here to correctly handle renaming. When `name` is
+        changed, the API requires the *original* name in the URL, and this
+        method provides it.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Returns:
+            The new object data (*not* a RESTObject)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabUpdateError: If the server cannot perform the request
+        """
+        updated_data = self._get_updated_data()
+        if not updated_data:
+            return None
+
+        obj_id = self._get_save_url_id()
+        server_data = self.manager.update(obj_id, updated_data, **kwargs)
+        self._update_attrs(server_data)
+        return server_data
+
+
+class ProjectFeatureFlagManager(CRUDMixin[ProjectFeatureFlag]):
+    _path = "/projects/{project_id}/feature_flags"
+    _obj_cls = ProjectFeatureFlag
+    _from_parent_attrs = {"project_id": "id"}
+    _create_attrs = RequiredOptional(
+        required=("name",), optional=("version", "description", "active", "strategies")
+    )
+    _update_attrs = RequiredOptional(
+        # new_name is used for renaming via CLI and mapped to 'name' in update()
+        optional=("name", "new_name", "description", "active", "strategies")
+    )
+    _list_filters = ("scope",)
+    _types = {"strategies": types.JsonAttribute}
+
+    def update(
+        self,
+        id: str | int | None = None,
+        new_data: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> dict[str, Any]:
+        """Update a Project Feature Flag.
+
+        This is a lower-level method called by `ProjectFeatureFlag.save()` and
+        is also used directly by the CLI.
+
+        The `new_name` parameter is a special case to support renaming via the
+        CLI (`--new-name`). It is converted to the `name` parameter that the
+        GitLab API expects in the request body.
+
+        Args:
+            id: The current name of the feature flag.
+            new_data: The dictionary of attributes to update.
+            **kwargs: Extra options to send to the server (e.g. sudo)
+        """
+        # Avoid mutating the caller-provided new_data dict by working on a copy.
+        data = dict(new_data or {})
+        # When used via CLI, we have 'new_name' to distinguish from the ID 'name'.
+        # When used via .save(), the object passes 'name' directly in new_data.
+        if "new_name" in data:
+            data["name"] = data.pop("new_name")
+        return super().update(id, data, **kwargs)