From 6705928406667ee010f448e41c14cfa63c263178 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=20S=C3=B5mermaa?= Date: Tue, 19 Nov 2013 09:13:38 +0200 Subject: Fix comments. --- gitlab.py | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) (limited to 'gitlab.py') diff --git a/gitlab.py b/gitlab.py index c6dfed2..6365d80 100644 --- a/gitlab.py +++ b/gitlab.py @@ -315,9 +315,9 @@ class Gitlab(object): If id is None, returns a list of hooks. - If id is an integer, test the matching hook. + If id is an integer, tests the matching hook. - If id is a dict, create a new object using attributes provided. The + If id is a dict, creates a new object using attributes provided. The object is NOT saved on the server. Use the save() method on the object to write it on the server. """ @@ -328,42 +328,46 @@ class Gitlab(object): If id is None, returns a list of projects. - If id is an integer, returns the matching project (or raise a + If id is an integer, returns the matching project (or raises a GitlabGetError if not found) - If id is a dict, create a new object using attributes provided. The + If id is a dict, creates a new object using attributes provided. The object is NOT saved on the server. Use the save() method on the object to write it on the server. """ return self._getListOrObject(Project, id, **kwargs) def Group(self, id=None, **kwargs): - """Creates/gets/lists groups(s) known by the GitLab server. + """Creates/gets/lists group(s) known by the GitLab server. - If id is None, returns a list of projects. + If id is None, returns a list of groups. - If id is an integer, returns the matching project (or raise a + If id is an integer, returns the matching group (or raises a GitlabGetError if not found) - If id is a dict, create a new object using attributes provided. The + If id is a dict, creates a new object using attributes provided. The object is NOT saved on the server. Use the save() method on the object to write it on the server. """ return self._getListOrObject(Group, id, **kwargs) def Issue(self, id=None, **kwargs): - """Lists issues(s) known by the GitLab server.""" + """Lists issues(s) known by the GitLab server. + + Does not support creation or getting a single issue unlike other + methods in this class yet. + """ return self._getListOrObject(Issue, id, **kwargs) def User(self, id=None, **kwargs): """Creates/gets/lists users(s) known by the GitLab server. - If id is None, returns a list of projects. + If id is None, returns a list of users. - If id is an integer, returns the matching project (or raise a + If id is an integer, returns the matching user (or raises a GitlabGetError if not found) - If id is a dict, create a new object using attributes provided. The + If id is a dict, creates a new object using attributes provided. The object is NOT saved on the server. Use the save() method on the object to write it on the server. """ @@ -374,7 +378,7 @@ class Gitlab(object): If id is None, returns a list of teams. - If id is an integer, returns the matching project (or raise a + If id is an integer, returns the matching team (or raises a GitlabGetError if not found) If id is a dict, create a new object using attributes provided. The -- cgit v1.2.1 From 32d422445388766e7cc4913a51bf8890487d4ce5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=20S=C3=B5mermaa?= Date: Tue, 19 Nov 2013 09:39:31 +0200 Subject: Add support for project events. --- gitlab.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'gitlab.py') diff --git a/gitlab.py b/gitlab.py index 6365d80..ac86bef 100644 --- a/gitlab.py +++ b/gitlab.py @@ -683,6 +683,16 @@ class ProjectKey(GitlabObject): requiredCreateAttrs = ['project_id', 'title', 'key'] +class ProjectEvent(GitlabObject): + _url = '/projects/%(project_id)s/events' + canGet = False + canDelete = False + canUpdate = False + canCreate = False + requiredListAttrs = ['project_id'] + shortPrintAttr = 'target_title' + + class ProjectHook(GitlabObject): _url = '/projects/%(project_id)s/hooks' requiredListAttrs = ['project_id'] @@ -844,6 +854,11 @@ class Project(GitlabObject): project_id=self.id, **kwargs) + def Event(self, id=None, **kwargs): + return self._getListOrObject(ProjectEvent, id, + project_id=self.id, + **kwargs) + def Hook(self, id=None, **kwargs): return self._getListOrObject(ProjectHook, id, project_id=self.id, -- cgit v1.2.1