python-gitlab/gitlab/v4/objects/features.py at main · python-gitlab/python-gitlab · GitHub

Repository navigation

History

68 lines (56 loc) · 1.91 KB

Raw

"""

GitLab API:

https://docs.gitlab.com/ee/api/features.html

"""

from __future__ import annotations

from typing import Any, TYPE_CHECKING

from gitlab import exceptions as exc

from gitlab import utils

from gitlab.base import RESTObject

from gitlab.mixins import DeleteMixin, ListMixin, ObjectDeleteMixin

__all__ = ["Feature", "FeatureManager"]

class Feature(ObjectDeleteMixin, RESTObject):

_id_attr = "name"

class FeatureManager(ListMixin[Feature], DeleteMixin[Feature]):

_path = "/features/"

_obj_cls = Feature

@exc.on_http_error(exc.GitlabSetError)

def set(

self,

name: str,

value: bool | int,

feature_group: str | None = None,

user: str | None = None,

group: str | None = None,

project: str | None = None,

**kwargs: Any,

) -> Feature:

"""Create or update the object.

Args:

name: The value to set for the object

value: The value to set for the object

feature_group: A feature group name

user: A GitLab username

group: A GitLab group

project: A GitLab project in form group/project

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabSetError: If an error occurred

Returns:

The created/updated attribute

"""

name = utils.EncodedId(name)

path = f"{self.path}/{name}"

data = {

"value": value,

"feature_group": feature_group,

"user": user,

"group": group,

"project": project,

}

data = utils.remove_none_from_dict(data)

server_data = self.gitlab.http_post(path, post_data=data, **kwargs)

if TYPE_CHECKING:

assert isinstance(server_data, dict)

return self._obj_cls(self, server_data)

python-gitlab/gitlab/v4/objects/features.py at main · python-gitlab/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

features.py

Latest commit

History

Breadcrumbs

features.py

File metadata and controls