44import datetime
55import requests
66
7+ from pathlib import Path
8+
9+
10+ def entry_check (pofile : polib .POFile ) -> str :
11+ '''
12+ Check the po file with how many entries are translated or not.
13+ '''
714
8- def entry_check (pofile ) -> str :
915 lines_tranlated = len (pofile .translated_entries ())
1016 lines_untranlated = len (pofile .untranslated_entries ())
1117
@@ -17,12 +23,16 @@ def entry_check(pofile) -> str:
1723 lines_all = lines_tranlated + lines_untranlated
1824 progress = lines_tranlated / lines_all
1925 progress_percentage = round (progress * 100 , 2 )
20- result = f"Ongoing, { str ( progress_percentage ) }
26+ result = f"Ongoing, { progress_percentage }
2127
2228 return result
2329
2430
2531def get_open_issues_count () -> int :
32+ '''
33+ Fetch GitHub API to get the number of OPEN ISSUES.
34+ '''
35+
2636 url = f"https://api.github.com/search/issues?q=repo:python/python-docs-zh-tw+type:issue+state:open"
2737 headers = {
2838 "Accept" : "application/vnd.github+json" ,
@@ -35,6 +45,16 @@ def get_open_issues_count() -> int:
3545
3646
3747def get_github_issues () -> list :
48+ '''
49+ Fetch GitHub API to collect the infomation of OPEN ISSUES,
50+ including issue title and assignee.
51+
52+ Steps:
53+ 1. Fetch GitHub API and get open issue list
54+ 2. Filter the issue if it have no assignee
55+ 3. Filter the issue if it have no "Translate" in the title
56+ 4. Filter the issue if it have no correct filepath in the title
57+ '''
3858 NUMBER_OF_ISSUES = get_open_issues_count ()
3959
4060 url = f"https://api.github.com/search/issues?q=repo:python/python-docs-zh-tw+type:issue+state:open&per_page={ NUMBER_OF_ISSUES }
@@ -47,92 +67,72 @@ def get_github_issues() -> list:
4767
4868 result_list = []
4969 for issue in result ["items" ]:
50- title_segments = issue ["title" ].split ()
51-
52- if len (title_segments ) < 2 :
53- continue
54- if title_segments [0 ] != "翻譯" and title_segments [0 ].lower () != "translate" :
55- continue
5670 if issue ["assignee" ] is None :
5771 continue
5872
59- filename = title_segments [1 ].strip ("`" )
73+ title = issue ["title" ]
74+ if "翻譯" not in title and "translate" not in title .lower ():
75+ continue
6076
61- if re .fullmatch ("[a-zA-z-]+/[a-zA-Z0-9._-]+.po" , filename ):
62- filename_segments = filename .split ("/" )
63- # print(filename_segments)
64- elif re .fullmatch ("[a-zA-z-]+/[a-zA-Z0-9._-]+" , filename ):
65- filename_segments = filename .split ("/" )
66- filename_segments [1 ] += ".po"
67- else :
77+ match = re .search ("(?P<dirname>[^\s`][a-zA-z-]+)/(?P<filename>[a-zA-Z0-9._-]+(.po)?)" , title )
78+ if not match :
6879 continue
80+
81+ dirname , filename = match .group ('dirname' , 'filename' )
82+ if not filename .endswith ('.po' ):
83+ filename += '.po'
6984
70- result_list .append ([ filename_segments , issue ["assignee" ]["login" ]] )
85+ result_list .append ((( dirname , filename ), issue ["assignee" ]["login" ]) )
7186
7287 return result_list
7388
74-
75- def format_line_file (filename , result ) -> str :
89+ def format_line_file (filename : str , result : str ) -> str :
7690 return f" - { filename .ljust (37 , '-' )} { result } \r \n "
7791
7892
79- def format_line_directory (dirname ) -> str :
80- tmp = f"- { dirname } \r "
81- return tmp
93+ def format_line_directory (dirname : str ) -> str :
94+ return f"- { dirname } \r \n "
8295
8396
8497if __name__ == "__main__" :
8598 issue_list = get_github_issues ()
8699
87- directories = [
88- "c-api" ,
89- "distributing" ,
90- "extending" ,
91- "faq" ,
92- "howto" ,
93- "includes" ,
94- "installing" ,
95- "library" ,
96- "reference" ,
97- "tutorial" ,
98- "using" ,
99- "whatsnew" ,
100- ]
101-
100+ '''
101+ Search all the po file in the directory,
102+ and record the translation progress of each files.
103+ '''
104+ BASE_DIR = Path ("../" )
102105 summary = {}
103-
104- file_list = glob .glob ("./../**/*.po" , recursive = True )
105- file_list .sort ()
106-
107- for filepath in file_list :
108- if len (filepath .split ("/" )) == 4 : # in-dir files
109- _ , _ , dirname , filename = filepath .split ("/" )
110- else : # root dir files
111- _ , _ , filename = filepath .split ("/" )
112- dirname = "/"
113-
114- if dirname not in summary :
115- summary [dirname ] = {}
116-
106+ for filepath in glob .glob (str (BASE_DIR / "**/*.po" ), recursive = True ):
107+ path = Path (filepath )
108+ filename = path .name
109+ dirname = path .parent .name if path .parent .name != BASE_DIR .name else '/'
117110 po = polib .pofile (filepath )
118- result = entry_check (po )
119- summary [dirname ][filename ] = result
111+ summary .setdefault (dirname , {})[filename ] = entry_check (po )
120112
113+ '''
114+ Unpack the open issue list, and add assignee after the progress
115+ '''
121116 for (category , filename ), assignee in issue_list :
122117 try :
123118 summary [category ][filename ] += f", 💻 { assignee }
124119 except KeyError :
125120 pass
126121
122+ '''
123+ Format the lines that will write into the markdown file,
124+ also sort the directory name and file name.
125+ '''
127126 writeliner = []
128- for dirname , filedict in summary .items ():
127+ summary_sorted = dict (sorted (summary .items ()))
128+ for dirname , filedict in summary_sorted .items ():
129129 writeliner .append (format_line_directory (dirname))
130- for filename , result in filedict .items ():
130+ filedict_sorted = dict (sorted (filedict .items ()))
131+ for filename , result in filedict_sorted .items ():
131132 writeliner .append (format_line_file (filename , result ))
132133
133- timestamp = datetime .datetime .now ().strftime ("%Y%m%d_%H%M%S" )
134134 with open (
135- f"summarize_progress/dist/summarize_progress_ { timestamp } ,
135+ f"summarize_progress/dist/summarize_progress .md" ,
136136 "w" ,
137137 ) as file :
138138 file .writelines (writeliner )
0 commit comments