def list_labels(self, repo: Repository) -> typing.List[Label]:
"""Return the list of Labels from the repository.
GitHub API docs:
https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository
"""
logger = logging.getLogger("labels")
logger.debug(f"Requesting labels for {repo.owner}/{repo.name}")
response = self.session.get(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels",
headers={"Accept": "application/vnd.github.symmetra-preview+json"},
)
if response.status_code != 200:
raise GitHubException(f"Error retrieving labels: "
f"{response.status_code} - "
f"{response.reason}")
json = response.json()
next_page = response.links.get('next', None)
while next_page:
logger.debug(f"Requesting {next_page}")
response = self.session.get(
next_page['url'],
headers={
"Accept": "application/vnd.github.symmetra-preview+json"
},
)
if response.status_code != 200:
raise GitHubException(f"Error retrieving next page of labels: "
f"{response.status_code} - "
f"{response.reason}")
json.extend(response.json())
next_page = response.links.get('next', None)
return [Label(**data) for data in json]
def delete_label(self, repo: Repository, *, name: str) -> None:
"""Delete a GitHub issue label.
GitHub API docs:
https://developer.github.com/v3/issues/labels/#delete-a-label
"""
logger = logging.getLogger("labels")
logger.debug(f"Deleting label '{name}' for {repo.owner}/{repo.name}")
response = self.session.delete(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels/{name}")
if response.status_code != 204:
raise GitHubException(f"Error deleting label {name}: "
f"{response.status_code} - "
f"{response.reason}")
def get_label(self, repo: Repository, *, name: str) -> Label:
"""Return a single Label from the repository.
GitHub API docs:
https://developer.github.com/v3/issues/labels/#get-a-single-label
"""
logger = logging.getLogger("labels")
logger.debug(f"Requesting label '{name}' for {repo.owner}/{repo.name}")
response = self.session.get(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels/{name}",
headers={"Accept": "application/vnd.github.symmetra-preview+json"},
)
if response.status_code != 200:
raise GitHubException(f"Error retrieving label {name}: "
f"{response.status_code} - "
f"{response.reason}")
return Label(**response.json())
def edit_label(self, repo: Repository, *, name: str,
label: Label) -> Label:
"""Update a GitHub issue label.
GitHub API docs:
https://developer.github.com/v3/issues/labels/#update-a-label
"""
logger = logging.getLogger("labels")
logger.debug(f"Editing label '{name}' for {repo.owner}/{repo.name}")
response = self.session.patch(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels/{name}",
headers={"Accept": "application/vnd.github.symmetra-preview+json"},
json=label.params_dict,
)
if response.status_code != 200:
raise GitHubException(f"Error editing label {name}: "
f"{response.status_code} - "
f"{response.reason}")
return Label(**response.json())
def list_labels(self, repo: Repository) -> typing.List[Label]:
"""Return the list of Labels from the repository.
GitHub API docs:
https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository
"""
logger = logging.getLogger("labels")
logger.debug(f"Requesting labels for {repo.owner}/{repo.name}")
response = self.session.get(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels",
headers=self.headers,
)
if response.status_code != 200:
raise GitHubException(
f"Error retrieving labels: "
f"{response.status_code} - "
f"{response.reason}"
)
return [Label(**data) for data in response.json()]
def create_label(self, repo: Repository, *, label: Label) -> Label:
"""Create a new Label for the repository.
GitHub API docs:
https://developer.github.com/v3/issues/labels/#create-a-label
"""
logger = logging.getLogger("labels")
logger.debug(f"Creating label '{label.name}' for {repo.owner}/{repo.name}")
response = self.session.post(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels",
headers=self.headers,
json=label.params_dict,
)
if response.status_code != 201:
raise GitHubException(
f"Error creating label {label.name}: "
f"{response.status_code} - "
f"{response.reason}"
)
return Label(**response.json())
def merge_label(self, repo: Repository, *, old_label: str,
new_label: str) -> None:
"""Merge a GitHub issue label to an existing label.
- Add the target label to all issues with the old label.
- The old label will be deleted while processing labels to delete.
"""
logger = logging.getLogger("labels")
logger.debug(
f"Requesting issues for label {old_label} in {repo.owner}/{repo.name}"
) # noqa: E501
response = self.session.get(
f"{self.base_url}/search/issues?q=label:{old_label}+repo:{repo.owner}/{repo.name}", # noqa: E501
headers={"Accept": "application/vnd.github.symmetra-preview+json"},
)
if response.status_code != 200:
raise GitHubException(
f"Error retrieving issues for label {old_label} in {repo.owner}/{repo.name}: " # noqa: E501
f"{response.status_code} - "
f"{response.reason}")
json = response.json()
next_page = response.links.get('next', None)
while next_page:
logger.debug(f"Requesting {next_page}")
response = self.session.get(
next_page['url'],
headers={
"Accept": "application/vnd.github.symmetra-preview+json"
},
)
if response.status_code != 200:
raise GitHubException(
f"Error retrieving next page of issues for label {old_label}: "
f"{response.status_code} - "
f"{response.reason}")
json.extend(response.json())
next_page = response.links.get('next', None)
for issue in json['items']:
response = self.session.get(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/issues/{issue['number']}/labels", # noqa: E501
headers={
"Accept": "application/vnd.github.symmetra-preview+json"
},
)
if response.status_code != 200:
raise GitHubException(
f"Error retrieving labels for {repo.owner}/{repo.name}/issue/{issue['number']}: " # noqa: E501
f"{response.status_code} - "
f"{response.reason}")
labels = [l['name'] for l in response.json()]
if new_label not in labels:
response = self.session.post(
f"{self.base_url}/repos/{repo.owner}/{repo.name}/issues/{issue['number']}/labels", # noqa: E501
headers={
"Accept":
"application/vnd.github.symmetra-preview+json"
},
json={'labels': [f"{new_label}"]},
)
if response.status_code != 200:
raise GitHubException(
f"Error adding '{new_label}' for issue {repo.owner}/{repo.name}/issues/{issue['number']}: " # noqa: E501
f"{response.status_code} - "
f"{response.reason}")
logger.debug(
f"Added label '{new_label}' to {repo.owner}/{repo.name}/issue/{issue['number']}"
) # noqa: E501
