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

Repository navigation

43 lines (33 loc) · 1.3 KB

from typing import Any, TYPE_CHECKING

from gitlab import cli

from gitlab import exceptions as exc

from gitlab.base import RESTObject

from gitlab.mixins import RetrieveMixin

from gitlab.utils import EncodedId

__all__ = ["Namespace", "NamespaceManager"]

class Namespace(RESTObject):

pass

class NamespaceManager(RetrieveMixin[Namespace]):

_path = "/namespaces"

_obj_cls = Namespace

_list_filters = ("search",)

@cli.register_custom_action(

cls_names="NamespaceManager", required=("namespace", "parent_id")

)

@exc.on_http_error(exc.GitlabGetError)

def exists(self, namespace: str, **kwargs: Any) -> Namespace:

"""Get existence of a namespace by path.

Args:

namespace: The path to the namespace.

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabGetError: If the server failed to perform the request

Returns:

Data on namespace existence returned from the server.

"""

path = f"{self.path}/{EncodedId(namespace)}/exists"

server_data = self.gitlab.http_get(path, **kwargs)

if TYPE_CHECKING:

assert isinstance(server_data, dict)

return self._obj_cls(self, server_data)