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

Repository navigation

History

63 lines (52 loc) · 1.89 KB

Raw

from typing import Any, cast, Dict, Optional, Union

from gitlab import exceptions as exc

from gitlab.base import RESTManager, RESTObject

from gitlab.mixins import GetWithoutIdMixin, SaveMixin, UpdateMixin

from gitlab.types import RequiredOptional

__all__ = [

"ApplicationAppearance",

"ApplicationAppearanceManager",

]

class ApplicationAppearance(SaveMixin, RESTObject):

_id_attr = None

class ApplicationAppearanceManager(GetWithoutIdMixin, UpdateMixin, RESTManager):

_path = "/application/appearance"

_obj_cls = ApplicationAppearance

_update_attrs = RequiredOptional(

optional=(

"title",

"description",

"logo",

"header_logo",

"favicon",

"new_project_guidelines",

"header_message",

"footer_message",

"message_background_color",

"message_font_color",

"email_header_and_footer_enabled",

)

@exc.on_http_error(exc.GitlabUpdateError)

def update(

self,

id: Optional[Union[str, int]] = None,

new_data: Optional[Dict[str, Any]] = None,

**kwargs: Any

) -> Dict[str, Any]:

"""Update an object on the server.

Args:

id: ID of the object to update (can be None if not required)

new_data: the update data for the object

**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

"""

new_data = new_data or {}

data = new_data.copy()

return super().update(id, data, **kwargs)

def get(self, **kwargs: Any) -> ApplicationAppearance:

return cast(ApplicationAppearance, super().get(**kwargs))

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

Repository navigation

Expand file tree

Breadcrumbs

appearance.py

Latest commit

History

Breadcrumbs

appearance.py

File metadata and controls