python-docs-zh-tw/.scripts/summarize_progress/main.py at 3.14 · python/python-docs-zh-tw · GitHub

Repository navigation

History

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

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

import re

import polib

import glob

import requests

from pathlib import Path

def get_open_issues_count() -> int:

'''

Fetch GitHub API to get the number of OPEN ISSUES.

'''

url = f"https://api.github.com/search/issues?q=repo:python/python-docs-zh-tw+type:issue+state:open"

headers = {

"Accept": "application/vnd.github+json",

"X-GitHub-Api-Version": "2022-11-28",

}

r = requests.get(url=url, headers=headers)

result = r.json()

return result["total_count"]

def get_github_issues() -> list:

'''

Fetch GitHub API to collect the infomation of OPEN ISSUES,

including issue title and assignee.

Steps:

1. Fetch GitHub API and get open issue list

2. Filter the issue if it have no "Translate" in the title

3. Filter the issue if it have no correct filepath in the title

Expected Output:

[ ((dirname, filename), assignee_id, issue_url), ... ]

'''

NUMBER_OF_ISSUES = get_open_issues_count()

url = f"https://api.github.com/search/issues?q=repo:python/python-docs-zh-tw+type:issue+state:open&per_page={NUMBER_OF_ISSUES}"

headers = {

"Accept": "application/vnd.github+json",

"X-GitHub-Api-Version": "2022-11-28",

}

r = requests.get(url=url, headers=headers)

result = r.json()

result_list = []

for issue in result["items"]:

assignee = issue["assignee"]["login"] if issue["assignee"] else ""

title = issue["title"]

if "翻譯" not in title and "translate" not in title.lower():

continue

match = re.search(

"(?P<dirname>[^\s`][a-zA-z-]+)/(?P<filename>[a-zA-Z0-9._-]+(.po)?)", title)

if not match:

continue

dirname, filename = match.group('dirname', 'filename')

if not filename.endswith('.po'):

filename += '.po'

result_list.append(((dirname, filename), assignee, issue["html_url"]))

return result_list

def format_line_table_header() -> list:

f"|-------:|:-------|:----|:-------|\r\n"]

def format_line_po_issue_display(issue_link: str, issue_number: str, progress: float, create_issue_link: str) -> str:

if issue_link:

return f"[{issue_number}]({issue_link})"

if progress != 100.:

return f"[create issue]({create_issue_link})"

return ""

def format_line_po(filename: str, po_link: str, progress: str, num_entries: str, issue_display: str, assignee: str) -> str:

progress_display = f"{progress} %"

if progress == 100:

progress_display = "✅"

return f"|[`{filename}`]({po_link})|{progress_display} ({num_entries:,})|{issue_display}|{assignee}|\r\n"

if __name__ == "__main__":

issue_list = get_github_issues()

'''

Search all the po file in the directory,

and record the translation progress of each files.

'''

BASE_DIR = Path("../")

summary = {}

for filepath in glob.glob(str(BASE_DIR / "**/*.po"), recursive=True):

path = Path(filepath)

filename = path.name

dirname = path.parent.name if path.parent.name != BASE_DIR.name else 'root'

po = polib.pofile(filepath)

num_entries = len(list(filter(lambda e: not e.obsolete, po)))

num_translated = len(po.translated_entries())

summary.setdefault(dirname, {})[filename] = {

'po_info': {

'num_entries': num_entries,

'num_translated': num_translated,

'progress': round(num_translated / num_entries * 100, 2),

'issue': '',

'assignee': '',

}

'''

Unpack the open issue list, and add assignee after the progress

'''

for (category, filename), assignee, issue_url in issue_list:

try:

summary[category][filename]['issue'] = issue_url

summary[category][filename]['assignee'] = assignee

except KeyError:

pass

'''

Format the lines that will be written into the markdown file,

also sort the directory name and file name.

'''

writeliner = []

summary_sorted = dict(sorted(summary.items()))

total_entries, total_translated = 0, 0

for dirname, filedict in summary_sorted.items():

dir_total_entries, dir_total_translated = 0, 0

lines = []

filedict_sorted = dict(sorted(filedict.items()))

for filename, filedata in filedict_sorted.items():

file_path = f"{dirname}/{filename}" if dirname else filename

po_link = f"https://github.com/python/python-docs-zh-tw/tree/3.14/{file_path}"

issue_link = filedata['issue']

issue_number = f"#{issue_link.split('/')[-1]}"

create_issue_link = f"https://github.com/python/python-docs-zh-tw/issues/new?title=Translate%20`{file_path}`"

issue_display = format_line_po_issue_display(issue_link, issue_number, filedata['po_info']['progress'], create_issue_link)

line_po = format_line_po(

filename,

po_link,

filedata['po_info']['progress'],

filedata['po_info']['num_entries'],

issue_display,

filedata['assignee'],

)

lines.append(line_po)

dir_total_entries += filedata['po_info']['num_entries']

dir_total_translated += filedata['po_info']['num_translated']

dir_progress = round(dir_total_translated / dir_total_entries * 100, 2)

writeliner.append(f"## {dirname} ({dir_progress}%)\r\n")

writeliner.extend(format_line_table_header())

writeliner.extend(lines)

total_entries += dir_total_entries

total_translated += dir_total_translated

overall_progress = round(total_translated / total_entries * 100, 2)

title = f"## Overall Progress: {overall_progress}% ({total_translated:,} / {total_entries:,})\r\n"

writeliner = [title] + writeliner

with open(f"summarize_progress/result.md", "w") as file:

file.writelines(writeliner)

python-docs-zh-tw/.scripts/summarize_progress/main.py at 3.14 · python/python-docs-zh-tw · GitHub

Repository navigation

Expand file tree

Breadcrumbs

main.py

Latest commit

History

Breadcrumbs

main.py

File metadata and controls