@@ -24,8 +24,10 @@ def __init__(self, language: str):
2424 self ._documentation_count = 0
2525 self ._empty_count = 0
2626 self ._file_count = 0
27+ self ._file_percentage = 0.0
2728 self ._string_count = 0
2829 self ._is_pseudo_language = _PSEUDO_LANGUAGE_REGEX .match (self .language ) is not None
30+ self ._has_up_to_date_percentages = False
2931
3032 @property
3133 def language (self ) -> str :
@@ -37,31 +39,70 @@ def code_count(self) -> int:
3739 """sum lines of code for this language"""
3840 return self ._code_count
3941
42+ @property
43+ def code_percentage (self ) -> float :
44+ """percentage of lines containing code for this language across entire project"""
45+ return _percentage_or_0 (self .code_count , self .line_count )
46+
47+ def _assert_has_up_to_date_percentages (self ):
48+ assert self ._has_up_to_date_percentages , "update_percentages() must be called first"
49+
4050 @property
4151 def documentation_count (self ) -> int :
4252 """sum lines of documentation for this language"""
4353 return self ._documentation_count
4454
55+ @property
56+ def documentation_percentage (self ) -> float :
57+ """percentage of lines containing documentation for this language across entire project"""
58+ return _percentage_or_0 (self .documentation_count , self .line_count )
59+
4560 @property
4661 def empty_count (self ) -> int :
4762 """sum empty lines for this language"""
4863 return self ._empty_count
4964
65+ @property
66+ def empty_percentage (self ) -> float :
67+ """percentage of empty lines for this language across entire project"""
68+ return _percentage_or_0 (self .empty_count , self .line_count )
69+
5070 @property
5171 def file_count (self ) -> int :
5272 """number of source code files for this language"""
5373 return self ._file_count
5474
75+ @property
76+ def file_percentage (self ) -> float :
77+ """percentage of files in project"""
78+ self ._assert_has_up_to_date_percentages ()
79+ return self ._file_percentage
80+
81+ @property
82+ def line_count (self ) -> int :
83+ """sum count of all lines of any kind for this language"""
84+ return self .code_count + self .documentation_count + self .empty_count + self .string_count
85+
5586 @property
5687 def string_count (self ) -> int :
57- """sum number of lines containing only strings for this language"""
88+ """sum number of lines containing strings for this language"""
5889 return self ._string_count
5990
91+ @property
92+ def string_percentage (self ) -> float :
93+ """percentage of lines containing strings for this language across entire project"""
94+ return _percentage_or_0 (self .string_count , self .line_count )
95+
6096 @property
6197 def source_count (self ) -> int :
6298 """sum number of source lines of code"""
6399 return self .code_count + self .string_count
64100
101+ @property
102+ def source_percentage (self ) -> float :
103+ """percentage of source lines for code for this language across entire project"""
104+ return _percentage_or_0 (self .source_count , self .line_count )
105+
65106 @property
66107 def is_pseudo_language (self ) -> bool :
67108 """``True`` if the language is not a real programming language"""
@@ -84,13 +125,18 @@ def add(self, source_analysis: SourceAnalysis) -> None:
84125 assert source_analysis is not None
85126 assert source_analysis .language == self .language
86127
128+ self ._has_up_to_date_percentages = False
87129 self ._file_count += 1
88130 if source_analysis .is_countable :
89131 self ._code_count += source_analysis .code_count
90132 self ._documentation_count += source_analysis .documentation_count
91133 self ._empty_count += source_analysis .empty_count
92134 self ._string_count += source_analysis .string_count
93135
136+ def update_file_percentage (self , project_summary : "ProjectSummary" ):
137+ self ._file_percentage = _percentage_or_0 (self .file_count , project_summary .total_file_count )
138+ self ._has_up_to_date_percentages = True
139+
94140 def __repr__ (self ):
95141 result = "{0}(language={1!r}, file_count={2}" .format (self .__class__ .__name__ , self .language , self .file_count )
96142 if not self .is_pseudo_language :
@@ -101,6 +147,12 @@ def __repr__(self):
101147 return result
102148
103149
150+ def _percentage_or_0 (partial_count : int , total_count : int ) -> float :
151+ assert partial_count >= 0
152+ assert total_count >= 0
153+ return 100 * partial_count / total_count if total_count != 0 else 0.0
154+
155+
104156class ProjectSummary :
105157 """
106158 Summary of source code counts for several languages and files.
@@ -126,22 +178,42 @@ def language_to_language_summary_map(self) -> Dict[str, LanguageSummary]:
126178 def total_code_count (self ) -> int :
127179 return self ._total_code_count
128180
181+ @property
182+ def total_code_percentage (self ) -> float :
183+ return _percentage_or_0 (self .total_code_count , self .total_line_count )
184+
129185 @property
130186 def total_documentation_count (self ) -> int :
131187 return self ._total_documentation_count
132188
189+ @property
190+ def total_documentation_percentage (self ) -> float :
191+ return _percentage_or_0 (self .total_documentation_count , self .total_line_count )
192+
133193 @property
134194 def total_empty_count (self ) -> int :
135195 return self ._total_empty_count
136196
197+ @property
198+ def total_empty_percentage (self ) -> float :
199+ return _percentage_or_0 (self .total_empty_count , self .total_line_count )
200+
137201 @property
138202 def total_string_count (self ) -> int :
139203 return self ._total_string_count
140204
205+ @property
206+ def total_string_percentage (self ) -> float :
207+ return _percentage_or_0 (self .total_string_count , self .total_line_count )
208+
141209 @property
142210 def total_source_count (self ) -> int :
143211 return self .total_code_count + self .total_string_count
144212
213+ @property
214+ def total_source_percentage (self ) -> float :
215+ return _percentage_or_0 (self .total_source_count , self .total_line_count )
216+
145217 @property
146218 def total_file_count (self ) -> int :
147219 return self ._total_file_count
@@ -173,10 +245,15 @@ def add(self, source_analysis: SourceAnalysis) -> None:
173245 )
174246 self ._total_string_count += source_analysis .string_count
175247
248+ def update_file_percentages (self ) -> None :
249+ """Update percentages for all languages part of the project."""
250+ for language_summary in self ._language_to_language_summary_map .values ():
251+ language_summary .update_file_percentage (self )
252+
176253 def __repr__ (self ):
177- return "{0}(total_file_count={1}, total_line_count={2}, " "languages={3}" . format (
178- self .__class__ .__name__ ,
179- self .total_file_count ,
180- self .total_line_count ,
181- sorted (self .language_to_language_summary_map .keys ()),
254+ return (
255+ f" { self .__class__ .__name__ } ("
256+ f"total_file_count= { self .total_file_count } , "
257+ f"total_line_count= { self .total_line_count } , "
258+ f"languages= { sorted (self .language_to_language_summary_map .keys ())} )"
182259 )
0 commit comments