summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/namespaces.py
blob: 8957a5c1a9a10cfbc61b37959f79be51b63f4b9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
from typing import Any, cast, TYPE_CHECKING, Union

from gitlab import cli
from gitlab import exceptions as exc
from gitlab.base import RESTManager, RESTObject
from gitlab.mixins import RetrieveMixin
from gitlab.utils import EncodedId

__all__ = [
    "Namespace",
    "NamespaceManager",
]


class Namespace(RESTObject):
    pass


class NamespaceManager(RetrieveMixin, RESTManager):
    _path = "/namespaces"
    _obj_cls = Namespace
    _list_filters = ("search",)

    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Namespace:
        return cast(Namespace, super().get(id=id, lazy=lazy, **kwargs))

    @cli.register_custom_action("NamespaceManager", ("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)