FilesExpand file tree

 develop

/

event.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

128 lines (93 loc) · 3.98 KB

 develop

/

event.py

Copy path

Top

File metadata and controls

• Code
• Blame

128 lines (93 loc) · 3.98 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

# -*- coding: utf-8 -*-

"""Issue events logic."""

from __future__ import unicode_literals

from .. import users

from ..models import GitHubCore

class IssueEvent(GitHubCore):

"""Representation of an event from a specific issue.

This object will be instantiated from calling

:meth:`~github3.issues.issue.Issue.events` which calls

https://developer.github.com/v3/issues/events/#list-events-for-an-issue

See also: http://developer.github.com/v3/issues/events

This object has the following attributes:

.. attribute:: actor

A :class:`~github3.users.ShortUser` representing the user who

generated this event.

.. attribute:: commit_id

The string SHA of a commit that referenced the parent issue. If there

was no commit referencing this issue, then this will be ``None``.

.. attribute:: commit_url

The URL to retrieve commit information from the API for the commit

that references the parent issue. If there was no commit, this will be

``None``.

.. attribute:: created_at

A :class:`~datetime.datetime` object representing the date and time

this event occurred.

.. attribute:: event

The issue-specific action that generated this event. Some examples

are:

- closed

- reopened

- subscribed

- merged

- referenced

- mentioned

- assigned

See `this list of events`_ for a full listing.

.. attribute:: id

The unique identifier for this event.

.. _this list of events:

https://developer.github.com/v3/issues/events/#events-1

"""

def _update_attributes(self, event):

self._api = event['url']

self.actor = users.ShortUser(event['actor'], self)

self.commit_id = event['commit_id']

self.commit_url = event['commit_url']

self.created_at = self._strptime(event['created_at'])

# Only for 'assigned' and 'unassigned' events.

self.assignee = event.get('assignee')

if self.assignee:

self.assignee = users.ShortUser(self.assignee, self)

self.assigner = event.get('assigner')

if self.assigner:

self.assigner = users.ShortUser(self.assigner, self)

# Only for 'review_requested' and 'review_request_removed' events.

self.review_requester = event.get('review_requester')

if self.review_requester:

self.review_requester = (

users.ShortUser(self.review_requester, self))

self.requested_reviewers = event.get('requested_reviewers')

if self.requested_reviewers:

self.requested_reviewers = [

users.ShortUser(reviewer, self)

for reviewer in self.requested_reviewers

]

self.event = event['event']

self.id = event['id']

self._uniq = self.commit_id

def _repr(self):

return '<Issue Event [{0} by {1}]>'.format(

self.event, self.actor

)

class RepositoryIssueEvent(IssueEvent):

"""Representation of an issue event on the repository level.

This object will be instantiated from calling

:meth:`~github3.repos.repo.Repository.issue_events` or

:meth:`~github3.repos.repo.ShortRepository.issue_events`which call

https://developer.github.com/v3/issues/events/#list-events-for-a-repository

See also: http://developer.github.com/v3/issues/events

This object has all of the attributes of

:class:`~github3.issues.event.IssueEvent` and the following:

.. attribute:: issue

A :class:`~github3.issues.issue.ShortIssue` representing the issue

where this event originated from.

"""

def _update_attributes(self, event):

super(RepositoryIssueEvent, self)._update_attributes(event)

from . import issue

self.issue = issue.ShortIssue(event['issue'], self)

def _repr(self):

return '<Repository Issue Event on #{} [{} by {}]>'.format(

self.issue.number, self.event, self.actor.login

)