@@ -20,7 +20,7 @@ def __init__(self, coverage):
2020 self .config = self .coverage .config
2121
2222 def report (self , morfs , outfile = None ):
23- """Renders the full lcov report
23+ """Renders the full lcov report.
2424
2525 'morfs' is a list of modules or filenames
2626
@@ -34,41 +34,42 @@ def report(self, morfs, outfile=None):
3434 self .get_lcov (fr , analysis , outfile )
3535
3636 def get_lcov (self , fr , analysis , outfile = None ):
37- """Produces the lcov data for a single file
37+ """Produces the lcov data for a single file.
3838
39- get_lcov currently supports both line and branch coverage,
39+ This currently supports both line and branch coverage,
4040 however function coverage is not supported.
41-
4241 """
43-
4442 outfile .write ("TN:\n " )
4543 outfile .write (f"SF:{ fr .relative_filename ()} \n " )
4644 source_lines = fr .source ().splitlines ()
45+
4746 for covered in sorted (analysis .executed ):
48- # Note: Coveragepy currently only supports checking *if* a line has
49- # been executed, not how many times, so we set this to 1 for nice
50- # output even if it's technically incorrect
51-
52- # The lines below calculate a 64 bit encoded md5 hash of the line
53- # corresponding to the DA lines in the lcov file,
54- # for either case of the line being covered or missed in Coveragepy
55- # The final two characters of the encoding ("==") are removed from
56- # the hash to allow genhtml to run on the resulting lcov file
47+ # Note: Coverage.py currently only supports checking *if* a line
48+ # has been executed, not how many times, so we set this to 1 for
49+ # nice output even if it's technically incorrect.
50+
51+ # The lines below calculate a 64- bit encoded md5 hash of the line
52+ # corresponding to the DA lines in the lcov file, for either case
53+ # of the line being covered or missed in coverage.py. The final two
54+ # characters of the encoding ("==") are removed from the hash to
55+ # allow genhtml to run on the resulting lcov file.
5756 if source_lines :
58- line = source_lines [covered - 1 ].encode ("utf-8" )
57+ line = source_lines [covered - 1 ].encode ("utf-8" )
5958 else :
6059 line = b""
61- hashed = str ( base64 .b64encode (md5 (line ).digest ())[: - 2 ], encoding = "utf-8 "
60+ hashed = base64 .b64encode (md5 (line ).digest ()). decode (). rstrip ( "= "
6261 outfile .write (f"DA:{ covered } { hashed } \n " )
62+
6363 for missed in sorted (analysis .missing ):
6464 assert source_lines
6565 line = source_lines [missed - 1 ].encode ("utf-8" )
66- hashed = str ( base64 .b64encode (md5 (line ).digest ())[: - 2 ], encoding = "utf-8 "
66+ hashed = base64 .b64encode (md5 (line ).digest ()). decode (). rstrip ( "= "
6767 outfile .write (f"DA:{ missed } { hashed } \n " )
68+
6869 outfile .write (f"LF:{ len (analysis .statements )} \n " )
6970 outfile .write (f"LH:{ len (analysis .executed )} \n " )
7071
71- # More information dense branch coverage data
72+ # More information dense branch coverage data.
7273 missing_arcs = analysis .missing_branch_arcs ()
7374 executed_arcs = analysis .executed_branch_arcs ()
7475 for block_number , block_line_number in enumerate (
@@ -78,22 +79,23 @@ def get_lcov(self, fr, analysis, outfile=None):
7879 sorted (missing_arcs [block_line_number ])
7980 ):
8081 # The exit branches have a negative line number,
81- # this will not produce valid lcov, and so setting
82+ # this will not produce valid lcov. Setting
8283 # the line number of the exit branch to 0 will allow
83- # for valid lcov, while preserving the data
84+ # for valid lcov, while preserving the data.
8485 line_number = max (line_number , 0 )
8586 outfile .write (f"BRDA:{ line_number } { block_number } { branch_number } \n " )
87+
8688 # The start value below allows for the block number to be
8789 # preserved between these two for loops (stopping the loop from
88- # resetting the value of the block number to 0)
90+ # resetting the value of the block number to 0).
8991 for branch_number , line_number in enumerate (
9092 sorted (executed_arcs [block_line_number ]),
9193 start = len (missing_arcs [block_line_number ]),
9294 ):
9395 line_number = max (line_number , 0 )
9496 outfile .write (f"BRDA:{ line_number } { block_number } { branch_number } \n " )
9597
96- # Summary of the branch coverage
98+ # Summary of the branch coverage.
9799 if analysis .has_arcs ():
98100 branch_stats = analysis .branch_stats ()
99101 brf = sum (t for t , k in branch_stats .values ())
0 commit comments