Files
zulip/tools/check-issue-labels
Anders Kaseorg f8339f019d python: Convert assignment type annotations to Python 3.6 style.
Commit split by tabbott; this has changes to scripts/, tools/, and
puppet/.

scripts/lib/hash_reqs.py, scripts/lib/setup_venv.py,
scripts/lib/zulip_tools.py, and tools/lib/provision.py are excluded so
tools/provision still gives the right error message on Ubuntu 16.04
with Python 3.5.

Generated by com2ann, with whitespace fixes and various manual fixes
for runtime issues:

-shebang_rules: List[Rule] = [
+shebang_rules: List["Rule"] = [

-trailing_whitespace_rule: Rule = {
+trailing_whitespace_rule: "Rule" = {

-whitespace_rules: List[Rule] = [
+whitespace_rules: List["Rule"] = [

-comma_whitespace_rule: List[Rule] = [
+comma_whitespace_rule: List["Rule"] = [

-prose_style_rules: List[Rule] = [
+prose_style_rules: List["Rule"] = [

-html_rules: List[Rule] = whitespace_rules + prose_style_rules + [
+html_rules: List["Rule"] = whitespace_rules + prose_style_rules + [

-    target_port: int = None
+    target_port: int

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-24 13:06:54 -07:00

90 lines
3.1 KiB
Python
Executable File

#!/usr/bin/env python3
import requests
import re
import argparse
import sys
import os
import ConfigParser
from typing import Any, Dict, Optional
# Scans zulip repositary for issues that don't have any `area` labels.
# GitHub API token is required as GitHub limits unauthenticated
# requests to 60/hour. There is a good chance that this limit is
# bypassed in consecutive attempts.
# The api token can be generated here
# https://github.com/settings/tokens/new?description=Zulip%20Issue%20Label%20Checker
#
# Copy conf.ini-template to conf.ini and populate with your api token.
#
# usage: python check-issue-labels
# Pass --force as an argument to run without a token.
def get_config() -> ConfigParser:
config = ConfigParser()
config.read(os.path.join(os.path.dirname(os.path.abspath(__file__)), 'conf.ini'))
return config
def area_labeled(issue: Dict[str, Any]) -> bool:
for label in issue["labels"]:
label_name = str(label["name"])
if "area:" in label_name:
return True
return False
def is_issue(item: Dict[str, Any]) -> bool:
return "issues" in item["html_url"]
def get_next_page_url(link_header: str) -> Optional[str]:
matches = re.findall(r'\<(\S+)\>; rel=\"next\"', link_header)
try:
return matches[0]
except IndexError:
return None
def check_issue_labels() -> None:
parser = argparse.ArgumentParser()
parser.add_argument('--force', action="store_true", dest="force", default=False)
args = parser.parse_args()
if not args.force:
config = get_config()
try:
token = config.get('github', 'api_token')
except KeyError:
print("Error fetching GitHub api token. Copy conf.ini-template to conf.ini and populate with "
"your api token. If you want to continue without using a token use --force.")
sys.exit(1)
next_page_url: Optional[str] = 'https://api.github.com/repos/zulip/zulip/issues'
unlabeled_issue_urls = []
while next_page_url:
try:
if args.force:
response = requests.get(next_page_url)
else:
response = requests.get(next_page_url, headers={'Authorization': 'token %s' % (token,)})
if response.status_code == 401:
sys.exit("Error. Please check the token.")
if response.status_code == 403:
sys.exit("403 Error. This is generally caused when API limit is exceeded. You use an api "
"token to overcome this limit.")
except requests.exceptions.RequestException as e:
print(e)
sys.exit(1)
next_page_url = get_next_page_url(response.headers["Link"])
for item in response.json():
if is_issue(item) and not area_labeled(item):
unlabeled_issue_urls.append(item["html_url"])
if len(unlabeled_issue_urls):
print("The following issues don't have any area labels associated with it")
print("\n".join(unlabeled_issue_urls))
else:
print("No GitHub issues found with missing area labels.")
if __name__ == '__main__':
check_issue_labels()