Merge pull request #87 from paulsengroup/feature/improve-error-msg

Refuse to add pixels to files that have already been finalized

src/hic_file_writer.cpp

@@ -72,6 +72,11 @@ const std::vector<std::uint32_t> &HiCFileWriter::resolutions() const noexcept {
 const hictk::Reference &HiCFileWriter::chromosomes() const { return _w.chromosomes(); }
 
 void HiCFileWriter::add_pixels(const nb::object &df) {
+  if (_finalized) {
+    throw std::runtime_error(
+        "caught attempt to add_pixels to a .hic file that has already been finalized!");
+  }
+
   const auto coo_format = nb::cast<bool>(df.attr("columns").attr("__contains__")("bin1_id"));
   const auto pixels =
       coo_format ? coo_df_to_thin_pixels<float>(df, false)

test/test_file_creation_cool.py

@@ -37,6 +37,9 @@ def test_file_creation_thin_pixel(self, file, resolution, tmpdir):
             w.add_pixels(df[start:end])
 
         w.finalize()
+        with pytest.raises(Exception):
+            w.add_pixels(df)
+
         del w
         gc.collect()
 
@@ -58,6 +61,9 @@ def test_file_creation(self, file, resolution, tmpdir):
             w.add_pixels(df[start:end])
 
         w.finalize()
+        with pytest.raises(Exception):
+            w.add_pixels(df)
+
         del w
         gc.collect()
 
@@ -80,6 +86,9 @@ def test_file_creation_float_counts(self, file, resolution, tmpdir):
             w.add_pixels(df[start:end])
 
         w.finalize()
+        with pytest.raises(Exception):
+            w.add_pixels(df)
+
         del w
         gc.collect()
 

test/test_file_creation_hic.py

@@ -37,6 +37,9 @@ def test_file_creation_thin_pixel(self, file, resolution, tmpdir):
             w.add_pixels(df[start:end])
 
         w.finalize()
+        with pytest.raises(Exception):
+            w.add_pixels(df)
+
         del w
         gc.collect()
 
@@ -58,6 +61,9 @@ def test_file_creation(self, file, resolution, tmpdir):
             w.add_pixels(df[start:end])
 
         w.finalize()
+        with pytest.raises(Exception):
+            w.add_pixels(df)
+
         del w
         gc.collect()