summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/snippets.py
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-02-07 00:29:59 +0100
committerNejc Habjan <hab.nejc@gmail.com>2021-02-07 16:05:05 +0100
commita5a48ad08577be70c6ca511d3b4803624e5c2043 (patch)
treec1b80daad6dbb6ea3b1a3498d70016ef77abf6b3 /gitlab/v4/objects/snippets.py
parent9d6c1882d567116e16484f3e0a1036da4967c537 (diff)
downloadgitlab-a5a48ad08577be70c6ca511d3b4803624e5c2043.tar.gz
refactor(v4): split objects and managers per API resource
Diffstat (limited to 'gitlab/v4/objects/snippets.py')
-rw-r--r--gitlab/v4/objects/snippets.py110
1 files changed, 110 insertions, 0 deletions
diff --git a/gitlab/v4/objects/snippets.py b/gitlab/v4/objects/snippets.py
new file mode 100644
index 0000000..ec5de95
--- /dev/null
+++ b/gitlab/v4/objects/snippets.py
@@ -0,0 +1,110 @@
+from gitlab import cli
+from gitlab import exceptions as exc
+from gitlab.base import * # noqa
+from gitlab.mixins import * # noqa
+
+from .award_emojis import ProjectSnippetAwardEmojiManager
+from .discussions import ProjectSnippetDiscussionManager
+from .notes import ProjectSnippetNoteManager, ProjectSnippetDiscussionNoteManager
+
+
+class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
+ _short_print_attr = "title"
+
+ @cli.register_custom_action("Snippet")
+ @exc.on_http_error(exc.GitlabGetError)
+ def content(self, streamed=False, action=None, chunk_size=1024, **kwargs):
+ """Return the content of a snippet.
+
+ Args:
+ streamed (bool): If True the data will be processed by chunks of
+ `chunk_size` and each chunk is passed to `action` for
+ treatment.
+ action (callable): Callable responsible of dealing with chunk of
+ data
+ chunk_size (int): Size of each chunk
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the content could not be retrieved
+
+ Returns:
+ str: The snippet content
+ """
+ path = "/snippets/%s/raw" % self.get_id()
+ result = self.manager.gitlab.http_get(
+ path, streamed=streamed, raw=True, **kwargs
+ )
+ return utils.response_content(result, streamed, action, chunk_size)
+
+
+class SnippetManager(CRUDMixin, RESTManager):
+ _path = "/snippets"
+ _obj_cls = Snippet
+ _create_attrs = (("title", "file_name", "content"), ("lifetime", "visibility"))
+ _update_attrs = (tuple(), ("title", "file_name", "content", "visibility"))
+
+ @cli.register_custom_action("SnippetManager")
+ def public(self, **kwargs):
+ """List all the public snippets.
+
+ Args:
+ all (bool): If True the returned object will be a list
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabListError: If the list could not be retrieved
+
+ Returns:
+ RESTObjectList: A generator for the snippets list
+ """
+ return self.list(path="/snippets/public", **kwargs)
+
+
+class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
+ _url = "/projects/%(project_id)s/snippets"
+ _short_print_attr = "title"
+ _managers = (
+ ("awardemojis", "ProjectSnippetAwardEmojiManager"),
+ ("discussions", "ProjectSnippetDiscussionManager"),
+ ("notes", "ProjectSnippetNoteManager"),
+ )
+
+ @cli.register_custom_action("ProjectSnippet")
+ @exc.on_http_error(exc.GitlabGetError)
+ def content(self, streamed=False, action=None, chunk_size=1024, **kwargs):
+ """Return the content of a snippet.
+
+ Args:
+ streamed (bool): If True the data will be processed by chunks of
+ `chunk_size` and each chunk is passed to `action` for
+ treatment.
+ action (callable): Callable responsible of dealing with chunk of
+ data
+ chunk_size (int): Size of each chunk
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the content could not be retrieved
+
+ Returns:
+ str: The snippet content
+ """
+ path = "%s/%s/raw" % (self.manager.path, self.get_id())
+ result = self.manager.gitlab.http_get(
+ path, streamed=streamed, raw=True, **kwargs
+ )
+ return utils.response_content(result, streamed, action, chunk_size)
+
+
+class ProjectSnippetManager(CRUDMixin, RESTManager):
+ _path = "/projects/%(project_id)s/snippets"
+ _obj_cls = ProjectSnippet
+ _from_parent_attrs = {"project_id": "id"}
+ _create_attrs = (("title", "file_name", "content", "visibility"), ("description",))
+ _update_attrs = (
+ tuple(),
+ ("title", "file_name", "content", "visibility", "description"),
+ )