python-gitlab/gitlab/v4/objects/ldap.py at feat/graphql · python-gitlab/python-gitlab · GitHub

Repository navigation

History

52 lines (40 loc) · 1.62 KB

Raw

from typing import Any, List, Union

from gitlab import exceptions as exc

from gitlab.base import RESTManager, RESTObject, RESTObjectList

__all__ = [

"LDAPGroup",

"LDAPGroupManager",

]

class LDAPGroup(RESTObject):

_id_attr = None

class LDAPGroupManager(RESTManager):

_path = "/ldap/groups"

_obj_cls = LDAPGroup

_list_filters = ("search", "provider")

@exc.on_http_error(exc.GitlabListError)

def list(self, **kwargs: Any) -> Union[List[LDAPGroup], RESTObjectList]:

"""Retrieve a list of objects.

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)

iterator: If set to True and no pagination option is

defined, return a generator instead of a list

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

Returns:

The list of objects, or a generator if `iterator` is True

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabListError: If the server cannot perform the request

"""

data = kwargs.copy()

if self.gitlab.per_page:

data.setdefault("per_page", self.gitlab.per_page)

if "provider" in data:

path = f"/ldap/{data['provider']}/groups"

else:

path = self._path

obj = self.gitlab.http_list(path, **data)

if isinstance(obj, list):

return [self._obj_cls(self, item) for item in obj]

return RESTObjectList(self, self._obj_cls, obj)

python-gitlab/gitlab/v4/objects/ldap.py at feat/graphql · python-gitlab/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

ldap.py

Latest commit

History

Breadcrumbs

ldap.py

File metadata and controls