mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
Steve Kowalik
babcbcd04f
Now that GitHub have moved their documentation from developer.github.com, we should update our links. I have also tried to update the call strings to their new format, but since it was done via regex, some of them may not match exactly.
254 lines
9.5 KiB
Python
254 lines
9.5 KiB
Python
############################ Copyrights and license ############################
|
|
# #
|
|
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2012 Zearin <zearin@gonk.net> #
|
|
# Copyright 2013 AKFish <akfish@gmail.com> #
|
|
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2013 martinqt <m.ki2@laposte.net> #
|
|
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
|
|
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
|
|
# Copyright 2018 sfdye <tsfdye@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/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
import datetime
|
|
|
|
import github.GithubObject
|
|
import github.Label
|
|
import github.NamedUser
|
|
import github.PaginatedList
|
|
|
|
|
|
class Milestone(github.GithubObject.CompletableGithubObject):
|
|
"""
|
|
This class represents Milestones. The reference can be found here http://docs.github.com/en/rest/reference/issues#milestones
|
|
"""
|
|
|
|
def __repr__(self):
|
|
return self.get__repr__(
|
|
{"number": self._number.value, "title": self._title.value}
|
|
)
|
|
|
|
@property
|
|
def closed_issues(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._closed_issues)
|
|
return self._closed_issues.value
|
|
|
|
@property
|
|
def created_at(self):
|
|
"""
|
|
:type: datetime.datetime
|
|
"""
|
|
self._completeIfNotSet(self._created_at)
|
|
return self._created_at.value
|
|
|
|
@property
|
|
def creator(self):
|
|
"""
|
|
:type: :class:`github.NamedUser.NamedUser`
|
|
"""
|
|
self._completeIfNotSet(self._creator)
|
|
return self._creator.value
|
|
|
|
@property
|
|
def description(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._description)
|
|
return self._description.value
|
|
|
|
@property
|
|
def due_on(self):
|
|
"""
|
|
:type: datetime.datetime
|
|
"""
|
|
self._completeIfNotSet(self._due_on)
|
|
return self._due_on.value
|
|
|
|
@property
|
|
def id(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._id)
|
|
return self._id.value
|
|
|
|
@property
|
|
def labels_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._labels_url)
|
|
return self._labels_url.value
|
|
|
|
@property
|
|
def number(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._number)
|
|
return self._number.value
|
|
|
|
@property
|
|
def open_issues(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._open_issues)
|
|
return self._open_issues.value
|
|
|
|
@property
|
|
def state(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._state)
|
|
return self._state.value
|
|
|
|
@property
|
|
def title(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._title)
|
|
return self._title.value
|
|
|
|
@property
|
|
def updated_at(self):
|
|
"""
|
|
:type: datetime.datetime
|
|
"""
|
|
self._completeIfNotSet(self._updated_at)
|
|
return self._updated_at.value
|
|
|
|
@property
|
|
def url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._url)
|
|
return self._url.value
|
|
|
|
def delete(self):
|
|
"""
|
|
:calls: `DELETE /repos/{owner}/{repo}/milestones/{number} <http://docs.github.com/en/rest/reference/issues#milestones>`_
|
|
:rtype: None
|
|
"""
|
|
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)
|
|
|
|
def edit(
|
|
self,
|
|
title,
|
|
state=github.GithubObject.NotSet,
|
|
description=github.GithubObject.NotSet,
|
|
due_on=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `PATCH /repos/{owner}/{repo}/milestones/{number} <http://docs.github.com/en/rest/reference/issues#milestones>`_
|
|
:param title: string
|
|
:param state: string
|
|
:param description: string
|
|
:param due_on: date
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(title, str), title
|
|
assert state is github.GithubObject.NotSet or isinstance(state, str), state
|
|
assert description is github.GithubObject.NotSet or isinstance(
|
|
description, str
|
|
), description
|
|
assert due_on is github.GithubObject.NotSet or isinstance(
|
|
due_on, datetime.date
|
|
), due_on
|
|
post_parameters = {
|
|
"title": title,
|
|
}
|
|
if state is not github.GithubObject.NotSet:
|
|
post_parameters["state"] = state
|
|
if description is not github.GithubObject.NotSet:
|
|
post_parameters["description"] = description
|
|
if due_on is not github.GithubObject.NotSet:
|
|
post_parameters["due_on"] = due_on.strftime("%Y-%m-%d")
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"PATCH", self.url, input=post_parameters
|
|
)
|
|
self._useAttributes(data)
|
|
|
|
def get_labels(self):
|
|
"""
|
|
:calls: `GET /repos/{owner}/{repo}/milestones/{number}/labels <http://docs.github.com/en/rest/reference/issues#labels>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Label.Label`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(
|
|
github.Label.Label, self._requester, f"{self.url}/labels", None
|
|
)
|
|
|
|
@property
|
|
def _identity(self):
|
|
return self.number
|
|
|
|
def _initAttributes(self):
|
|
self._closed_issues = github.GithubObject.NotSet
|
|
self._created_at = github.GithubObject.NotSet
|
|
self._creator = github.GithubObject.NotSet
|
|
self._description = github.GithubObject.NotSet
|
|
self._due_on = github.GithubObject.NotSet
|
|
self._id = github.GithubObject.NotSet
|
|
self._labels_url = github.GithubObject.NotSet
|
|
self._number = github.GithubObject.NotSet
|
|
self._open_issues = github.GithubObject.NotSet
|
|
self._state = github.GithubObject.NotSet
|
|
self._title = github.GithubObject.NotSet
|
|
self._updated_at = github.GithubObject.NotSet
|
|
self._url = github.GithubObject.NotSet
|
|
|
|
def _useAttributes(self, attributes):
|
|
if "closed_issues" in attributes: # pragma no branch
|
|
self._closed_issues = self._makeIntAttribute(attributes["closed_issues"])
|
|
if "created_at" in attributes: # pragma no branch
|
|
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
|
|
if "creator" in attributes: # pragma no branch
|
|
self._creator = self._makeClassAttribute(
|
|
github.NamedUser.NamedUser, attributes["creator"]
|
|
)
|
|
if "description" in attributes: # pragma no branch
|
|
self._description = self._makeStringAttribute(attributes["description"])
|
|
if "due_on" in attributes: # pragma no branch
|
|
self._due_on = self._makeDatetimeAttribute(attributes["due_on"])
|
|
if "id" in attributes: # pragma no branch
|
|
self._id = self._makeIntAttribute(attributes["id"])
|
|
if "labels_url" in attributes: # pragma no branch
|
|
self._labels_url = self._makeStringAttribute(attributes["labels_url"])
|
|
if "number" in attributes: # pragma no branch
|
|
self._number = self._makeIntAttribute(attributes["number"])
|
|
if "open_issues" in attributes: # pragma no branch
|
|
self._open_issues = self._makeIntAttribute(attributes["open_issues"])
|
|
if "state" in attributes: # pragma no branch
|
|
self._state = self._makeStringAttribute(attributes["state"])
|
|
if "title" in attributes: # pragma no branch
|
|
self._title = self._makeStringAttribute(attributes["title"])
|
|
if "updated_at" in attributes: # pragma no branch
|
|
self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])
|
|
if "url" in attributes: # pragma no branch
|
|
self._url = self._makeStringAttribute(attributes["url"])
|