Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds support for retrieval of Github timeline events. Signed-off-by: Nick Campbell <nicholas.j.campbell@gmail.com>
- Loading branch information
Showing
6 changed files
with
261 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| ############################ Copyrights and license ############################ | ||
| # # | ||
| # Copyright 2019 Nick Campbell <nicholas.j.campbell@gmail.com> # | ||
| # # | ||
| # This file is part of PyGithub. # | ||
| # http://pygithub.readthedocs.io/ # | ||
| # # | ||
| # PyGithub is free software: you can redistribute it and/or modify it under # | ||
| # the terms of the GNU Lesser General Public License as published by the Free # | ||
| # Software Foundation, either version 3 of the License, or (at your option) # | ||
| # any later version. # | ||
| # # | ||
| # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # | ||
| # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # | ||
| # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # | ||
| # details. # | ||
| # # | ||
| # You should have received a copy of the GNU Lesser General Public License # | ||
| # along with PyGithub. If not, see <http://www.gnu.org/licenses/>. # | ||
| # # | ||
| ################################################################################ | ||
|
|
||
| from __future__ import absolute_import | ||
| import github.GithubObject | ||
|
|
||
| import github.NamedUser | ||
| import github.TimelineEventSource | ||
|
|
||
|
|
||
| class TimelineEvent(github.GithubObject.CompletableGithubObject): | ||
| """ | ||
| This class represents IssueTimelineEvents. The reference can be found here https://developer.github.com/v3/issues/timeline/ | ||
| """ | ||
|
|
||
| def __repr__(self): | ||
| return self.get__repr__({"id": self._id.value}) | ||
|
|
||
| @property | ||
| def actor(self): | ||
| """ | ||
| :type: :class:`github.NamedUser.NamedUser` | ||
| """ | ||
| self._completeIfNotSet(self._actor) | ||
| return self._actor.value | ||
|
|
||
| @property | ||
| def commit_id(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._commit_id) | ||
| return self._commit_id.value | ||
|
|
||
| @property | ||
| def created_at(self): | ||
| """ | ||
| :type: datetime.datetime | ||
| """ | ||
| self._completeIfNotSet(self._created_at) | ||
| return self._created_at.value | ||
|
|
||
| @property | ||
| def event(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._event) | ||
| return self._event.value | ||
|
|
||
| @property | ||
| def id(self): | ||
| """ | ||
| :type: integer | ||
| """ | ||
| self._completeIfNotSet(self._id) | ||
| return self._id.value | ||
|
|
||
| @property | ||
| def node_id(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._node_id) | ||
| return self._node_id.value | ||
|
|
||
| @property | ||
| def commit_url(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._commit_url) | ||
| return self._commit_url.value | ||
|
|
||
| @property | ||
| def source(self): | ||
| """ | ||
| :type: :class:`github.TimelineEventSource.TimelineEventSource` | ||
| """ | ||
| # only available on `cross-referenced` events. | ||
| if self.event == 'cross-referenced' and hasattr(self, '_source') and self._source is not None: | ||
| return self._source.value | ||
| return None | ||
|
|
||
| @property | ||
| def body(self): | ||
| """ | ||
| :type string | ||
| """ | ||
| if self.event == 'commented' and hasattr(self, '_body') and self._body is not None: | ||
| return self._body.value | ||
| return None | ||
|
|
||
| @property | ||
| def author_association(self): | ||
| """ | ||
| :type string | ||
| """ | ||
| if self.event == 'commented' and hasattr(self, '_author_association') and self._author_association is not None: | ||
| return self._author_association.value | ||
| return None | ||
|
|
||
| def _initAttributes(self): | ||
| self._actor = github.GithubObject.NotSet | ||
| self._commit_id = github.GithubObject.NotSet | ||
| self._created_at = github.GithubObject.NotSet | ||
| self._event = github.GithubObject.NotSet | ||
| self._id = github.GithubObject.NotSet | ||
| self._node_id = github.GithubObject.NotSet | ||
| self._commit_url = github.GithubObject.NotSet | ||
| self._source = github.GithubObject.NotSet | ||
| self._body = github.GithubObject.NotSet | ||
| self._author_association = github.GithubObject.NotSet | ||
|
|
||
| def _useAttributes(self, attributes): | ||
| if "actor" in attributes: # pragma no branch | ||
| self._actor = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["actor"]) | ||
| if "commit_id" in attributes: # pragma no branch | ||
| self._commit_id = self._makeStringAttribute(attributes["commit_id"]) | ||
| if "created_at" in attributes: # pragma no branch | ||
| self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) | ||
| if "event" in attributes: # pragma no branch | ||
| self._event = self._makeStringAttribute(attributes["event"]) | ||
| if "id" in attributes: # pragma no branch | ||
| self._id = self._makeIntAttribute(attributes["id"]) | ||
| if "node_id" in attributes: # pragma no branch | ||
| self._node_id = self._makeStringAttribute(attributes["node_id"]) | ||
| if "commit_url" in attributes: # pragma no branch | ||
| self._commit_url = self._makeStringAttribute(attributes["commit_url"]) | ||
| if "source" in attributes: # pragma no branch | ||
| self._source = self._makeClassAttribute(github.TimelineEventSource.TimelineEventSource, attributes["source"]) | ||
| if "body" in attributes: # pragma no branch | ||
| self._body = self._makeStringAttribute(attributes["body"]) | ||
| if "author_association" in attributes: # pragma no branch | ||
| self._author_association = self._makeStringAttribute(attributes["author_association"]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| ############################ Copyrights and license ############################ | ||
| # # | ||
| # Copyright 2019 Nick Campbell <nicholas.j.campbell@gmail.com> # | ||
| # # | ||
| # This file is part of PyGithub. # | ||
| # http://pygithub.readthedocs.io/ # | ||
| # # | ||
| # PyGithub is free software: you can redistribute it and/or modify it under # | ||
| # the terms of the GNU Lesser General Public License as published by the Free # | ||
| # Software Foundation, either version 3 of the License, or (at your option) # | ||
| # any later version. # | ||
| # # | ||
| # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # | ||
| # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # | ||
| # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # | ||
| # details. # | ||
| # # | ||
| # You should have received a copy of the GNU Lesser General Public License # | ||
| # along with PyGithub. If not, see <http://www.gnu.org/licenses/>. # | ||
| # # | ||
| ################################################################################ | ||
|
|
||
| from __future__ import absolute_import | ||
| import github.GithubObject | ||
|
|
||
| import github.Issue | ||
|
|
||
|
|
||
| class TimelineEventSource(github.GithubObject.CompletableGithubObject): | ||
| """ | ||
| This class represents IssueTimelineEventSource. The reference can be found here https://developer.github.com/v3/issues/timeline/ | ||
| """ | ||
|
|
||
| def __repr__(self): | ||
| return self.get__repr__({"type": self._type.value}) | ||
|
|
||
| @property | ||
| def type(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._type) | ||
| return self._type.value | ||
|
|
||
| @property | ||
| def issue(self): | ||
| """ | ||
| :type: :class:`github.Issue.Issue` | ||
| """ | ||
| self._completeIfNotSet(self._issue) | ||
| return self._issue.value | ||
|
|
||
| def _initAttributes(self): | ||
| self._type = github.GithubObject.NotSet | ||
| self._issue = github.GithubObject.NotSet | ||
|
|
||
| def _useAttributes(self, attributes): | ||
| if "type" in attributes: # pragma no branch | ||
| self._type = self._makeStringAttribute(attributes["type"]) | ||
| if "issue" in attributes: # pragma no branch | ||
| self._issue = self._makeClassAttribute(github.Issue.Issue, attributes["issue"]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.