Add in more progress calls.

Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>

Author: clalancette

pycdlib/pycdlib.py

@@ -2563,7 +2563,7 @@ def _outfp_write_with_check(self, outfp, data, enable_overwrite_check=True):
                 bisect.insort_left(self._write_check_list, self._WriteRange(start, end - 1))
 
     def _output_file_data(self, outfp, blocksize, ino):
-        # type: (BinaryIO, int, inode.Inode) -> int
+        # type: (BinaryIO, int, inode.Inode) -> Generator
         """
         Internal method to write a directory record entry out.
 
@@ -2575,25 +2575,25 @@ def _output_file_data(self, outfp, blocksize, ino):
          The total number of bytes written out.
         """
         outfp.seek(ino.extent_location() * self.logical_block_size)
-        tmp_start = outfp.tell()
+        start_offset = outfp.tell()
         with inode.InodeOpenData(ino, self.logical_block_size) as (data_fp, data_len):
-            utils.copy_data(data_len, blocksize, data_fp, outfp)
-            utils.zero_pad(outfp, data_len, self.logical_block_size)
+            for len_copied in utils.copy_data_yield(data_len, blocksize, data_fp, outfp):
+                yield len_copied
+            yield utils.zero_pad(outfp, data_len, self.logical_block_size)
 
         if self._track_writes:
             end = outfp.tell()
             bisect.insort_left(self._write_check_list,
-                               self._WriteRange(tmp_start, end - 1))
+                               self._WriteRange(start_offset, end - 1))
 
         # If this file is being used as a bootfile, and a boot info table is
         # present, patch the boot info table into offset 8 here.
         if ino.boot_info_table is not None:
             old = outfp.tell()
-            outfp.seek(tmp_start + 8)
-            self._outfp_write_with_check(outfp, ino.boot_info_table.record(),
-                                         enable_overwrite_check=False)
+            outfp.seek(start_offset + 8)
+            rec = ino.boot_info_table.record()
+            self._outfp_write_with_check(outfp, rec, enable_overwrite_check=False)
             outfp.seek(old)
-        return outfp.tell() - tmp_start
 
     class _Progress(object):
         """
@@ -2939,7 +2939,8 @@ def func(done, total, progress_data).
         # file out of the original, so do that here.
         for ino in self.inodes:
             if ino.get_data_length() > 0:
-                progress.call(self._output_file_data(outfp, blocksize, ino))
+                for len_copied in self._output_file_data(outfp, blocksize, ino):
+                    progress.call(len_copied)
 
         # Pad out to the total size of the disk, in case that the last thing
         # written is shorter than a full logical block size.  Not all file-like
@@ -4494,8 +4495,7 @@ def modify_file_in_place(self, fp, length, iso_path, rr_name=None,  # pylint: di
         # Write out the actual file contents.
         self._seek_to_extent(child.extent_location())
         with inode.InodeOpenData(child.inode, self.logical_block_size) as (data_fp, data_len):
-            utils.copy_data(data_len, self.logical_block_size, data_fp,
-                            self._cdfp)
+            utils.copy_data(data_len, self.logical_block_size, data_fp, self._cdfp)
             utils.zero_pad(self._cdfp, data_len, self.logical_block_size)
 
         # Finally write out the directory record entry.

pycdlib/utils.py

@@ -45,7 +45,7 @@
 
 # For mypy annotations
 if False:  # pylint: disable=using-constant-test
-    from typing import BinaryIO, List, Optional, Tuple  # NOQA pylint: disable=unused-import
+    from typing import BinaryIO, Generator, List, Optional, Tuple  # NOQA pylint: disable=unused-import
 
 
 def swab_32bit(x):
@@ -98,8 +98,8 @@ def ceiling_div(numer, denom):
     return -(-numer // denom)
 
 
-def copy_data(data_length, blocksize, infp, outfp):
-    # type: (int, int, BinaryIO, BinaryIO) -> None
+def copy_data_yield(data_length, blocksize, infp, outfp):
+    # type: (int, int, BinaryIO, BinaryIO) -> Generator
     """
     A utility function to copy data from the input file object to the output
     file object.
@@ -127,6 +127,25 @@ def copy_data(data_length, blocksize, infp, outfp):
             data_len = left
         outfp.write(data)
         left -= data_len
+        yield data_len
+
+
+def copy_data(data_length, blocksize, infp, outfp):
+    # type: (int, int, BinaryIO, BinaryIO) -> None
+    """
+    A utility function to copy data from the input file object to the output
+    file object.
+
+    Parameters:
+     data_length - The amount of data to copy.
+     blocksize - How much data to copy per iteration.
+     infp - The file object to copy data from.
+     outfp - The file object to copy data to.
+    Returns:
+     Nothing.
+    """
+    for len_unused in copy_data_yield(data_length, blocksize, infp, outfp):
+        pass
 
 
 def encode_space_pad(instr, length, encoding):
@@ -230,7 +249,7 @@ def gmtoffset_from_tm(tm, localtime):
 
 
 def zero_pad(fp, data_size, pad_size):
-    # type: (BinaryIO, int, int) -> None
+    # type: (BinaryIO, int, int) -> int
     """
     A function to write padding out from data_size up to pad_size
     efficiently.
@@ -240,15 +259,16 @@ def zero_pad(fp, data_size, pad_size):
      data_size - The current size of the data.
      pad_size - The boundary size of data to pad out to.
     Returns:
-     Nothing.
+     The number of bytes that were padded.
     """
     padbytes = pad_size - (data_size % pad_size)
     if padbytes == pad_size:
         # Nothing to pad, get out.
-        return
+        return 0
 
     fp.seek(padbytes - 1, os.SEEK_CUR)
     fp.write(b'\x00')
+    return padbytes - 1
 
 
 def starts_with_slash(path):

tests/integration/test_parse.py

@@ -1060,7 +1060,7 @@ def _progress(done, total):
     iso.open(str(outfile))
     iso.write(str(tmpdir.join('writetest.iso')), progress_cb=_progress)
 
-    assert(test_parse_write_with_progress.num_progress_calls == 14)
+    assert(test_parse_write_with_progress.num_progress_calls == 16)
     assert(test_parse_write_with_progress.done == 73728)
 
     iso.close()
@@ -1087,7 +1087,7 @@ def _progress(done, total, opaque):
     collect = {'num_calls': 0, 'done': 0}
     iso.write(str(tmpdir.join('writetest.iso')), progress_cb=_progress, progress_opaque=collect)
 
-    assert(collect['num_calls'] == 14)
+    assert(collect['num_calls'] == 16)
     assert(collect['done'] == 73728)
 
     iso.close()

tools/pycdlib-genisoimage

@@ -913,9 +913,9 @@ def main():
         PyCdlib object, and prints out the current progress of the mastering.
 
         Parameters (as prescribed by PyCdlib):
-         done - The amount of data written so far
-         total - The total amount of data to write
-         progress_data - An object of type ProgressData to track progress
+         done - The amount of data written so far in bytes.
+         total - The total amount of data to write in bytes.
+         progress_data - An object of type ProgressData to track progress.
         Returns:
          Nothing.
         """