FilesExpand file tree

 develop

/

milestone.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

112 lines (83 loc) · 3.77 KB

 develop

/

milestone.py

Copy path

Top

File metadata and controls

• Code
• Blame

112 lines (83 loc) · 3.77 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

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

from __future__ import unicode_literals

from json import dumps

from .. import users

from ..decorators import requires_auth

from .label import Label

from ..models import GitHubCore

class Milestone(GitHubCore):

"""The :class:`Milestone <Milestone>` object. This is a small class to

handle information about milestones on repositories and issues.

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

"""

def _update_attributes(self, milestone):

self._api = self._get_attribute(milestone, 'url', '')

#: Identifying number associated with milestone.

self.number = self._get_attribute(milestone, 'number')

#: State of the milestone, e.g., open or closed.

self.state = self._get_attribute(milestone, 'state')

#: Title of the milestone, e.g., 0.2.

self.title = self._get_attribute(milestone, 'title')

#: Description of this milestone.

self.description = self._get_attribute(milestone, 'description')

#: :class:`User <github3.users.User>` object representing the creator

#: of the milestone.

self.creator = self._class_attribute(

milestone, 'creator', users.ShortUser, self

)

#: Number of issues associated with this milestone which are still

#: open.

self.open_issues = self._get_attribute(milestone, 'open_issues')

#: The number of closed issues associated with this milestone.

self.closed_issues = self._get_attribute(milestone, 'closed_issues')

#: datetime object representing when the milestone was created.

self.created_at = self._strptime_attribute(milestone, 'created_at')

#: datetime representing when this milestone is due.

self.due_on = self._strptime_attribute(milestone, 'due_on')

#: datetime object representing when the milestone was updated.

self.updated_at = self._strptime_attribute(milestone, 'updated_at')

#: string representing the milestone's ID.

self.id = self._get_attribute(milestone, 'id')

def _repr(self):

return '<Milestone [{0}]>'.format(self)

def __str__(self):

return self.title

@requires_auth

def delete(self):

"""Delete this milestone.

:returns: bool

"""

return self._boolean(self._delete(self._api), 204, 404)

def labels(self, number=-1, etag=None):

r"""Iterate over the labels of every associated issue.

.. versionchanged:: 0.9

Add etag parameter.

:param int number: (optional), number of labels to return. Default: -1

returns all available labels.

:param str etag: (optional), ETag header from a previous response

:returns: generator of :class:`Label <github3.issues.label.Label>`\ s

"""

url = self._build_url('labels', base_url=self._api)

return self._iter(int(number), url, Label, etag=etag)

@requires_auth

def update(self, title=None, state=None, description=None, due_on=None):

"""Update this milestone.

All parameters are optional, but it makes no sense to omit all of them

at once.

:param str title: (optional), new title of the milestone

:param str state: (optional), ('open', 'closed')

:param str description: (optional)

:param str due_on: (optional), ISO 8601 time format:

YYYY-MM-DDTHH:MM:SSZ

:returns: bool

"""

data = {'title': title, 'state': state,

'description': description, 'due_on': due_on}

self._remove_none(data)

json = None

if data:

json = self._json(self._patch(self._api, data=dumps(data)), 200)

if json:

self._update_attributes(json)

return True

return False