diff options
author | Max Wittig <max.wittig@siemens.com> | 2020-01-21 22:01:40 +0100 |
---|---|---|
committer | Max Wittig <max.wittig95@gmail.com> | 2020-01-22 21:27:03 +0100 |
commit | 5650db9fd2ddcfef9da4ec972fefd82a7bfdef03 (patch) | |
tree | 3698384ade48dd7ff1e19b7c344474e090b51ec9 /gitlab/v4/objects/snippet.py | |
parent | afdc43f401e20550ed181d4b87829739791d2ee3 (diff) | |
download | gitlab-5650db9fd2ddcfef9da4ec972fefd82a7bfdef03.tar.gz |
refactor: structure python objects in a reasonable way
Diffstat (limited to 'gitlab/v4/objects/snippet.py')
-rw-r--r-- | gitlab/v4/objects/snippet.py | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/gitlab/v4/objects/snippet.py b/gitlab/v4/objects/snippet.py new file mode 100644 index 0000000..5776dcc --- /dev/null +++ b/gitlab/v4/objects/snippet.py @@ -0,0 +1,59 @@ +from gitlab.base import * # noqa +from gitlab.exceptions import * # noqa +from gitlab.mixins import * # noqa +from gitlab import types +from gitlab import utils + + +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) |